In V2, add comments on why uses __ prefix in enum type name.

For field name in structure, its first character should be upper case.

Cc: Michael Kinney <michael.d.kin...@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Liming Gao <liming....@intel.com>
---
 MdePkg/Include/Base.h | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

diff --git a/MdePkg/Include/Base.h b/MdePkg/Include/Base.h
index 5e24b5d..ce6cb07 100644
--- a/MdePkg/Include/Base.h
+++ b/MdePkg/Include/Base.h
@@ -63,16 +63,21 @@ VERIFY_SIZE_OF (UINT64, 8);
 VERIFY_SIZE_OF (CHAR8, 1);
 VERIFY_SIZE_OF (CHAR16, 2);
 
+//
+// Those three enum types are only used to verify compiler config is right. 
+// They are not used by any source code. So, __ prefix is added for them to 
+// avoid their name conflict with other types. 
+//
 typedef enum {
-  __VerifyUint8EnumValue = 0xff
+  VerifyUint8EnumValue = 0xff
 } __VERIFY_UINT8_ENUM_SIZE;
 
 typedef enum {
-  __VerifyUint16EnumValue = 0xffff
+  VerifyUint16EnumValue = 0xffff
 } __VERIFY_UINT16_ENUM_SIZE;
 
 typedef enum {
-  __VerifyUint32EnumValue = 0xffffffff
+  VerifyUint32EnumValue = 0xffffffff
 } __VERIFY_UINT32_ENUM_SIZE;
 
 VERIFY_SIZE_OF (__VERIFY_UINT8_ENUM_SIZE, 4);
-- 
2.8.0.windows.1

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel

Reply via email to