Update the function headers to Doxygen format.

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

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/ConsoleOption.c b/MdeModulePkg/Universal/BdsDxe/BootMaint/ConsoleOption.c
index 37ae770eeb5810bfa7535c220dbc124d0df6a153..e3a22f26d06bbef93a344ddaa393468caa629b51 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BootMaint/ConsoleOption.c
+++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/ConsoleOption.c
@@ -14,16 +14,41 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include "BootMaint.h"\r
 \r
+/**\r
+  EDES_TODO: Add function description\r
+\r
+  @param DevPath         EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 EFI_DEVICE_PATH_PROTOCOL  *\r
 DevicePathInstanceDup (\r
   IN EFI_DEVICE_PATH_PROTOCOL  *DevPath\r
   );\r
 \r
+/**\r
+  EDES_TODO: Add function description\r
+\r
+  @param DevicePath      EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 EFI_STATUS\r
 UpdateComAttributeFromVariable (\r
   EFI_DEVICE_PATH_PROTOCOL  *DevicePath\r
   );\r
 \r
+/**\r
+  EDES_TODO: Add function description\r
+\r
+  @param DevicePath      EDES_TODO: Add parameter description\r
+  @param ChangeTerminal  EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 EFI_STATUS\r
 ChangeTerminalDevicePath (\r
   EFI_DEVICE_PATH_PROTOCOL  *DevicePath,\r
@@ -136,6 +161,14 @@ ChangeTerminalDevicePath (
 \r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description\r
+\r
+  @param DevicePath      EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 VOID\r
 ChangeVariableDevicePath (\r
   EFI_DEVICE_PATH_PROTOCOL  *DevicePath\r
@@ -200,24 +233,22 @@ ChangeVariableDevicePath (
   return ;\r
 }\r
 \r
+/**\r
+  Retrieve ACPI UID of UART from device path\r
+\r
+\r
+  @param Handle          EDES_TODO: Add parameter description\r
+  @param AcpiUid         EDES_TODO: Add parameter description\r
+\r
+  @retval  TRUE   Find valid UID from device path\r
+  @retval  FALSE  Can't find\r
+\r
+**/\r
 BOOLEAN\r
 RetrieveUartUid (\r
   IN EFI_HANDLE   Handle,\r
   IN OUT UINT32   *AcpiUid\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-  Retrieve ACPI UID of UART from device path\r
-\r
-Arguments:\r
-  Handles   -   EFI_SERIAL_IO_PROTOCOL handle\r
-\r
-Returns:\r
-  TRUE  - Find valid UID from device path\r
-  FALSE - Can't find\r
-\r
---*/\r
 {\r
   UINT32                    Match;\r
   UINT8                     *Ptr;\r
@@ -249,24 +280,21 @@ Returns:
   }\r
 }\r
 \r
