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 83bdc3a168f10f3e8bd9591db5d411eb53c1fdc9..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