Clean up BdsDxe for Doxygen comments requirement.

[mirror_edk2.git] / MdeModulePkg / Universal / BdsDxe / DeviceMngr / DeviceManager.c

diff --git a/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c b/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c
index b698dd4e9f28fe897d1ea614340281f1861f5d4a..49c3e7da70a008c4c7e98a3933d9a5c123169a66 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c
+++ b/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c
@@ -39,6 +39,24 @@ DEVICE_MANAGER_MENU_ITEM  mDeviceManagerMenuItemTable[] = {
 #define MENU_ITEM_NUM  \\r
   (sizeof (mDeviceManagerMenuItemTable) / sizeof (DEVICE_MANAGER_MENU_ITEM))\r
 \r
+/**\r
+  This function is invoked if user selected a iteractive opcode from Device Manager's\r
+  Formset. The decision by user is saved to gCallbackKey for later processing. If\r
+  user set VBIOS, the new value is saved to EFI variable.\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_INVALID_PARAMETER The setup browser call this function with invalid parameters.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 DeviceManagerCallback (\r
@@ -49,27 +67,6 @@ DeviceManagerCallback (
   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
   DEVICE_MANAGER_CALLBACK_DATA *PrivateData;\r
 \r
@@ -113,22 +110,19 @@ DeviceManagerCallback (
   return EFI_SUCCESS;\r
 }\r
 \r
-EFI_STATUS\r
-InitializeDeviceManager (\r
-  VOID\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
 \r
-  Initialize HII information for the FrontPage\r
+  This function registers HII packages to HII database.\r
 \r
-Arguments:\r
-  None\r
 \r
-Returns:\r
+  @retval EFI_SUCCESS This function complete successfully.\r
+  @return Other value if failed to register HII packages.\r
 \r
---*/\r
+**/\r
+EFI_STATUS\r
+InitializeDeviceManager (\r
+  VOID\r
+  )\r
 {\r
   EFI_STATUS                  Status;\r
   EFI_HII_PACKAGE_LIST_HEADER *PackageList;\r
@@ -169,25 +163,25 @@ Returns:
   return Status;\r
 }\r
 \r
-EFI_STATUS\r
-CallDeviceManager (\r
-  VOID\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
 \r
-  Call the browser and display the device manager\r
+  Call the browser and display the device manager to allow user\r
+  to configure the platform.\r
 \r
-Arguments:\r
+  This function create the dynamic content for device manager. It includes\r
+  section header for all class of devices, one-of opcode to set VBIOS.\r
+  \r
 \r
-  None\r
 \r
-Returns:\r
-  EFI_SUCCESS            - Operation is successful.\r
-  EFI_INVALID_PARAMETER  - If the inputs to SendForm function is not valid.\r
+  @retval  EFI_SUCCESS             Operation is successful.\r
+  @retval  Other values if failed to clean up the dynamic content from HII\r
+           database.\r
 \r
---*/\r
+**/\r
+EFI_STATUS\r
+CallDeviceManager (\r
+  VOID\r
+  )\r
 {\r
   EFI_STATUS                  Status;\r
   UINTN                       Count;\r