Update the function headers to Doxygen format.

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

1 files changed, 35 insertions, 45 deletions

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.c b/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.c
index ba7387e..9a1b368 100644
--- a/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.c
+++ b/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.c
@@ -30,6 +30,24 @@ BOOT_MANAGER_CALLBACK_DATA  gBootManagerPrivate = {
   }

 };

 

+/**

+  This function processes the results of changes in configuration.

+

+

+  @param This            Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.

+  @param Action          Specifies the type of action taken by the browser.

+  @param QuestionId      A unique value which is sent to the original exporting driver

+                         so that it can identify the type of data to expect.

+  @param Type            The type of value for the question.

+  @param Value           A pointer to the data being sent to the original exporting driver.

+  @param ActionRequest   On return, points to the action requested by the callback function.

+

+  @retval  EFI_SUCCESS           The callback successfully handled the action.

+  @retval  EFI_OUT_OF_RESOURCES  Not enough storage is available to hold the variable and its data.

+  @retval  EFI_DEVICE_ERROR      The variable could not be saved.

+  @retval  EFI_UNSUPPORTED       The specified Action is not supported by the callback.

+

+**/

 EFI_STATUS

 EFIAPI

 BootManagerCallback (

@@ -40,27 +58,6 @@ BootManagerCallback (
   IN  EFI_IFR_TYPE_VALUE                     *Value,

   OUT EFI_BROWSER_ACTION_REQUEST             *ActionRequest

   )

-/*++

-

-  Routine Description:

-    This function processes the results of changes in configuration.

-

-  Arguments:

-    This          - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.

-    Action        - Specifies the type of action taken by the browser.

-    QuestionId    - A unique value which is sent to the original exporting driver

-                    so that it can identify the type of data to expect.

-    Type          - The type of value for the question.

-    Value         - A pointer to the data being sent to the original exporting driver.

-    ActionRequest - On return, points to the action requested by the callback function.

-

-  Returns:

-    EFI_SUCCESS          - The callback successfully handled the action.

-    EFI_OUT_OF_RESOURCES - Not enough storage is available to hold the variable and its data.

-    EFI_DEVICE_ERROR     - The variable could not be saved.

-    EFI_UNSUPPORTED      - The specified Action is not supported by the callback.

-

---*/

 {

   BDS_COMMON_OPTION       *Option;

   LIST_ENTRY              *Link;

@@ -102,22 +99,20 @@ BootManagerCallback (
   return EFI_SUCCESS;

 }

 

-EFI_STATUS

-InitializeBootManager (

-  VOID

-  )

-/*++

-

-Routine Description:

+/**

 

   Initialize HII information for the FrontPage

 

-Arguments:

-  None

 

-Returns:

+  @param VOID            EDES_TODO: Add parameter description

 

---*/

+  @return EDES_TODO: Add description for return value

+

+**/

+EFI_STATUS

+InitializeBootManager (

+  VOID

+  )

 {

   EFI_STATUS                  Status;

   EFI_HII_PACKAGE_LIST_HEADER *PackageList;

@@ -158,24 +153,19 @@ Returns:
   return Status;

 }

 

-VOID

-CallBootManager (

-  VOID

-  )

-/*++

-

-Routine Description:

+/**

   Hook to enable UI timeout override behavior.

 

-Arguments:

-  BdsDeviceList - Device List that BDS needs to connect.

 

-  Entry - Pointer to current Boot Entry.

+  @param VOID            EDES_TODO: Add parameter description

 

-Returns:

-  NONE

+           EDES_TODO: Incomplete Descriptions  NONE

 

---*/

+**/

+VOID

+CallBootManager (

+  VOID

+  )

 {

   EFI_STATUS                  Status;

   BDS_COMMON_OPTION           *Option;