Clean up BdsDxe for Doxygen comments requirement.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5456 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdeModulePkg/Universal/BdsDxe/BdsEntry.c b/MdeModulePkg/Universal/BdsDxe/BdsEntry.c
index adbce15f2dac53ad46c79986ed90790122f3b7ed..332c6bdabe4c3d0faeb2654fcd0e6a36e5ff3bab 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BdsEntry.c
+++ b/MdeModulePkg/Universal/BdsDxe/BdsEntry.c
@@ -74,12 +74,8 @@ BdsInitialize (
 \r
 /**\r
 \r
-  In the loop of attempt to boot for the boot order\r
-\r
-\r
-  @param VOID           No input parameter.\r
-\r
-  @retval VOID          No returns.\r
+  This function attempts to boot for the boot order specified\r
+  by platform policy.\r
 \r
 **/\r
 VOID\r

diff --git a/MdeModulePkg/Universal/BdsDxe/FrontPage.c b/MdeModulePkg/Universal/BdsDxe/FrontPage.c
index fb9743a41fd9b87912a5dd692126b5ce3c1f0dda..ed9609d2552175bf1acabecddd5c1c9b1c32a966 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/FrontPage.c
+++ b/MdeModulePkg/Universal/BdsDxe/FrontPage.c
@@ -238,7 +238,7 @@ FrontPageCallback (
 **/\r
 EFI_STATUS\r
 InitializeFrontPage (\r
-  BOOLEAN                         InitializeHiiData\r
+  IN BOOLEAN                         InitializeHiiData\r
   )\r
 {\r
   EFI_STATUS                  Status;\r
@@ -595,12 +595,7 @@ ConvertMemorySizeToString (
 }\r
 \r
 /**\r
-  Update the banner information for the Front Page based on DataHub information\r
-\r
-\r
-  @param VOID            No input.\r
-\r
-  @return No output.\r
+  Update the banner information for the Front Page based on DataHub information.\r
 \r
 **/\r
 VOID\r

diff --git a/MdeModulePkg/Universal/BdsDxe/FrontPage.h b/MdeModulePkg/Universal/BdsDxe/FrontPage.h
index 50454335336d2a83d62dd3bee569d1e5779c808a..fb8ba6c3f24cb8f63a79a80a062e84bf9b01c990 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/FrontPage.h
+++ b/MdeModulePkg/Universal/BdsDxe/FrontPage.h
@@ -12,8 +12,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-#ifndef _FRONT_PAGE_H\r
-#define _FRONT_PAGE_H\r
+#ifndef _FRONT_PAGE_H_\r
+#define _FRONT_PAGE_H_\r
 \r
 #include "DeviceMngr/DeviceManager.h"\r
 #include "BootMaint/BootMaint.h"\r
@@ -180,7 +180,7 @@ FrontPageCallback (
 **/\r
 EFI_STATUS\r
 InitializeFrontPage (\r
-  IN BOOLEAN    ReInitializeStrings\r
+  IN BOOLEAN    InitializeHiiData\r
   );\r
 \r
 /**\r

diff --git a/MdeModulePkg/Universal/BdsDxe/Hotkey.c b/MdeModulePkg/Universal/BdsDxe/Hotkey.c
index 087210863c708eb5b55110aa04bf1fa8235e6207..adcc3afbebf33bf10f0a22b87830883d96d4e727 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/Hotkey.c
+++ b/MdeModulePkg/Universal/BdsDxe/Hotkey.c
@@ -112,7 +112,7 @@ RegisterHotkey (
   //\r
 \r
   KeyOrder = BdsLibGetVariableAndSize (\r
-               VarKeyOrder,\r
+               VAR_KEY_ORDER,\r
                &gEfiGlobalVariableGuid,\r
                &KeyOrderSize\r
                );\r
@@ -211,7 +211,7 @@ RegisterHotkey (
   NewKeyOrder[Index] = RegisterOptionNumber;\r
 \r
   Status = gRT->SetVariable (\r
-                  VarKeyOrder,\r
+                  VAR_KEY_ORDER,\r
                   &gEfiGlobalVariableGuid,\r
                   EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
                   KeyOrderSize,\r
@@ -263,7 +263,7 @@ UnregisterHotkey (
   // Adjust key order array\r
   //\r
   KeyOrder = BdsLibGetVariableAndSize (\r
-               VarKeyOrder,\r
+               VAR_KEY_ORDER,\r
                &gEfiGlobalVariableGuid,\r
                &KeyOrderSize\r
                );\r
@@ -291,7 +291,7 @@ UnregisterHotkey (
   }\r
 \r
   Status = gRT->SetVariable (\r
-                  VarKeyOrder,\r
+                  VAR_KEY_ORDER,\r
                   &gEfiGlobalVariableGuid,\r
                   EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
                   KeyOrderSize,\r
@@ -670,7 +670,7 @@ InitializeHotkeyService (
   // Get valid Key Option List from private EFI variable "KeyOrder"\r
   //\r
   KeyOrder = BdsLibGetVariableAndSize (\r
-               VarKeyOrder,\r
+               VAR_KEY_ORDER,\r
                &gEfiGlobalVariableGuid,\r
                &KeyOrderSize\r
                );\r

diff --git a/MdeModulePkg/Universal/BdsDxe/Hotkey.h b/MdeModulePkg/Universal/BdsDxe/Hotkey.h
index 88966d02c5e8475cc727b317e794f52dd1f270a7..3bc21509fc2270d3042c4c1ba7724b232221ea44 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/Hotkey.h
+++ b/MdeModulePkg/Universal/BdsDxe/Hotkey.h
@@ -13,8 +13,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-#ifndef _HOTKEY_H\r
-#define _HOTKEY_H\r
+#ifndef _HOTKEY_H_\r
+#define _HOTKEY_H_\r
 \r
 #include "Bds.h"\r
 #include "String.h"\r
@@ -35,7 +35,7 @@ typedef struct {
 \r
 #define BDS_HOTKEY_OPTION_FROM_LINK(a) CR (a, BDS_HOTKEY_OPTION, Link, BDS_HOTKEY_OPTION_SIGNATURE)\r
 \r
-#define VarKeyOrder       L"KeyOrder"\r
+#define VAR_KEY_ORDER       L"KeyOrder"\r
 \r
 /**\r
 \r
@@ -53,7 +53,7 @@ EFI_STATUS
 RegisterHotkey (\r
   IN EFI_KEY_OPTION     *KeyOption,\r
   OUT UINT16            *KeyOptionNumber\r
-)\r
+  )\r
 ;\r
 \r
 /**\r
@@ -70,7 +70,7 @@ RegisterHotkey (
 EFI_STATUS\r
 UnregisterHotkey (\r
   IN UINT16             KeyOptionNumber\r
-)\r
+  )\r
 ;\r
 \r
 \r

diff --git a/MdeModulePkg/Universal/BdsDxe/HwErrRecSupport.h b/MdeModulePkg/Universal/BdsDxe/HwErrRecSupport.h
index f4d5f9cb127db0a9f1e1f393a0868872e413867d..a33e1149a644fd7e2117c27072330bd0bd0b0e94 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/HwErrRecSupport.h
+++ b/MdeModulePkg/Universal/BdsDxe/HwErrRecSupport.h
@@ -13,8 +13,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-#ifndef _HW_ERR_REC_SUPPORT_H\r
-#define _HW_ERR_REC_SUPPORT_H\r
+#ifndef _HW_ERR_REC_SUPPORT_H_\r
+#define _HW_ERR_REC_SUPPORT_H_\r
 \r
 #include "Bds.h"\r
 \r

diff --git a/MdeModulePkg/Universal/BdsDxe/Language.c b/MdeModulePkg/Universal/BdsDxe/Language.c
index 38784844b27a56b01bf08c4857cb94442ef62501..162d9f8358cc86bb948627572d2a3ace5a73c92d 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/Language.c
+++ b/MdeModulePkg/Universal/BdsDxe/Language.c
@@ -253,11 +253,6 @@ FONT_PACK_BIN mFontBin = {
 /**\r
   Routine to export glyphs to the HII database.  This is in addition to whatever is defined in the Graphics Console driver.\r
 \r
-\r
-  @param VOID\r
-\r
-  @return VOID\r
-\r
 **/\r
 VOID\r
 ExportFonts (\r
@@ -286,13 +281,11 @@ ExportFonts (
 \r
 /**\r
   Determine the current language that will be used\r
-  based on language related EFI Variables\r
+  based on language related EFI Variables.\r
 \r
 \r
   @param LangCodesSettingRequired - If required to set LangCode variable\r
 \r
-  @return VOID\r
-\r
 **/\r
 VOID\r
 InitializeLanguage (\r

diff --git a/MdeModulePkg/Universal/BdsDxe/Language.h b/MdeModulePkg/Universal/BdsDxe/Language.h
index bdebb499121633b23132f93f966496cf3ca6e1a5..2612e862bb33597b8ccbcf40629dfd9da5e3888d 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/Language.h
+++ b/MdeModulePkg/Universal/BdsDxe/Language.h
@@ -12,19 +12,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-#ifndef _LANGUAGE_H\r
-#define _LANGUAGE_H\r
+#ifndef _LANGUAGE_H_\r
+#define _LANGUAGE_H_\r
 \r
 #include "String.h"\r
 \r
 /**\r
   Determine the current language that will be used\r
-  based on language related EFI Variables\r
+  based on language related EFI Variables.\r
 \r
 \r
-  @param LangCodesSettingRequired - If required to set LangCode variable\r
-\r
-  @return VOID\r
+  @param LangCodesSettingRequired If required to set LangCode variable\r
 \r
 **/\r
 VOID\r