Add more comments for IntelFramework's header files.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Library / FrameworkHiiLib.h

diff --git a/IntelFrameworkPkg/Include/Library/FrameworkHiiLib.h b/IntelFrameworkPkg/Include/Library/FrameworkHiiLib.h
index d2d74336a0e83e282cabf8a0d1f449315b866cf5..771d70cad0092fbf63d91bd6c07494859d49d6d5 100644 (file)
--- a/IntelFrameworkPkg/Include/Library/FrameworkHiiLib.h
+++ b/IntelFrameworkPkg/Include/Library/FrameworkHiiLib.h
@@ -1,6 +1,11 @@
 /** @file\r
-  Public include file for the HII Library\r
-\r
+  Library class name: FrameworkHiiLib.\r
+  \r
+  FrameworkHiiLib is designed for produce interfaces to access\r
+  framework HII things. It firstly also produce all interfaces define\r
+  in HiiLib library class in MdePkg/Include/HiiLib.h. It also produce\r
+  framework's old interface PreparePackages to keep compatiblity.\r
+     \r
   Copyright (c) 2006, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r
@@ -10,14 +15,18 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
-  Module Name:  HiiLib.h\r
-\r
 **/\r
 \r
-#ifndef __HII_LIB_H__\r
-#define __HII_LIB_H__\r
+#ifndef __FRAMEWORK_HII_LIB_H__\r
+#define __FRAMEWORK_HII_LIB_H__\r
+\r
+#include <FrameworkDxe.h>\r
 \r
 #include <Protocol/FrameworkHii.h>\r
+//\r
+// FrameworkHiiLib will produce HiiLib library class too.\r
+//\r
+#include <Library/HiiLib.h>\r
 \r
 /**\r
   This function allocates pool for an EFI_HII_PACKAGES structure\r
@@ -28,8 +37,7 @@
   @param  NumberOfPackages The number of HII packages to prepare.\r
   @param  Guid Package GUID.\r
 \r
-  @return\r
-  The allocated and initialized packages.\r
+  @return The allocated and initialized packages.\r
 \r
 **/\r
 EFI_HII_PACKAGES *\r
@@ -41,6 +49,4 @@ PreparePackages (
   )\r
 ;\r
 \r
-\r
-\r
 #endif\r