Update the function headers to Doxygen format.

[mirror_edk2.git] / MdeModulePkg / Universal / BdsDxe / BdsEntry.c

diff --git a/MdeModulePkg/Universal/BdsDxe/BdsEntry.c b/MdeModulePkg/Universal/BdsDxe/BdsEntry.c
index 52a6b497a5dbff18db9a0bfa55bdfdcdca3b463b..adbce15f2dac53ad46c79986ed90790122f3b7ed 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BdsEntry.c
+++ b/MdeModulePkg/Universal/BdsDxe/BdsEntry.c
@@ -32,32 +32,27 @@ UINT16                          *mBootNext = NULL;
 \r
 EFI_HANDLE                      mBdsImageHandle;\r
 \r
-EFI_STATUS\r
-EFIAPI\r
-BdsInitialize (\r
-  IN EFI_HANDLE                            ImageHandle,\r
-  IN EFI_SYSTEM_TABLE                      *SystemTable\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
 \r
   Install Boot Device Selection Protocol\r
 \r
-Arguments:\r
-\r
-  (Standard EFI Image entry - EFI_IMAGE_ENTRY_POINT)\r
 \r
-Returns:\r
+  @param ImageHandle     The image handle.\r
+  @param SystemTable     The system table.\r
 \r
-  EFI_SUCEESS - BDS has finished initializing.\r
-                Rerun the\r
-                dispatcher and recall BDS.Entry\r
+  @retval  EFI_SUCEESS  BDS has finished initializing.\r
+                        Rerun the\r
+                        dispatcher and recall BDS.Entry\r
+  @retval  Other        Return value from AllocatePool()\r
+                        or gBS->InstallProtocolInterface\r
 \r
-  Other       - Return value from AllocatePool()\r
-                or gBS->InstallProtocolInterface\r
-\r
---*/\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+BdsInitialize (\r
+  IN EFI_HANDLE                            ImageHandle,\r
+  IN EFI_SYSTEM_TABLE                      *SystemTable\r
+  )\r
 {\r
   EFI_STATUS  Status;\r
 \r
@@ -77,25 +72,20 @@ Returns:
   return Status;\r
 }\r
 \r
-VOID\r
-BdsBootDeviceSelect (\r
-  VOID\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
 \r
   In the loop of attempt to boot for the boot order\r
 \r
-Arguments:\r
-\r
-  None.\r
 \r
-Returns:\r
+  @param VOID           No input parameter.\r
 \r
-  None.\r
+  @retval VOID          No returns.\r
 \r
---*/\r
+**/\r
+VOID\r
+BdsBootDeviceSelect (\r
+  VOID\r
+  )\r
 {\r
   EFI_STATUS        Status;\r
   LIST_ENTRY        *Link;\r
@@ -263,27 +253,22 @@ Returns:
 \r
 }\r
 \r
-VOID\r
-EFIAPI\r
-BdsEntry (\r
-  IN EFI_BDS_ARCH_PROTOCOL  *This\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
 \r
   Service routine for BdsInstance->Entry(). Devices are connected, the\r
   consoles are initialized, and the boot options are tried.\r
 \r
-Arguments:\r
 \r
-  This - Protocol Instance structure.\r
+  @param This            - Protocol Instance structure.\r
 \r
-Returns:\r
+  @retval  EFI_SUCEESS  BDS->Entry has finished executing.\r
 \r
-  EFI_SUCEESS - BDS->Entry has finished executing.\r
-\r
---*/\r
+**/\r
+VOID\r
+EFIAPI\r
+BdsEntry (\r
+  IN EFI_BDS_ARCH_PROTOCOL  *This\r
+  )\r
 {\r
   EFI_BDS_ARCH_PROTOCOL_INSTANCE  *PrivateData;\r
   LIST_ENTRY                      DriverOptionList;\r
@@ -327,7 +312,7 @@ Returns:
   //\r
   InitializeStringSupport ();\r
   InitializeLanguage (TRUE);\r
-  InitializeFrontPage (FALSE);\r
+  InitializeFrontPage (TRUE);\r
 \r
   //\r
   // Set up the device list based on EFI 1.1 variables\r