Fix function comments.

[mirror_edk2.git] / IntelFrameworkPkg / Library / HiiLibFramework / HiiLibFramework.c

diff --git a/IntelFrameworkPkg/Library/HiiLibFramework/HiiLibFramework.c b/IntelFrameworkPkg/Library/HiiLibFramework/HiiLibFramework.c
index cf10739897158214aca6be31d952b873ba4cbc62..37d830375a2598bd41a992d6835898950fdf9ca7 100644 (file)
--- a/IntelFrameworkPkg/Library/HiiLibFramework/HiiLibFramework.c
+++ b/IntelFrameworkPkg/Library/HiiLibFramework/HiiLibFramework.c
@@ -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
@@ -27,7 +25,18 @@
 \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