+/**\r
+  Sort Uart handles array with Acpi->UID from low to high\r
+\r
+\r
+  @param Handles         EFI_SERIAL_IO_PROTOCOL handle buffer\r
+  @param NoHandles       EFI_SERIAL_IO_PROTOCOL handle count\r
+\r
+           EDES_TODO: Incomplete Descriptions  None\r
+\r
+**/\r
 VOID\r
 SortedUartHandle (\r
   IN  EFI_HANDLE *Handles,\r
   IN  UINTN      NoHandles\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-  Sort Uart handles array with Acpi->UID from low to high\r
-\r
-Arguments:\r
-  Handles   -   EFI_SERIAL_IO_PROTOCOL handle buffer\r
-  NoHandles -   EFI_SERIAL_IO_PROTOCOL handle count\r
-\r
-Returns:\r
-  None\r
-\r
---*/\r
 {\r
   UINTN       Index1;\r
   UINTN       Index2;\r
@@ -299,6 +327,16 @@ Returns:
   }\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description\r
+\r
+  @param DevicePath      EDES_TODO: Add parameter description\r
+  @param Termi           EDES_TODO: Add parameter description\r
+  @param Com             EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 BOOLEAN\r
 IsTerminalDevicePath (\r
   IN  EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
@@ -306,20 +344,19 @@ IsTerminalDevicePath (
   OUT UINTN                    *Com\r
   );\r
 \r
-EFI_STATUS\r
-LocateSerialIo (\r
-  VOID\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
   Build a list containing all serial devices\r
 \r
-Arguments:\r
 \r
-Returns:\r
+  @param VOID            EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
 \r
---*/\r
+**/\r
+EFI_STATUS\r
+LocateSerialIo (\r
+  VOID\r
+  )\r
 {\r
   UINT8                     *Ptr;\r
   UINTN                     Index;\r
@@ -507,21 +544,19 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
-EFI_STATUS\r
-UpdateComAttributeFromVariable (\r
-  EFI_DEVICE_PATH_PROTOCOL  *DevicePath\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
   Update Com Ports attributes from DevicePath\r
 \r
-Arguments:\r
-  DevicePath  -   DevicePath that contains Com ports\r
 \r
-Returns:\r
+  @param DevicePath      DevicePath that contains Com ports\r
 \r
---*/\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
+EFI_STATUS\r
+UpdateComAttributeFromVariable (\r
+  EFI_DEVICE_PATH_PROTOCOL  *DevicePath\r
+  )\r
 {\r
   EFI_DEVICE_PATH_PROTOCOL  *Node;\r
   EFI_DEVICE_PATH_PROTOCOL  *SerialNode;\r
@@ -630,25 +665,21 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
-EFI_DEVICE_PATH_PROTOCOL *\r
-DevicePathInstanceDup (\r
-  IN EFI_DEVICE_PATH_PROTOCOL  *DevPath\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
   Function creates a device path data structure that identically matches the\r
   device path passed in.\r
 \r
-Arguments:\r
-  DevPath      - A pointer to a device path data structure.\r
 \r
-Returns:\r
+  @param DevPath         A pointer to a device path data structure.\r
 \r
-  The new copy of DevPath is created to identically match the input.\r
-  Otherwise, NULL is returned.\r
+           EDES_TODO: Incomplete Descriptions  The new copy of DevPath is created to identically match the input.\r
+           EDES_TODO: Incomplete Descriptions  Otherwise, NULL is returned.\r
 \r
---*/\r
+**/\r
+EFI_DEVICE_PATH_PROTOCOL *\r
+DevicePathInstanceDup (\r
+  IN EFI_DEVICE_PATH_PROTOCOL  *DevPath\r
+  )\r
 {\r
   EFI_DEVICE_PATH_PROTOCOL  *NewDevPath;\r
   EFI_DEVICE_PATH_PROTOCOL  *DevicePathInst;\r
@@ -682,6 +713,14 @@ Returns:
   return NewDevPath;\r
 }\r
 \r
+/**\r
+  EDES_TODO: Add function description\r
+\r
+  @param ConsoleMenuType EDES_TODO: Add parameter description\r
+\r
+  @return EDES_TODO: Add description for return value\r
+\r
+**/\r
 EFI_STATUS\r
 GetConsoleMenu (\r
   IN UINTN              ConsoleMenuType\r
@@ -801,22 +840,20 @@ GetConsoleMenu (
   return EFI_SUCCESS;\r
 }\r
 \r
-EFI_STATUS\r
-GetAllConsoles (\r
-  VOID\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
   Build up ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu\r
 \r
-Arguments:\r
 \r
-Returns:\r
-  EFI_SUCCESS\r
-  Others\r
+  @param VOID            EDES_TODO: Add parameter description\r
 \r
---*/\r
+           EDES_TODO: Incomplete Descriptions  EFI_SUCCESS\r
+           EDES_TODO: Incomplete Descriptions  Others\r
+\r
+**/\r
+EFI_STATUS\r
+GetAllConsoles (\r
+  VOID\r
+  )\r
 {\r
   GetConsoleMenu (BM_CONSOLE_IN_CONTEXT_SELECT);\r
   GetConsoleMenu (BM_CONSOLE_OUT_CONTEXT_SELECT);\r
@@ -824,22 +861,20 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
-EFI_STATUS\r
-FreeAllConsoles (\r
-  VOID\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
   Free ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu\r
 \r
-Arguments:\r
 \r
-Returns:\r
-  EFI_SUCCESS\r
-  Others\r
+  @param VOID            EDES_TODO: Add parameter description\r
 \r
---*/\r
+           EDES_TODO: Incomplete Descriptions  EFI_SUCCESS\r
+           EDES_TODO: Incomplete Descriptions  Others\r
+\r
+**/\r
+EFI_STATUS\r
+FreeAllConsoles (\r
+  VOID\r
+  )\r
 {\r
   BOpt_FreeMenu (&ConsoleOutMenu);\r
   BOpt_FreeMenu (&ConsoleInpMenu);\r
@@ -848,27 +883,24 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+  Test whether DevicePath is a valid Terminal\r
+\r
+\r
+  @param DevicePath      DevicePath to be checked\r
+  @param Termi           If is terminal, give its type\r
+  @param Com             If is Com Port, give its type\r
+\r
+  @retval  TRUE         If DevicePath point to a Terminal\r
+                        FALSE\r
+\r
+**/\r
 BOOLEAN\r
 IsTerminalDevicePath (\r
   IN  EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
   OUT TYPE_OF_TERMINAL         *Termi,\r
   OUT UINTN                    *Com\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-  Test whether DevicePath is a valid Terminal\r
-\r
-Arguments:\r
-  DevicePath  -   DevicePath to be checked\r
-  Termi       -   If is terminal, give its type\r
-  Com         -   If is Com Port, give its type\r
-\r
-Returns:\r
-  TRUE        -   If DevicePath point to a Terminal\r
-  FALSE\r
-\r
---*/\r
 {\r
   UINT8                 *Ptr;\r
   BOOLEAN               IsTerminal;\r
@@ -935,22 +967,19 @@ Returns:
   return TRUE;\r
 }\r
 \r
-VOID\r
-GetConsoleOutMode (\r
-  IN  BMM_CALLBACK_DATA    *CallbackData\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
   Get mode number according to column and row\r
 \r
-Arguments:\r
-  CallbackData  -  BMM_CALLBACK_DATA\r
 \r
-Returns:\r
-  None.\r
+  @param CallbackData    BMM_CALLBACK_DATA\r
+\r
+           EDES_TODO: Incomplete Descriptions  None.\r
 \r
---*/\r
+**/\r
+VOID\r
+GetConsoleOutMode (\r
+  IN  BMM_CALLBACK_DATA    *CallbackData\r
+  )\r
 {\r
   UINTN                         Col;\r
   UINTN                         Row;\r