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

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

2 files changed, 21 insertions, 19 deletions

diff --git a/StdLib/Include/sys/_ctype.h b/StdLib/Include/sys/_ctype.h
index e5872f48f8..6c2b327411 100644
--- a/StdLib/Include/sys/_ctype.h
+++ b/StdLib/Include/sys/_ctype.h
@@ -12,38 +12,40 @@
 

   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

-

 **/

 #ifndef _CTYPE_H

 #error  This file, <sys/_ctype.h>, may only be included by <ctype.h>.

 #endif

 

 __BEGIN_DECLS

-extern const UINT16 *_cClass;  // Locale independent pointer to Character Classification Table

-extern const UINT8  *_uConvT;  // Locale independent pointer to Lowercase to Uppercase Conversion Table

-extern const UINT8  *_lConvT;  // Locale independent pointer to Uppercase to Lowercase Conversion Table

+extern const UINT16 *_cClass;  ///< Locale independent pointer to Character Classification Table.

+extern const UINT8  *_uConvT;  ///< Locale independent pointer to Lowercase to Uppercase Conversion Table.

+extern const UINT8  *_lConvT;  ///< Locale independent pointer to Uppercase to Lowercase Conversion Table.

 

-extern  int  __isCClass( int _c, unsigned int mask);   // Internal character classification function

+extern  int  __isCClass( int _c, unsigned int mask);   ///< Internal character classification function.

 __END_DECLS

 

 

-// Character Class bit masks

-#define _CC   0x0001U     // Control Characters

-#define _CW   0x0002U     // White Space

-#define _CP   0x0004U     // Punctuation

-#define _CD   0x0008U     // Digits [0-9]

-#define _CU   0x0010U     // Uppercase Letter [A-Z]

-#define _CL   0x0020U     // Lowercase Letter [a-z]

-#define _CX   0x0040U     // Hexadecimal Digits [A-Fa-f]

+/** Character Class bit masks.

+@{

+**/

+#define _CC   0x0001U     ///< Control Characters

+#define _CW   0x0002U     ///< White Space

+#define _CP   0x0004U     ///< Punctuation

+#define _CD   0x0008U     ///< Digits [0-9]

+#define _CU   0x0010U     ///< Uppercase Letter [A-Z]

+#define _CL   0x0020U     ///< Lowercase Letter [a-z]

+#define _CX   0x0040U     ///< Hexadecimal Digits [A-Fa-f]

 #define _C0   0x0080U

-#define _CS   0x0100U     // Space Characters, ' ' in C locale

-#define _CG   0x0200U     // Graphic Characters

-#define _CB   0x0400U     // Blank Characters, ' ' and '\t' in C locale

+#define _CS   0x0100U     ///< Space Characters, ' ' in C locale

+#define _CG   0x0200U     ///< Graphic Characters

+#define _CB   0x0400U     ///< Blank Characters, ' ' and '\t' in C locale

 #define _C4   0x0800U

-#define _XA   0x1000U     // eXtra Alpha characters not in _CU or _CL

+#define _XA   0x1000U     ///< eXtra Alpha characters not in _CU or _CL

 #define _C6   0x2000U

 #define _C7   0x4000U

 #define _C8   0x8000U

+/// @}

 

 #ifndef NO_CTYPE_MACROS

   #define __isCClass( _c, mask)   (((_c) < 0 || (_c) > 127) ? 0 : (_cClass[(_c)] & (mask)))

diff --git a/StdLib/Include/sys/errno.h b/StdLib/Include/sys/errno.h
index 3662c8d441..53c9e6903b 100644
--- a/StdLib/Include/sys/errno.h
+++ b/StdLib/Include/sys/errno.h
@@ -4,7 +4,8 @@
 

   The enum members expand to integral constant expressions

   with distinct nonzero values, suitable for use in #if preprocessing

-  directives.

+  directives.  These default values are specified as an enum in order to ease

+  the maintenance of the values.

 

   Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>

   This program and the accompanying materials are licensed and made available under

@@ -14,7 +15,6 @@
 

   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

-

 **/

 #ifdef  _ERRNO_H          // May only be included from <errno.h>

 #ifndef _SYS_ERRNO_H