Update the function headers to Doxygen format.

[mirror_edk2.git] / MdeModulePkg / Universal / BdsDxe / BootMngr / BootManager.c

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.c b/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.c
index ba7387e5e977c1acd125724b1095c1b4290eded5..9a1b3683e95b34e63c4f808f6c5d0323778aff4a 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.c
+++ b/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.c
@@ -30,6 +30,24 @@ BOOT_MANAGER_CALLBACK_DATA  gBootManagerPrivate = {
   }\r
 };\r
 \r
+/**\r
+  This function processes the results of changes in configuration.\r
+\r
+\r
+  @param This            Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
+  @param Action          Specifies the type of action taken by the browser.\r
+  @param QuestionId      A unique value which is sent to the original exporting driver\r
+                         so that it can identify the type of data to expect.\r
+  @param Type            The type of value for the question.\r
+  @param Value           A pointer to the data being sent to the original exporting driver.\r
+  @param ActionRequest   On return, points to the action requested by the callback function.\r
+\r
+  @retval  EFI_SUCCESS           The callback successfully handled the action.\r
+  @retval  EFI_OUT_OF_RESOURCES  Not enough storage is available to hold the variable and its data.\r
+  @retval  EFI_DEVICE_ERROR      The variable could not be saved.\r
+  @retval  EFI_UNSUPPORTED       The specified Action is not supported by the callback.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 BootManagerCallback (\r
@@ -40,27 +58,6 @@ BootManagerCallback (
   IN  EFI_IFR_TYPE_VALUE                     *Value,\r
   OUT EFI_BROWSER_ACTION_REQUEST             *ActionRequest\r
   )\r
-/*++\r
-\r
-  Routine Description:\r
-    This function processes the results of changes in configuration.\r
-\r
-  Arguments:\r
-    This          - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
-    Action        - Specifies the type of action taken by the browser.\r
-    QuestionId    - A unique value which is sent to the original exporting driver\r
-                    so that it can identify the type of data to expect.\r
-    Type          - The type of value for the question.\r
-    Value         - A pointer to the data being sent to the original exporting driver.\r
-    ActionRequest - On return, points to the action requested by the callback function.\r
-\r
-  Returns:\r
-    EFI_SUCCESS          - The callback successfully handled the action.\r
-    EFI_OUT_OF_RESOURCES - Not enough storage is available to hold the variable and its data.\r
-    EFI_DEVICE_ERROR     - The variable could not be saved.\r
-    EFI_UNSUPPORTED      - The specified Action is not supported by the callback.\r
-\r
---*/\r
 {\r
   BDS_COMMON_OPTION       *Option;\r
   LIST_ENTRY              *Link;\r
@@ -102,22 +99,20 @@ BootManagerCallback (
   return EFI_SUCCESS;\r
 }\r
 \r
-EFI_STATUS\r
-InitializeBootManager (\r
-  VOID\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
 \r
   Initialize HII information for the FrontPage\r
 \r
-Arguments:\r
-  None\r
 \r
-Returns:\r
+  @param VOID            EDES_TODO: Add parameter description\r
 \r
---*/\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
+EFI_STATUS\r
+InitializeBootManager (\r
+  VOID\r
+  )\r
 {\r
   EFI_STATUS                  Status;\r
   EFI_HII_PACKAGE_LIST_HEADER *PackageList;\r
@@ -158,24 +153,19 @@ Returns:
   return Status;\r
 }\r
 \r
-VOID\r
-CallBootManager (\r
-  VOID\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
   Hook to enable UI timeout override behavior.\r
 \r
-Arguments:\r
-  BdsDeviceList - Device List that BDS needs to connect.\r
 \r
-  Entry - Pointer to current Boot Entry.\r
+  @param VOID            EDES_TODO: Add parameter description\r
 \r
-Returns:\r
-  NONE\r
+           EDES_TODO: Incomplete Descriptions  NONE\r
 \r
---*/\r
+**/\r
+VOID\r
+CallBootManager (\r
+  VOID\r
+  )\r
 {\r
   EFI_STATUS                  Status;\r
   BDS_COMMON_OPTION           *Option;\r