Update the function headers to Doxygen format.

[mirror_edk2.git] / MdeModulePkg / Universal / BdsDxe / BootMaint / UpdatePage.c

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/UpdatePage.c b/MdeModulePkg/Universal/BdsDxe/BootMaint/UpdatePage.c
index 47d59a66f66efb80f00a9295eaa91520c8c6ae57..be84fdb563f31d82ec3a5aa1e91c5062fb4e5894 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BootMaint/UpdatePage.c
+++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/UpdatePage.c
@@ -14,26 +14,31 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include "BootMaint.h"\r
 \r
-VOID\r
-RefreshUpdateData (\r
-  VOID\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
   Refresh the global UpdateData structure.\r
 \r
-Arguments:\r
-  None.\r
 \r
-Returns:\r
-  None.\r
+  @param VOID            EDES_TODO: Add parameter description\r
+\r
+           EDES_TODO: Incomplete Descriptions  None.\r
 \r
---*/\r
+**/\r
+VOID\r
+RefreshUpdateData (\r
+  VOID\r
+  )\r
 {\r
   gUpdateData.Offset = 0;\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description\r
+\r
+  @param CallbackData    EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 VOID\r
 UpdatePageStart (\r
   IN BMM_CALLBACK_DATA                *CallbackData\r
@@ -58,6 +63,14 @@ UpdatePageStart (
 \r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description\r
+\r
+  @param CallbackData    EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 VOID\r
 UpdatePageEnd (\r
   IN BMM_CALLBACK_DATA                *CallbackData\r
@@ -107,6 +120,15 @@ UpdatePageEnd (
     );\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description\r
+\r
+  @param LabelId         EDES_TODO: Add parameter description\r
+  @param CallbackData    EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 VOID\r
 CleanUpPage (\r
   IN UINT16                           LabelId,\r
@@ -128,6 +150,14 @@ CleanUpPage (
     );\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description\r
+\r
+  @param FileContext     EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 EFI_STATUS\r
 BootThisFile (\r
   IN BM_FILE_CONTEXT                   *FileContext\r
@@ -161,6 +191,14 @@ BootThisFile (
 \r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description\r
+\r
+  @param CallbackData    EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 VOID\r
 UpdateConCOMPage (\r
   IN BMM_CALLBACK_DATA                *CallbackData\r
@@ -190,6 +228,14 @@ UpdateConCOMPage (
   UpdatePageEnd (CallbackData);\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description\r
+\r
+  @param CallbackData    EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 VOID\r
 UpdateBootDelPage (\r
   IN BMM_CALLBACK_DATA                *CallbackData\r
@@ -229,6 +275,14 @@ UpdateBootDelPage (
   UpdatePageEnd (CallbackData);\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description\r
+\r
+  @param CallbackData    EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 VOID\r
 UpdateDrvAddHandlePage (\r
   IN BMM_CALLBACK_DATA                *CallbackData\r
@@ -257,6 +311,14 @@ UpdateDrvAddHandlePage (
   UpdatePageEnd (CallbackData);\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description\r
+\r
+  @param CallbackData    EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 VOID\r
 UpdateDrvDelPage (\r
   IN BMM_CALLBACK_DATA                *CallbackData\r
@@ -294,6 +356,14 @@ UpdateDrvDelPage (
   UpdatePageEnd (CallbackData);\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description\r
+\r
+  @param CallbackData    EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 VOID\r
 UpdateDriverAddHandleDescPage (\r
   IN BMM_CALLBACK_DATA                *CallbackData\r
@@ -356,6 +426,16 @@ UpdateDriverAddHandleDescPage (
   UpdatePageEnd (CallbackData);\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description\r
+\r
+  @param UpdatePageId    EDES_TODO: Add parameter description\r
+  @param ConsoleMenu     EDES_TODO: Add parameter description\r
+  @param CallbackData    EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 VOID\r
 UpdateConsolePage (\r
   IN UINT16                           UpdatePageId,\r
@@ -429,6 +509,16 @@ UpdateConsolePage (
   UpdatePageEnd (CallbackData);\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description\r
+\r
+  @param UpdatePageId    EDES_TODO: Add parameter description\r
+  @param OptionMenu      EDES_TODO: Add parameter description\r
+  @param CallbackData    EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 VOID\r
 UpdateOrderPage (\r
   IN UINT16                           UpdatePageId,\r
@@ -489,6 +579,14 @@ UpdateOrderPage (
     );\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description\r
+\r
+  @param CallbackData    EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 VOID\r
 UpdateBootNextPage (\r
   IN BMM_CALLBACK_DATA                *CallbackData\r
@@ -554,6 +652,14 @@ UpdateBootNextPage (
   UpdatePageEnd (CallbackData);\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description\r
+\r
+  @param CallbackData    EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 VOID\r
 UpdateTimeOutPage (\r
   IN BMM_CALLBACK_DATA                *CallbackData\r
@@ -587,22 +693,19 @@ UpdateTimeOutPage (
   UpdatePageEnd (CallbackData);\r
 }\r
 \r
-VOID\r
-UpdateConModePage (\r
-  IN BMM_CALLBACK_DATA                *CallbackData\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
   Refresh the text mode page\r
 \r
-Arguments:\r
-  CallbackData      - BMM_CALLBACK_DATA\r
 \r
-Returns:\r
-  None.\r
+  @param CallbackData    BMM_CALLBACK_DATA\r
 \r
---*/\r
+           EDES_TODO: Incomplete Descriptions  None.\r
+\r
+**/\r
+VOID\r
+UpdateConModePage (\r
+  IN BMM_CALLBACK_DATA                *CallbackData\r
+  )\r
 {\r
   UINTN                         Mode;\r
   UINTN                         Index;\r
@@ -698,6 +801,14 @@ Returns:
   UpdatePageEnd (CallbackData);\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description\r
+\r
+  @param CallbackData    EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 VOID\r
 UpdateTerminalPage (\r
   IN BMM_CALLBACK_DATA                *CallbackData\r
@@ -864,6 +975,15 @@ UpdateTerminalPage (
   UpdatePageEnd (CallbackData);\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description\r
+\r
+  @param UpdatePageId    EDES_TODO: Add parameter description\r
+  @param CallbackData    EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 VOID\r
 UpdatePageBody (\r
   IN UINT16                           UpdatePageId,\r
@@ -897,6 +1017,16 @@ UpdatePageBody (
   }\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description\r
+\r
+  @param DeviceType      EDES_TODO: Add parameter description\r
+  @param OptionIndex     EDES_TODO: Add parameter description\r
+  @param OptionSize      EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 VOID *\r
 GetLegacyBootOptionVar (\r
   IN  UINTN                            DeviceType,\r
@@ -969,6 +1099,15 @@ GetLegacyBootOptionVar (
   return NULL;\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description\r
+\r
+  @param UpdatePageId    EDES_TODO: Add parameter description\r
+  @param CallbackData    EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 VOID\r
 UpdateSetLegacyDeviceOrderPage (\r
   IN UINT16                           UpdatePageId,\r
@@ -1164,6 +1303,15 @@ UpdateSetLegacyDeviceOrderPage (
   UpdatePageEnd (CallbackData);\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description\r
+\r
+  @param Private         EDES_TODO: Add parameter description\r
+  @param NewPageId       EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 VOID\r
 UpdatePageId (\r
   BMM_CALLBACK_DATA              *Private,\r