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

1 files changed, 8 insertions, 6 deletions

diff --git a/IntelFrameworkPkg/Include/Library/FrameworkHiiLib.h b/IntelFrameworkPkg/Include/Library/FrameworkHiiLib.h
index ceb91cf..771d70c 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 *