Clean up ExtendedHiiLib, HiiLib, IfrSupportLib, ExtendedIfrSupportLib for Doxygen...

[mirror_edk2.git] / MdeModulePkg / Library / ExtendedIfrSupportLib / Common.c

diff --git a/MdeModulePkg/Library/ExtendedIfrSupportLib/Common.c b/MdeModulePkg/Library/ExtendedIfrSupportLib/Common.c
index 6f8926b42cd1d3462f0e288f1df3dbea75f23667..65acd0c37e1604e9288a69223c455371607466e1 100644 (file)
--- a/MdeModulePkg/Library/ExtendedIfrSupportLib/Common.c
+++ b/MdeModulePkg/Library/ExtendedIfrSupportLib/Common.c
@@ -22,6 +22,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 EFI_HII_DATABASE_PROTOCOL *gIfrLibHiiDatabase;\r
 EFI_HII_STRING_PROTOCOL   *gIfrLibHiiString;\r
 \r
+/**\r
+  ExtendedIfrSupportLib's constructor. It locates the required protocol:\r
+  gEfiHiiDatabaseProtocolGuid and gEfiHiiStringProtocolGuid.\r
+\r
+  @param ImageHandle     The firmware allocated handle for the EFI image.\r
+  \r
+  @param SystemTable     A pointer to the EFI System Table.\r
+\r
+  @retval EFI_SUCCESS    This function always completes successfully.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 ExtendedIfrSupportLibConstructor (\r
@@ -44,6 +55,19 @@ ExtendedIfrSupportLibConstructor (
 \r
 STATIC EFI_GUID mIfrVendorGuid = EFI_IFR_TIANO_GUID;\r
 \r
+/**\r
+  Extract formset class for given HII handle.\r
+\r
+\r
+  @param Handle          The HII handle.\r
+  @param Class           Class of the formset.\r
+  @param FormSetTitle    Formset title string.\r
+  @param FormSetHelp     Formset help string.\r
+\r
+  @retval  EFI_SUCCESS      Successfully extract Class for specified Hii handle.\r
+  @return  Other values if failed to export packages for the given HII handle.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 IfrLibExtractClassFromHiiHandle (\r
@@ -52,21 +76,6 @@ IfrLibExtractClassFromHiiHandle (
   OUT     EFI_STRING_ID       *FormSetTitle,\r
   OUT     EFI_STRING_ID       *FormSetHelp\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-  Extract formset class for given HII handle.\r
-\r
-Arguments:\r
-  HiiHandle       - Hii handle\r
-  Class           - Class of the formset\r
-  FormSetTitle    - Formset title string\r
-  FormSetHelp     - Formset help string\r
-\r
-Returns:\r
-  EFI_SUCCESS     - Successfully extract Class for specified Hii handle.\r
-\r
---*/\r
 {\r
   EFI_STATUS                   Status;\r
   UINTN                        BufferSize;\r