Add doxygen style comments for functions in DxeMain.

[mirror_edk2.git] / MdeModulePkg / Core / Dxe / Exec.h

diff --git a/MdeModulePkg/Core/Dxe/Exec.h b/MdeModulePkg/Core/Dxe/Exec.h
index 5df700113db87bc78366d00128a2ae7433e1497f..05d22e444d04ff56fe7e950d5009f5b17c9b1065 100644 (file)
--- a/MdeModulePkg/Core/Dxe/Exec.h
+++ b/MdeModulePkg/Core/Dxe/Exec.h
@@ -1,6 +1,8 @@
-/*++\r
+/** @file \r
 \r
-Copyright (c) 2006, Intel Corporation                                                         \r
+  UEFI Event support functions and structure.\r
+\r
+Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
 are licensed and made available under the terms and conditions of the BSD License         \r
 which accompanies this distribution.  The full text of the license may be found at        \r
@@ -9,15 +11,7 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
-Module Name:\r
-  \r
-  exec.h\r
-\r
-Abstract:\r
-    \r
-  EFI Event support\r
-\r
---*/\r
+**/\r
 \r
 #ifndef _EXEC_H_\r
 #define _EXEC_H_\r
@@ -79,120 +73,76 @@ typedef struct {
 // Internal prototypes\r
 //\r
 \r
+\r
+/**\r
+  Dispatches all pending events.\r
+\r
+  @param  Priority               The task priority level of event notifications \r
+                                 to dispatch\r
+\r
+**/\r
 VOID\r
 CoreDispatchEventNotifies (\r
   IN EFI_TPL      Priority\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Dispatches all pending events. \r
+;\r
 \r
-Arguments:\r
 \r
-  Priority - The task priority level of event notifications to dispatch\r
-    \r
-Returns:\r
 \r
-  None\r
+/**\r
+  Return the highest set bit.\r
 \r
---*/\r
-;\r
+  @param  Number  The value to check \r
 \r
+  @return Bit position of the highest set bit\r
 \r
+**/\r
 UINTN\r
 CoreHighestSetBit (\r
   IN UINTN         Number\r
   )\r
-/*++\r
+;\r
 \r
-Routine Description:\r
-  \r
-  Return the highest set bit\r
-  \r
-Arguments:\r
-  \r
-  Number - The value to check\r
-  \r
-Returns:\r
-  \r
-  Bit position of the highest set bit\r
 \r
---*/\r
-;\r
 \r
+/**\r
+  Disables CPU interrupts.\r
+\r
+  @retval EFI_SUCCESS            If interrupts were disabled in the CPU. \r
+  @retval EFI_INVALID_PARAMETER  State is NULL.\r
 \r
+**/\r
 BOOLEAN\r
 GetInterruptState (\r
   VOID               \r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Disables CPU interrupts.\r
-\r
-Arguments:\r
-\r
-  This                - Protocol instance structure\r
-\r
-  State               - Pointer to the CPU's current interrupt state\r
-\r
-Returns: \r
-\r
-  EFI_SUCCESS           - If interrupts were disabled in the CPU.\r
-\r
-  EFI_INVALID_PARAMETER - State is NULL.\r
-  \r
---*/\r
 ;\r
 \r
 //\r
 // Exported functions\r
 //\r
 \r
+\r
+/**\r
+  A function out of date, should be removed.\r
+\r
+**/\r
 VOID\r
 CoreEventVirtualAddressFixup (\r
   VOID\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  A function out of date, should be removed.\r
-\r
-Arguments:\r
-\r
-  None\r
-    \r
-Returns:\r
+;\r
 \r
-  None\r
 \r
---*/\r
-;\r
 \r
+/**\r
+  Initializes timer support.\r
 \r
+**/\r
 VOID\r
 CoreInitializeTimer (\r
   VOID\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Initializes timer support\r
-\r
-Arguments:\r
-\r
-  None\r
-    \r
-Returns:\r
-\r
-  None\r
-\r
---*/\r
 ;\r
 \r
 //\r
@@ -203,6 +153,5 @@ extern EFI_LOCK       gEventQueueLock;
 extern UINTN          gEventPending;\r
 extern LIST_ENTRY     gEventQueue[];\r
 extern LIST_ENTRY     gEventSignalQueue;\r
-extern UINT8          gHSB[];\r
 \r
 #endif\r