Clean up Device Manager module in BdsDxe.

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

diff --git a/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c b/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c
index 5b1aacaa1e0ae58b646adfde6adbd576f1fb0ed1..49c3e7da70a008c4c7e98a3933d9a5c123169a66 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c
+++ b/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c
@@ -40,7 +40,9 @@ DEVICE_MANAGER_MENU_ITEM  mDeviceManagerMenuItemTable[] = {
   (sizeof (mDeviceManagerMenuItemTable) / sizeof (DEVICE_MANAGER_MENU_ITEM))\r
 \r
 /**\r
-  This function processes the results of changes in configuration.\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
@@ -52,9 +54,7 @@ DEVICE_MANAGER_MENU_ITEM  mDeviceManagerMenuItemTable[] = {
   @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
+  @retval  EFI_INVALID_PARAMETER The setup browser call this function with invalid parameters.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -112,12 +112,11 @@ DeviceManagerCallback (
 \r
 /**\r
 \r
-  Initialize HII information for the FrontPage\r
+  This function registers HII packages to HII database.\r
 \r
 \r
-  @param VOID            EDES_TODO: Add parameter description\r
-\r
-  @return EDES_TODO: Add description for return value\r
+  @retval EFI_SUCCESS This function complete successfully.\r
+  @return Other value if failed to register HII packages.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -166,13 +165,17 @@ InitializeDeviceManager (
 \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
+  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
-  @param VOID            EDES_TODO: Add parameter description\r
 \r
   @retval  EFI_SUCCESS             Operation is successful.\r
-  @retval  EFI_INVALID_PARAMETER   If the inputs to SendForm function is not valid.\r
+  @retval  Other values if failed to clean up the dynamic content from HII\r
+           database.\r
 \r
 **/\r
 EFI_STATUS\r

diff --git a/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h b/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h
index 3b1564399e09b9a336fdf6e26ce4bdbabbf7983a..a3b5dfeb9fca667534ddf6e60bcdc22db7c28ad3 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h
+++ b/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h
@@ -12,8 +12,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-#ifndef _DEVICE_MANAGER_H\r
-#define _DEVICE_MANAGER_H\r
+#ifndef _DEVICE_MANAGER_H_\r
+#define _DEVICE_MANAGER_H_\r
 \r
 #include "Bds.h"\r
 #include "FrontPage.h"\r