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

[mirror_edk2.git] / MdePkg / Include / Ebc / ProcessorBind.h

diff --git a/MdePkg/Include/Ebc/ProcessorBind.h b/MdePkg/Include/Ebc/ProcessorBind.h
index ed1ff07e52925b867685ee73de966c9549dc4197..2e254ffb04ab609101fbffdf4a65c863fe45156b 100644 (file)
--- a/MdePkg/Include/Ebc/ProcessorBind.h
+++ b/MdePkg/Include/Ebc/ProcessorBind.h
@@ -18,9 +18,9 @@
 #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_EBC\r
 \r
 //\r
@@ -41,42 +41,42 @@ typedef unsigned int          UINT32;
 typedef __int64               INT64;\r
 typedef unsigned __int64      UINT64;\r
 \r
-//\r
-// "long" type scales to the processor native size with EBC compiler\r
-//\r
+///\r
+/// "long" type scales to the processor native size with EBC compiler\r
+///\r
 typedef long                  INTN;\r
 typedef unsigned long         UINTN;\r
 \r
 #define UINT8_MAX 0xff\r
 \r
-//\r
-// Scalable macro to set the most significant bit in a natural number\r
-//\r
+///\r
+/// Scalable macro to set the most significant bit in a natural number\r
+///\r
 #define MAX_BIT     (1ULL << (sizeof (INTN) * 8 - 1)) \r
 #define MAX_2_BITS  (3ULL << (sizeof (INTN) * 8 - 2))\r
 \r
-//\r
-// Maximum legal EBC address\r
-//\r
+///\r
+/// Maximum legal EBC address\r
+///\r
 #define MAX_ADDRESS   ((UINTN) ~0)\r
 \r
-//\r
-// The stack alignment required for EBC\r
-//\r
+///\r
+/// The stack alignment required for EBC\r
+///\r
 #define CPU_STACK_ALIGNMENT   sizeof(UINTN)\r
 \r
-//\r
-// Modifier to ensure that all protocol member functions and EFI intrinsics\r
-// use the correct C calling convention. All protocol member functions and\r
-// EFI intrinsics are required to modify thier member functions with EFIAPI.\r
-//\r
+///\r
+/// Modifier to ensure that all protocol member functions and EFI intrinsics\r
+/// use the correct C calling convention. All protocol member functions and\r
+/// EFI intrinsics are required to modify thier member functions with EFIAPI.\r
+///\r
 #define EFIAPI    \r
 \r
-//\r
-// The Microsoft* C compiler can removed references to unreferenced data items\r
-//  if the /OPT:REF linker option is used. We defined a macro as this is a \r
-//  a non standard extension. Currently not supported by the EBC compiler\r
-//\r
+///\r
+/// The Microsoft* C compiler can removed references to unreferenced data items\r
+///  if the /OPT:REF linker option is used. We defined a macro as this is a \r
+///  a non standard extension. Currently not supported by the EBC compiler\r
+///\r
 #define GLOBAL_REMOVE_IF_UNREFERENCED\r
 \r
 #define FUNCTION_ENTRY_POINT(p) (p)\r