Use doxygen comment style for document entity such as struct, enum, variable that...

[mirror_edk2.git] / MdePkg / Include / Library / BaseLib.h

diff --git a/MdePkg/Include/Library/BaseLib.h b/MdePkg/Include/Library/BaseLib.h
index 95e1b6d3144119f35a16c9f7a1b6dba44c9e7cfe..0c16c4813058fb11e688e115ea0a97c27aa20c0f 100644 (file)
--- a/MdePkg/Include/Library/BaseLib.h
+++ b/MdePkg/Include/Library/BaseLib.h
@@ -20,15 +20,15 @@
 // These include SPIN_LOCK and BASE_LIBRARY_JUMP_BUFFER\r
 //\r
 \r
-//\r
-// SPIN_LOCK\r
-//\r
+///\r
+/// SPIN_LOCK\r
+///\r
 typedef volatile UINTN              SPIN_LOCK;\r
 \r
 #if   defined (MDE_CPU_IA32)\r
-//\r
-// IA32 context buffer used by SetJump() and LongJump()\r
-//\r
+///\r
+/// IA32 context buffer used by SetJump() and LongJump()\r
+///\r
 typedef struct {\r
   UINT32                            Ebx;\r
   UINT32                            Esi;\r
@@ -42,9 +42,9 @@ typedef struct {
 \r
 #elif defined (MDE_CPU_IPF)\r
 \r
-//\r
-// IPF context buffer used by SetJump() and LongJump()\r
-//\r
+///\r
+/// IPF context buffer used by SetJump() and LongJump()\r
+///\r
 typedef struct {\r
   UINT64                            F2[2];\r
   UINT64                            F3[2];\r
@@ -89,9 +89,9 @@ typedef struct {
 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 0x10\r
 \r
 #elif defined (MDE_CPU_X64)\r
-//\r
-// X64 context buffer used by SetJump() and LongJump()\r
-//\r
+///\r
+/// X64 context buffer used by SetJump() and LongJump()\r
+///\r
 typedef struct {\r
   UINT64                            Rbx;\r
   UINT64                            Rsp;\r
@@ -108,9 +108,9 @@ typedef struct {
 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8\r
 \r
 #elif defined (MDE_CPU_EBC)\r
-//\r
-// EBC context buffer used by SetJump() and LongJump()\r
-//\r
+///\r
+/// EBC context buffer used by SetJump() and LongJump()\r
+///\r
 typedef struct {\r
   UINT64                            R0;\r
   UINT64                            R1;\r
@@ -3485,7 +3485,7 @@ CalculateCheckSum64 (
 //\r
 typedef\r
 VOID\r
-(EFIAPI *SWITCH_STACK_ENTRY_POINT) (\r
+(EFIAPI *SWITCH_STACK_ENTRY_POINT)(\r
   IN      VOID                      *Context1,  OPTIONAL\r
   IN      VOID                      *Context2   OPTIONAL\r
   );\r
@@ -3675,6 +3675,8 @@ CpuPause (
                       function.\r
   @param  NewStack    A pointer to the new stack to use for the EntryPoint\r
                       function.\r
+  @param  ...         Extended parameters.\r
+\r
 \r
 **/\r
 VOID\r
@@ -4930,9 +4932,9 @@ AsmSwitchStackAndBackingStore (
   @param  PalEntryPoint The entry point address of PAL. The address in ar.kr5\r
                         would be used if this parameter were NULL on input.\r
   @param  Arg1          The first argument of a PAL call.\r
-  @param  Arg1          The second argument of a PAL call.\r
-  @param  Arg1          The third argument of a PAL call.\r
-  @param  Arg1          The fourth argument of a PAL call.\r
+  @param  Arg2          The second argument of a PAL call.\r
+  @param  Arg3          The third argument of a PAL call.\r
+  @param  Arg4          The fourth argument of a PAL call.\r
 \r
   @return The values returned in r8, r9, r10 and r11.\r
 \r
@@ -7061,7 +7063,7 @@ AsmDisablePaging32 (
   If EntryPoint is 0, then ASSERT().\r
   If NewStack is 0, then ASSERT().\r
 \r
-  @param  Cs          The 16-bit selector to load in the CS before EntryPoint\r
+  @param  CodeSelector The 16-bit selector to load in the CS before EntryPoint\r
                       is called. The descriptor in the GDT that this selector\r
                       references must be setup for long mode.\r
   @param  EntryPoint  The 64-bit virtual address of the function to call with\r
@@ -7102,7 +7104,7 @@ AsmEnablePaging64 (
   If EntryPoint is 0, then ASSERT().\r
   If NewStack is 0, then ASSERT().\r
 \r
-  @param  Cs          The 16-bit selector to load in the CS before EntryPoint\r
+  @param  CodeSelector The 16-bit selector to load in the CS before EntryPoint\r
                       is called. The descriptor in the GDT that this selector\r
                       references must be setup for 32-bit protected mode.\r
   @param  EntryPoint  The 64-bit virtual address of the function to call with\r