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

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5644 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Ia32/ProcessorBind.h b/MdePkg/Include/Ia32/ProcessorBind.h
index 72c10328e45a07e54b00650d209a82271cfb5a1c..c609bb969e92e660a9aea04d1650f4d333e90dc9 100644 (file)
--- a/MdePkg/Include/Ia32/ProcessorBind.h
+++ b/MdePkg/Include/Ia32/ProcessorBind.h
@@ -15,9 +15,9 @@
 #ifndef __PROCESSOR_BIND_H__\r
 #define __PROCESSOR_BIND_H__\r
 \r
 #ifndef __PROCESSOR_BIND_H__\r
 #define __PROCESSOR_BIND_H__\r
 \r

-//\r
-// Define the processor type so other code can make processor based choices\r
-//\r
+///\r
+/// Define the processor type so other code can make processor based choices\r
+///\r

 #define MDE_CPU_IA32\r
 \r
 //\r
 #define MDE_CPU_IA32\r
 \r
 //\r


@@ -150,20 +150,20 @@ typedef UINT32  UINTN;
 typedef INT32   INTN;\r
 \r
 \r
 typedef INT32   INTN;\r
 \r
 \r

-//\r
-// Processor specific defines\r
-//\r
+///\r
+/// Processor specific defines\r
+///\r

 #define MAX_BIT     0x80000000\r
 #define MAX_2_BITS  0xC0000000\r
 \r
 #define MAX_BIT     0x80000000\r
 #define MAX_2_BITS  0xC0000000\r
 \r

-//\r
-// Maximum legal IA-32 address\r
-//\r
+///\r
+/// Maximum legal IA-32 address\r
+///\r

 #define MAX_ADDRESS   0xFFFFFFFF\r
 \r
 #define MAX_ADDRESS   0xFFFFFFFF\r
 \r

-//\r
-// The stack alignment required for IA-32\r
-//\r
+///\r
+/// The stack alignment required for IA-32\r
+///\r

 #define CPU_STACK_ALIGNMENT   sizeof(UINTN)\r
 \r
 //\r
 #define CPU_STACK_ALIGNMENT   sizeof(UINTN)\r
 \r
 //\r


@@ -172,9 +172,9 @@ typedef INT32   INTN;
 // EFI intrinsics are required to modify thier member functions with EFIAPI.\r
 //\r
 #if _MSC_EXTENSIONS\r
 // EFI intrinsics are required to modify thier member functions with EFIAPI.\r
 //\r
 #if _MSC_EXTENSIONS\r

-  //\r
-  // Microsoft* compiler requires _EFIAPI useage, __cdecl is Microsoft* specific C.\r
-  // \r
+  ///\r
+  /// Microsoft* compiler requires _EFIAPI useage, __cdecl is Microsoft* specific C.\r
+  /// \r

   #define EFIAPI __cdecl  \r
 #else\r
   #if __GNUC__\r
   #define EFIAPI __cdecl  \r
 #else\r
   #if __GNUC__\r