Add doxygen style comments for functions in DxeMain.

[mirror_edk2.git] / MdeModulePkg / Core / Dxe / Misc / Stall.c

diff --git a/MdeModulePkg/Core/Dxe/Misc/Stall.c b/MdeModulePkg/Core/Dxe/Misc/Stall.c
index db32c1fa3adbb2d91d48b85931e1801a24feb424..8ab48e6cf30e7f1f2dd045c78076da520ca7060c 100644 (file)
--- a/MdeModulePkg/Core/Dxe/Misc/Stall.c
+++ b/MdeModulePkg/Core/Dxe/Misc/Stall.c
@@ -20,29 +20,22 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <DxeMain.h>\r
 \r
 \r
-EFI_STATUS\r
-EFIAPI\r
-CoreStall (\r
-  IN UINTN            Microseconds\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
 \r
+/**\r
   Introduces a fine-grained stall.\r
 \r
-Arguments:\r
-\r
-  Microseconds      The number of microseconds to stall execution\r
-\r
-Returns:\r
+  @param  Microseconds           The number of microseconds to stall execution.\r
 \r
-  EFI_SUCCESS            - Execution was stalled for at least the requested amount\r
-                           of microseconds.\r
+  @retval EFI_SUCCESS            Execution was stalled for at least the requested \r
+                                 amount of microseconds. \r
+  @retval EFI_NOT_AVAILABLE_YET  gMetronome is not available yet\r
 \r
-  EFI_NOT_AVAILABLE_YET  - gMetronome is not available yet\r
-\r
---*/\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+CoreStall (\r
+  IN UINTN            Microseconds\r
+  )\r
 {\r
   UINT32  Counter;\r
   UINT32  Remainder;\r