From 4a71b21a6375549aa514e4680449a29f9c64802f Mon Sep 17 00:00:00 2001
From: klu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>
Date: Tue, 8 Apr 2008 06:29:25 +0000
Subject: Add more comments for IntelFramework's header files.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5003 6f19259b-4bc3-4df7-8a09-765794883524
---
 IntelFrameworkPkg/Include/Library/FrameworkHiiLib.h        | 14 ++++++++------
 IntelFrameworkPkg/Include/Library/FrameworkIfrSupportLib.h | 12 ++++--------
 IntelFrameworkPkg/Include/Library/SmmLib.h                 |  2 ++
 3 files changed, 14 insertions(+), 14 deletions(-)

(limited to 'IntelFrameworkPkg/Include/Library')

diff --git a/IntelFrameworkPkg/Include/Library/FrameworkHiiLib.h b/IntelFrameworkPkg/Include/Library/FrameworkHiiLib.h
index ceb91cf8b9..771d70cad0 100644
--- a/IntelFrameworkPkg/Include/Library/FrameworkHiiLib.h
+++ b/IntelFrameworkPkg/Include/Library/FrameworkHiiLib.h
@@ -1,6 +1,11 @@
 /** @file
-  Public include file for the HII Library
-
+  Library class name: FrameworkHiiLib.
+  
+  FrameworkHiiLib is designed for produce interfaces to access
+  framework HII things. It firstly also produce all interfaces define
+  in HiiLib library class in MdePkg/Include/HiiLib.h. It also produce
+  framework's old interface PreparePackages to keep compatiblity.
+     
   Copyright (c) 2006, Intel Corporation                                                         
   All rights reserved. This program and the accompanying materials                          
   are licensed and made available under the terms and conditions of the BSD License         
@@ -10,8 +15,6 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             
 
-  Module Name:  HiiLib.h
-
 **/
 
 #ifndef __FRAMEWORK_HII_LIB_H__
@@ -34,8 +37,7 @@
   @param  NumberOfPackages The number of HII packages to prepare.
   @param  Guid Package GUID.
 
-  @return
-  The allocated and initialized packages.
+  @return The allocated and initialized packages.
 
 **/
 EFI_HII_PACKAGES *
diff --git a/IntelFrameworkPkg/Include/Library/FrameworkIfrSupportLib.h b/IntelFrameworkPkg/Include/Library/FrameworkIfrSupportLib.h
index d8c507d5b2..a062f87177 100644
--- a/IntelFrameworkPkg/Include/Library/FrameworkIfrSupportLib.h
+++ b/IntelFrameworkPkg/Include/Library/FrameworkIfrSupportLib.h
@@ -1,5 +1,9 @@
 /** @file
+  Library class name: FrameworkIfrSupportLib
 
+  FrameworkIfrSupportLib is designed for produce IFR operation interface .
+  The IFR format follows framework specification.
+  
 Copyright (c) 2006, Intel Corporation                                                         
 All rights reserved. This program and the accompanying materials                          
 are licensed and made available under the terms and conditions of the BSD License         
@@ -9,14 +13,6 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             
 
-Module Name:
-
-  IfrSupportLib.h
-
-Abstract:
-
-  The file contain all library function for Ifr Operations.
-
 **/
 
 #ifndef _IFRSUPPORTLIBRARY_H
diff --git a/IntelFrameworkPkg/Include/Library/SmmLib.h b/IntelFrameworkPkg/Include/Library/SmmLib.h
index b0d8d891e1..76605fbb6f 100644
--- a/IntelFrameworkPkg/Include/Library/SmmLib.h
+++ b/IntelFrameworkPkg/Include/Library/SmmLib.h
@@ -1,4 +1,6 @@
 /** @file
+  Library class name: SmmLib
+  
   SMM Library Services that abstracts both S/W SMI generation and detection. 
 
   Copyright (c) 2007, Intel Corporation                                                         
-- 
cgit v1.2.3