Fix typo in comment.
[mirror_edk2.git] / IntelFrameworkPkg / Library / HiiLibFramework / HiiLibFramework.c
index ca7febda4b652b68bb1feab2d68e8716a454a0c1..68bc432c63216796ec7eebea267bddd4a55fea7e 100644 (file)
@@ -10,8 +10,6 @@
   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.c\r
-\r
 **/\r
 \r
 \r
 \r
 EFI_HII_PROTOCOL      *gHiiProtocol = NULL;\r
 \r
+/**\r
+  The constructor function for HiiLibFramework library instance\r
+\r
+  The constructor function locates Hii protocol from protocol database.\r
+  It will ASSERT() if that operation fails and it will always return EFI_SUCCESS.\r
+\r
+  @param  ImageHandle   The firmware allocated handle for the EFI image.\r
+  @param  SystemTable   A pointer to the EFI System Table.\r
+\r
+  @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.\r
 \r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 HiiLibFrameworkConstructor (\r
@@ -40,7 +49,7 @@ HiiLibFrameworkConstructor (
   Status = gBS->LocateProtocol (\r
                   &gEfiHiiProtocolGuid,\r
                   NULL,\r
-                  &gHiiProtocol\r
+                  (VOID **) &gHiiProtocol\r
                   );\r
   ASSERT_EFI_ERROR (Status);\r
 \r
@@ -55,7 +64,8 @@ HiiLibFrameworkConstructor (
   and the variable length argument list of package pointers.\r
 \r
   @param  NumberOfPackages The number of HII packages to prepare.\r
-  @param  Guid Package GUID.\r
+  @param  Guid             Package GUID.\r
+  @param  Args             Package contents\r
 \r
   @return The allocated and initialized packages.\r
 \r
@@ -89,30 +99,4 @@ InternalPreparePackages (
 \r
 }\r
 \r
-EFI_STATUS\r
-EFIAPI\r
-PrepareAndCreateNewPackages (\r
-  IN            UINTN      NumberOfPackages,\r
-  IN CONST      EFI_GUID   *GuidId,\r
-  OUT           VOID      **HiiHandle,         //Framework is FRAMEWORK_HII_HANDLE; UEFI is EFI_HII_HANDLE; \r
-                                     // C:\D\Work\Tiano\Tiano_Main_Trunk\TIANO\Platform\IntelEpg\SR870BN4\MemorySubClassDriver\DualChannelDdr\MemorySubClass.c make use of this output value\r
-  ...\r
-  )\r
-{\r
-  EFI_STATUS                Status;\r
-  EFI_HII_PACKAGES          *PackageList;\r
-  VA_LIST                   Args;\r
-  FRAMEWORK_EFI_HII_HANDLE  FrameworkHiiHandle;\r
-\r
-  \r
-  VA_START (Args, HiiHandle);\r
-  PackageList = InternalPreparePackages (NumberOfPackages, GuidId, Args);\r
-  VA_END (Args);\r
-  \r
-  Status      = gHiiProtocol->NewPack (gHiiProtocol, PackageList, &FrameworkHiiHandle);\r
-  *HiiHandle  = (VOID *) (UINTN) FrameworkHiiHandle;\r
-\r
-  return Status;\r
-}\r
-\r
 \r