Add doxygen style comments for functions in DxeMain.

[mirror_edk2.git] / MdeModulePkg / Core / Dxe / Dispatcher / dependency.c

diff --git a/MdeModulePkg/Core/Dxe/Dispatcher/dependency.c b/MdeModulePkg/Core/Dxe/Dispatcher/dependency.c
index 62bdb14e406272711824b9098473d0f49fdeb821..21f08c2a9c823378d1b49da1a137ad392a6a9c39 100644 (file)
--- a/MdeModulePkg/Core/Dxe/Dispatcher/dependency.c
+++ b/MdeModulePkg/Core/Dxe/Dispatcher/dependency.c
@@ -30,32 +30,20 @@ BOOLEAN *mDepexEvaluationStackPointer = NULL;
 // Worker functions\r
 //\r
 \r
+\r
+/**\r
+  Grow size of the Depex stack\r
+\r
+  @retval EFI_SUCCESS           Stack successfully growed. \r
+  @retval EFI_OUT_OF_RESOURCES  There is not enough system memory to grow the \r
+                                stack.\r
+\r
+**/\r
 STATIC\r
 EFI_STATUS\r
 GrowDepexStack (\r
   VOID\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Grow size of the Depex stack\r
-\r
-Arguments:\r
-\r
-  Stack     - Old stack on the way in and new stack on the way out\r
-\r
-  StackSize - New size of the stack\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS          - Stack successfully growed.\r
-  \r
-  EFI_OUT_OF_RESOURCES - There is not enough system memory to grow the stack.\r
-  \r
-  \r
-\r
---*/\r
 {\r
   BOOLEAN     *NewStack;\r
   UINTN       Size;\r
@@ -97,28 +85,22 @@ Returns:
 }\r
 \r
 \r
-STATIC\r
-EFI_STATUS\r
-PushBool (\r
-  IN BOOLEAN  Value\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
 \r
+/**\r
   Push an element onto the Boolean Stack\r
 \r
-Arguments:\r
-\r
-  Value - BOOLEAN to push.\r
+  @param  Value                 BOOLEAN to push. \r
 \r
-Returns:\r
+  @retval EFI_SUCCESS           The value was pushed onto the stack. \r
+  @retval EFI_OUT_OF_RESOURCES  There is not enough system memory to grow the \r
+                                stack.\r
 \r
-  EFI_SUCCESS          - The value was pushed onto the stack.\r
-\r
-  EFI_OUT_OF_RESOURCES - There is not enough system memory to grow the stack.\r
-\r
---*/\r
+**/\r
+STATIC\r
+EFI_STATUS\r
+PushBool (\r
+  IN BOOLEAN  Value\r
+  )\r
 {\r
   EFI_STATUS  Status;\r
 \r
@@ -145,28 +127,21 @@ Returns:
 }\r
 \r
 \r
-STATIC\r
-EFI_STATUS \r
-PopBool (\r
-  OUT BOOLEAN  *Value\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
 \r
+/**\r
   Pop an element from the Boolean stack.\r
 \r
-Arguments:\r
-\r
-  Value - BOOLEAN to pop.\r
-\r
-Returns:\r
+  @param  Value                 BOOLEAN to pop. \r
 \r
-  EFI_SUCCESS       - The value was popped onto the stack.\r
+  @retval EFI_SUCCESS           The value was popped onto the stack. \r
+  @retval EFI_ACCESS_DENIED     The pop operation underflowed the stack\r
 \r
-  EFI_ACCESS_DENIED - The pop operation underflowed the stack\r
-\r
---*/\r
+**/\r
+STATIC\r
+EFI_STATUS \r
+PopBool (\r
+  OUT BOOLEAN  *Value\r
+  )\r
 {\r
   //\r
   // Check for a stack underflow condition\r
@@ -184,29 +159,23 @@ Returns:
 }\r
 \r
 \r
-EFI_STATUS\r
-CorePreProcessDepex (\r
-  IN  EFI_CORE_DRIVER_ENTRY   *DriverEntry  \r
-  )\r
-/*++\r
-\r
-Routine Description:\r
 \r
+/**\r
   Preprocess dependency expression and update DriverEntry to reflect the\r
   state of  Before, After, and SOR dependencies. If DriverEntry->Before\r
   or DriverEntry->After is set it will never be cleared. If SOR is set\r
-  it will be cleared by CoreSchedule(), and then the driver can be \r
+  it will be cleared by CoreSchedule(), and then the driver can be\r
   dispatched.\r
 \r
-Arguments:\r
+  @param  DriverEntry           DriverEntry element to update \r
 \r
-  DriverEntry - DriverEntry element to update\r
+  @retval EFI_SUCCESS           It always works.\r
 \r
-Returns:\r
-\r
-  EFI_SUCCESS - It always works.\r
-\r
---*/\r
+**/\r
+EFI_STATUS\r
+CorePreProcessDepex (\r
+  IN  EFI_CORE_DRIVER_ENTRY   *DriverEntry  \r
+  )\r
 {\r
   UINT8  *Iterator;\r
     \r
@@ -231,31 +200,24 @@ Returns:
 }\r
 \r
 \r
-BOOLEAN\r
-CoreIsSchedulable (\r
-  IN  EFI_CORE_DRIVER_ENTRY   *DriverEntry  \r
-  )\r
-/*++\r
 \r
-Routine Description:\r
-\r
-  This is the POSTFIX version of the dependency evaluator.  This code does \r
-  not need to handle Before or After, as it is not valid to call this \r
+/**\r
+  This is the POSTFIX version of the dependency evaluator.  This code does\r
+  not need to handle Before or After, as it is not valid to call this\r
   routine in this case. The SOR is just ignored and is a nop in the grammer.\r
-\r
   POSTFIX means all the math is done on top of the stack.\r
 \r
-Arguments:\r
+  @param  DriverEntry           DriverEntry element to update \r
 \r
-  DriverEntry - DriverEntry element to update\r
-  \r
-Returns:\r
-\r
-  TRUE - If driver is ready to run.\r
-\r
-  FALSE - If driver is not ready to run or some fatal error was found.\r
+  @retval TRUE                  If driver is ready to run. \r
+  @retval FALSE                 If driver is not ready to run or some fatal error \r
+                                was found.\r
 \r
---*/\r
+**/\r
+BOOLEAN\r
+CoreIsSchedulable (\r
+  IN  EFI_CORE_DRIVER_ENTRY   *DriverEntry  \r
+  )\r
 {\r
   EFI_STATUS  Status;\r
   UINT8       *Iterator;\r
@@ -444,3 +406,4 @@ Done:
   return FALSE;\r
 }\r
 \r
+\r