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

8 files changed, 24 insertions, 42 deletions

diff --git a/MdeModulePkg/Universal/BdsDxe/BdsEntry.c b/MdeModulePkg/Universal/BdsDxe/BdsEntry.c
index adbce15f2d..332c6bdabe 100644
--- a/MdeModulePkg/Universal/BdsDxe/BdsEntry.c
+++ b/MdeModulePkg/Universal/BdsDxe/BdsEntry.c
@@ -74,12 +74,8 @@ BdsInitialize (
 

 /**

 

-  In the loop of attempt to boot for the boot order

-

-

-  @param VOID           No input parameter.

-

-  @retval VOID          No returns.

+  This function attempts to boot for the boot order specified

+  by platform policy.

 

 **/

 VOID

diff --git a/MdeModulePkg/Universal/BdsDxe/FrontPage.c b/MdeModulePkg/Universal/BdsDxe/FrontPage.c
index fb9743a41f..ed9609d255 100644
--- a/MdeModulePkg/Universal/BdsDxe/FrontPage.c
+++ b/MdeModulePkg/Universal/BdsDxe/FrontPage.c
@@ -238,7 +238,7 @@ FrontPageCallback (
 **/

 EFI_STATUS

 InitializeFrontPage (

-  BOOLEAN                         InitializeHiiData

+  IN BOOLEAN                         InitializeHiiData

   )

 {

   EFI_STATUS                  Status;

@@ -595,12 +595,7 @@ ConvertMemorySizeToString (
 }

 

 /**

-  Update the banner information for the Front Page based on DataHub information

-

-

-  @param VOID            No input.

-

-  @return No output.

+  Update the banner information for the Front Page based on DataHub information.

 

 **/

 VOID

diff --git a/MdeModulePkg/Universal/BdsDxe/FrontPage.h b/MdeModulePkg/Universal/BdsDxe/FrontPage.h
index 5045433533..fb8ba6c3f2 100644
--- 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.
 

 **/

 

-#ifndef _FRONT_PAGE_H

-#define _FRONT_PAGE_H

+#ifndef _FRONT_PAGE_H_

+#define _FRONT_PAGE_H_

 

 #include "DeviceMngr/DeviceManager.h"

 #include "BootMaint/BootMaint.h"

@@ -180,7 +180,7 @@ FrontPageCallback (
 **/

 EFI_STATUS

 InitializeFrontPage (

-  IN BOOLEAN    ReInitializeStrings

+  IN BOOLEAN    InitializeHiiData

   );

 

 /**

diff --git a/MdeModulePkg/Universal/BdsDxe/Hotkey.c b/MdeModulePkg/Universal/BdsDxe/Hotkey.c
index 087210863c..adcc3afbeb 100644
--- a/MdeModulePkg/Universal/BdsDxe/Hotkey.c
+++ b/MdeModulePkg/Universal/BdsDxe/Hotkey.c
@@ -112,7 +112,7 @@ RegisterHotkey (
   //

 

   KeyOrder = BdsLibGetVariableAndSize (

-               VarKeyOrder,

+               VAR_KEY_ORDER,

                &gEfiGlobalVariableGuid,

                &KeyOrderSize

                );

@@ -211,7 +211,7 @@ RegisterHotkey (
   NewKeyOrder[Index] = RegisterOptionNumber;

 

   Status = gRT->SetVariable (

-                  VarKeyOrder,

+                  VAR_KEY_ORDER,

                   &gEfiGlobalVariableGuid,

                   EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,

                   KeyOrderSize,

@@ -263,7 +263,7 @@ UnregisterHotkey (
   // Adjust key order array

   //

   KeyOrder = BdsLibGetVariableAndSize (

-               VarKeyOrder,

+               VAR_KEY_ORDER,

                &gEfiGlobalVariableGuid,

                &KeyOrderSize

                );

@@ -291,7 +291,7 @@ UnregisterHotkey (
   }

 

   Status = gRT->SetVariable (

-                  VarKeyOrder,

+                  VAR_KEY_ORDER,

                   &gEfiGlobalVariableGuid,

                   EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,

                   KeyOrderSize,

@@ -670,7 +670,7 @@ InitializeHotkeyService (
   // Get valid Key Option List from private EFI variable "KeyOrder"

   //

   KeyOrder = BdsLibGetVariableAndSize (

-               VarKeyOrder,

+               VAR_KEY_ORDER,

                &gEfiGlobalVariableGuid,

                &KeyOrderSize

                );

diff --git a/MdeModulePkg/Universal/BdsDxe/Hotkey.h b/MdeModulePkg/Universal/BdsDxe/Hotkey.h
index 88966d02c5..3bc21509fc 100644
--- 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.
 

 **/

 

-#ifndef _HOTKEY_H

-#define _HOTKEY_H

+#ifndef _HOTKEY_H_

+#define _HOTKEY_H_

 

 #include "Bds.h"

 #include "String.h"

@@ -35,7 +35,7 @@ typedef struct {
 

 #define BDS_HOTKEY_OPTION_FROM_LINK(a) CR (a, BDS_HOTKEY_OPTION, Link, BDS_HOTKEY_OPTION_SIGNATURE)

 

-#define VarKeyOrder       L"KeyOrder"

+#define VAR_KEY_ORDER       L"KeyOrder"

 

 /**

 

@@ -53,7 +53,7 @@ EFI_STATUS
 RegisterHotkey (

   IN EFI_KEY_OPTION     *KeyOption,

   OUT UINT16            *KeyOptionNumber

-)

+  )

 ;

 

 /**

@@ -70,7 +70,7 @@ RegisterHotkey (
 EFI_STATUS

 UnregisterHotkey (

   IN UINT16             KeyOptionNumber

-)

+  )

 ;

 

 

diff --git a/MdeModulePkg/Universal/BdsDxe/HwErrRecSupport.h b/MdeModulePkg/Universal/BdsDxe/HwErrRecSupport.h
index f4d5f9cb12..a33e1149a6 100644
--- 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.
 

 **/

 

-#ifndef _HW_ERR_REC_SUPPORT_H

-#define _HW_ERR_REC_SUPPORT_H

+#ifndef _HW_ERR_REC_SUPPORT_H_

+#define _HW_ERR_REC_SUPPORT_H_

 

 #include "Bds.h"

 

diff --git a/MdeModulePkg/Universal/BdsDxe/Language.c b/MdeModulePkg/Universal/BdsDxe/Language.c
index 38784844b2..162d9f8358 100644
--- a/MdeModulePkg/Universal/BdsDxe/Language.c
+++ b/MdeModulePkg/Universal/BdsDxe/Language.c
@@ -253,11 +253,6 @@ FONT_PACK_BIN mFontBin = {
 /**

   Routine to export glyphs to the HII database.  This is in addition to whatever is defined in the Graphics Console driver.

 

-

-  @param VOID

-

-  @return VOID

-

 **/

 VOID

 ExportFonts (

@@ -286,13 +281,11 @@ ExportFonts (
 

 /**

   Determine the current language that will be used

-  based on language related EFI Variables

+  based on language related EFI Variables.

 

 

   @param LangCodesSettingRequired - If required to set LangCode variable

 

-  @return VOID

-

 **/

 VOID

 InitializeLanguage (

diff --git a/MdeModulePkg/Universal/BdsDxe/Language.h b/MdeModulePkg/Universal/BdsDxe/Language.h
index bdebb49912..2612e862bb 100644
--- 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.
 

 **/

 

-#ifndef _LANGUAGE_H

-#define _LANGUAGE_H

+#ifndef _LANGUAGE_H_

+#define _LANGUAGE_H_

 

 #include "String.h"

 

 /**

   Determine the current language that will be used

-  based on language related EFI Variables

+  based on language related EFI Variables.

 

 

-  @param LangCodesSettingRequired - If required to set LangCode variable

-

-  @return VOID

+  @param LangCodesSettingRequired If required to set LangCode variable

 

 **/

 VOID