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

2 files changed, 65 insertions, 46 deletions

diff --git a/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c b/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c
index b698dd4..5b1aaca 100644
--- 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  \

   (sizeof (mDeviceManagerMenuItemTable) / sizeof (DEVICE_MANAGER_MENU_ITEM))

 

+/**

+  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

 DeviceManagerCallback (

@@ -49,27 +67,6 @@ DeviceManagerCallback (
   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.

-

---*/

 {

   DEVICE_MANAGER_CALLBACK_DATA *PrivateData;

 

@@ -113,22 +110,20 @@ DeviceManagerCallback (
   return EFI_SUCCESS;

 }

 

-EFI_STATUS

-InitializeDeviceManager (

-  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

+InitializeDeviceManager (

+  VOID

+  )

 {

   EFI_STATUS                  Status;

   EFI_HII_PACKAGE_LIST_HEADER *PackageList;

@@ -169,25 +164,21 @@ Returns:
   return Status;

 }

 

-EFI_STATUS

-CallDeviceManager (

-  VOID

-  )

-/*++

-

-Routine Description:

+/**

 

   Call the browser and display the device manager

 

-Arguments:

 

-  None

+  @param VOID            EDES_TODO: Add parameter description

 

-Returns:

-  EFI_SUCCESS            - Operation is successful.

-  EFI_INVALID_PARAMETER  - If the inputs to SendForm function is not valid.

+  @retval  EFI_SUCCESS             Operation is successful.

+  @retval  EFI_INVALID_PARAMETER   If the inputs to SendForm function is not valid.

 

---*/

+**/

+EFI_STATUS

+CallDeviceManager (

+  VOID

+  )

 {

   EFI_STATUS                  Status;

   UINTN                       Count;

diff --git a/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h b/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h
index 3cc565b..3ced4c2 100644
--- a/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h
+++ b/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h
@@ -66,12 +66,24 @@ typedef struct {
       ConfigAccess, \

       DEVICE_MANAGER_CALLBACK_DATA_SIGNATURE \

       )

-

 typedef struct {

   EFI_STRING_ID  StringId;

   UINT16         Class;

 } DEVICE_MANAGER_MENU_ITEM;

 

+/**

+  EDES_TODO: Add function description

+

+  @param This            EDES_TODO: Add parameter description

+  @param Action          EDES_TODO: Add parameter description

+  @param QuestionId      EDES_TODO: Add parameter description

+  @param Type            EDES_TODO: Add parameter description

+  @param Value           EDES_TODO: Add parameter description

+  @param ActionRequest   EDES_TODO: Add parameter description

+

+  @return EDES_TODO: Add description for return value

+

+**/

 EFI_STATUS

 EFIAPI

 DeviceManagerCallback (

@@ -84,12 +96,28 @@ DeviceManagerCallback (
   )

 ;

 

+/**

+  EDES_TODO: Add function description

+

+  @param VOID            EDES_TODO: Add parameter description

+

+  @return EDES_TODO: Add description for return value

+

+**/

 EFI_STATUS

 InitializeDeviceManager (

   VOID

   )

 ;

 

+/**

+  EDES_TODO: Add function description

+

+  @param VOID            EDES_TODO: Add parameter description

+

+  @return EDES_TODO: Add description for return value

+

+**/

 EFI_STATUS

 CallDeviceManager (

   VOID