Update or add comments to files and functions for use by Doxygen.

[mirror_edk2.git] / StdLib / Include / sys / _ctype.h

diff --git a/StdLib/Include/sys/_ctype.h b/StdLib/Include/sys/_ctype.h
index e5872f48f89c4aba189ce951bd50059e161a2ae0..6c2b3274116acb9738521f80079151803a958925 100644 (file)
--- a/StdLib/Include/sys/_ctype.h
+++ b/StdLib/Include/sys/_ctype.h
@@ -12,38 +12,40 @@
 \r
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
 **/\r
 #ifndef _CTYPE_H\r
 #error  This file, <sys/_ctype.h>, may only be included by <ctype.h>.\r
 #endif\r
 \r
 __BEGIN_DECLS\r
-extern const UINT16 *_cClass;  // Locale independent pointer to Character Classification Table\r
-extern const UINT8  *_uConvT;  // Locale independent pointer to Lowercase to Uppercase Conversion Table\r
-extern const UINT8  *_lConvT;  // Locale independent pointer to Uppercase to Lowercase Conversion Table\r
+extern const UINT16 *_cClass;  ///< Locale independent pointer to Character Classification Table.\r
+extern const UINT8  *_uConvT;  ///< Locale independent pointer to Lowercase to Uppercase Conversion Table.\r
+extern const UINT8  *_lConvT;  ///< Locale independent pointer to Uppercase to Lowercase Conversion Table.\r
 \r
-extern  int  __isCClass( int _c, unsigned int mask);   // Internal character classification function\r
+extern  int  __isCClass( int _c, unsigned int mask);   ///< Internal character classification function.\r
 __END_DECLS\r
 \r
 \r
-// Character Class bit masks\r
-#define _CC   0x0001U     // Control Characters\r
-#define _CW   0x0002U     // White Space\r
-#define _CP   0x0004U     // Punctuation\r
-#define _CD   0x0008U     // Digits [0-9]\r
-#define _CU   0x0010U     // Uppercase Letter [A-Z]\r
-#define _CL   0x0020U     // Lowercase Letter [a-z]\r
-#define _CX   0x0040U     // Hexadecimal Digits [A-Fa-f]\r
+/** Character Class bit masks.\r
+@{\r
+**/\r
+#define _CC   0x0001U     ///< Control Characters\r
+#define _CW   0x0002U     ///< White Space\r
+#define _CP   0x0004U     ///< Punctuation\r
+#define _CD   0x0008U     ///< Digits [0-9]\r
+#define _CU   0x0010U     ///< Uppercase Letter [A-Z]\r
+#define _CL   0x0020U     ///< Lowercase Letter [a-z]\r
+#define _CX   0x0040U     ///< Hexadecimal Digits [A-Fa-f]\r
 #define _C0   0x0080U\r
-#define _CS   0x0100U     // Space Characters, ' ' in C locale\r
-#define _CG   0x0200U     // Graphic Characters\r
-#define _CB   0x0400U     // Blank Characters, ' ' and '\t' in C locale\r
+#define _CS   0x0100U     ///< Space Characters, ' ' in C locale\r
+#define _CG   0x0200U     ///< Graphic Characters\r
+#define _CB   0x0400U     ///< Blank Characters, ' ' and '\t' in C locale\r
 #define _C4   0x0800U\r
-#define _XA   0x1000U     // eXtra Alpha characters not in _CU or _CL\r
+#define _XA   0x1000U     ///< eXtra Alpha characters not in _CU or _CL\r
 #define _C6   0x2000U\r
 #define _C7   0x4000U\r
 #define _C8   0x8000U\r
+/// @}\r
 \r
 #ifndef NO_CTYPE_MACROS\r
   #define __isCClass( _c, mask)   (((_c) < 0 || (_c) > 127) ? 0 : (_cClass[(_c)] & (mask)))\r