MdePkg Base.h: Add add comments on __ prefix in enum VERIFY_UINTXX_ENUM_SIZE

[mirror_edk2.git] / MdePkg / Include / Base.h

diff --git a/MdePkg/Include/Base.h b/MdePkg/Include/Base.h
index 5e24b5d487b970694b75b7ea661173f9bdcebb7d..8f5b919faaf153411d084dadbb146e68a943d12a 100644 (file)
--- a/MdePkg/Include/Base.h
+++ b/MdePkg/Include/Base.h
@@ -63,6 +63,13 @@ VERIFY_SIZE_OF (UINT64, 8);
 VERIFY_SIZE_OF (CHAR8, 1);\r
 VERIFY_SIZE_OF (CHAR16, 2);\r
 \r
+//\r
+// The following three enum types are used to verify that the compiler\r
+// configuration for enum types is compliant with Section 2.3.1 of the \r
+// UEFI 2.3 Specification. These enum types and enum values are not \r
+// intended to be used. A prefix of '__' is used avoid conflicts with\r
+// other types.\r
+//\r
 typedef enum {\r
   __VerifyUint8EnumValue = 0xff\r
 } __VERIFY_UINT8_ENUM_SIZE;\r