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

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

diff --git a/StdLib/Include/Ia32/machine/limits.h b/StdLib/Include/Ia32/machine/limits.h
index 0b3cfbe4c5eb01906ad8a3181cda296761e7468d..f072e54a7d35dc43b6885a8834f2466a657e01d4 100644 (file)
--- a/StdLib/Include/Ia32/machine/limits.h
+++ b/StdLib/Include/Ia32/machine/limits.h
@@ -1,14 +1,33 @@
+/** @file\r
+  This header <machine/limits.h> defines several macros that expand to various\r
+  CPU-architecture-specific limits and parameters of the standard integer types.\r
+\r
+  The values given below are constant expressions suitable for use\r
+  in #if preprocessing directives.\r
+\r
+  Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials are licensed and made available under\r
+  the terms and conditions of the BSD License that accompanies this distribution.\r
+  The full text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.\r
+\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

 #include  <x86/limits.h>\r
 \r
 #include  <x86/limits.h>\r
 \r

+/** Number of bits making up a pointer. **/\r

 #define __POINTER_BIT   32\r
 #define __POINTER_BIT   32\r

+\r
+/** Number of bits comprising an object of type long int. **/\r

 #define __LONG_BIT      32\r
 \r
 #define __LONG_BIT      32\r
 \r

-/** minimum value for an object of type long int **/\r
-#define __LONG_MIN    (-2147483647L - 1L) // -(2^31 - 1)\r
+/** Minimum value for an object of type long int. **/\r
+#define __LONG_MIN    (-2147483647L - 1L)   // -(2^31 - 1)\r

 \r
 \r

-/** maximum value for an object of type long int **/\r
-#define __LONG_MAX    +2147483647L // 2^31 - 1\r
+/** Maximum value for an object of type long int. **/\r
+#define __LONG_MAX    +2147483647L          // 2^31 - 1\r

 \r
 \r

-/** maximum value for an object of type unsigned long int **/\r
-#define __ULONG_MAX   0xffffffff // 2^32 - 1\r
+/** Maximum value for an object of type unsigned long int. **/\r
+#define __ULONG_MAX   0xffffffff            // 2^32 - 1\r

 \r
 \r

diff --git a/StdLib/Include/iso646.h b/StdLib/Include/iso646.h
index db3450193de31e16f74a565043760b51c9601f5f..d9dc8603461e7e89297405b895c151dd49a6f368 100644 (file)
--- a/StdLib/Include/iso646.h
+++ b/StdLib/Include/iso646.h
@@ -17,16 +17,16 @@
 #define _ISO646_H\r
 #include  <sys/EfiCdefs.h>\r
 \r
 #define _ISO646_H\r
 #include  <sys/EfiCdefs.h>\r
 \r

-#define and     &&\r
-#define and_eq  &=\r
-#define bitand  &\r
-#define bitor   |\r
-#define compl   ~\r
-#define not     !\r
-#define not_eq  !=\r
-#define or      ||\r
-#define or_eq   |=\r
-#define xor     ^\r
-#define xor_eq  ^=\r
+#define and     &&    ///< Logical AND of two boolean expressions\r
+#define and_eq  &=    ///< Bitwise AND with assignment to lval\r
+#define bitand  &     ///< Bitwise AND of two scalar expressions\r
+#define bitor   |     ///< Bitwise OR of two scalar expressions\r
+#define compl   ~     ///< Binary complement\r
+#define not     !     ///< Logical complement of a boolean expression\r
+#define not_eq  !=    ///< Not-equal comparison\r
+#define or      ||    ///< Logical OR of two boolean expressions\r
+#define or_eq   |=    ///< Bitwise OR with assignment to lval\r
+#define xor     ^     ///< Exclusive OR\r
+#define xor_eq  ^=    ///< Exclusive OR with assignment to lval\r

 \r
 #endif  /* _ISO646_H */\r
 \r
 #endif  /* _ISO646_H */\r

diff --git a/StdLib/Include/limits.h b/StdLib/Include/limits.h
index c0e60fe007ed561f5eb318de0261611947eb8c7c..4fceca201590801e059c63fe944a0189209cba59 100644 (file)
--- a/StdLib/Include/limits.h
+++ b/StdLib/Include/limits.h
@@ -2,30 +2,20 @@
   The header <limits.h> defines several macros that expand to various limits and\r
   parameters of the standard integer types.\r
 \r
   The header <limits.h> defines several macros that expand to various limits and\r
   parameters of the standard integer types.\r
 \r

-  The values given below shall be replaced by constant expressions suitable for\r
-  use in #if preprocessing directives. Moreover, except for CHAR_BIT and\r
-  MB_LEN_MAX, the following shall be replaced by expressions that have the same\r
+  The values given below are constant expressions suitable for\r
+  use in #if preprocessing directives. Except for CHAR_BIT and\r
+  MB_LEN_MAX, they have the same\r

   type as would an expression that is an object of the corresponding type\r
   type as would an expression that is an object of the corresponding type\r

-  converted according to the integer promotions. Their implementation-defined\r
-  values shall be equal or greater in magnitude (absolute value) to those\r
-  documented, with the same sign.\r
-\r
-  If the value of an object of type char is treated as a signed integer when\r
-  used in an expression, the value of CHAR_MIN shall be the same as that of\r
-  SCHAR_MIN and the value of CHAR_MAX shall be the same as that of SCHAR_MAX.\r
-  Otherwise, the value of CHAR_MIN shall be 0 and the value of CHAR_MAX shall\r
-  be the same as that of UCHAR_MAX.)\r
-  The value UCHAR_MAX shall equal 2^(CHAR_BIT - 1).\r
-\r
-  Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>\r
+  converted according to the integer promotions.\r
+\r
+  Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>\r

   This program and the accompanying materials are licensed and made available under\r
   the terms and conditions of the BSD License that accompanies this distribution.\r
   The full text of the license may be found at\r
   This program and the accompanying materials are licensed and made available under\r
   the terms and conditions of the BSD License that accompanies this distribution.\r
   The full text of the license may be found at\r

-  http://opensource.org/licenses/bsd-license.php.\r
+  http://opensource.org/licenses/bsd-license.\r

 \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
   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 _LIMITS_H\r
 #define _LIMITS_H\r
 **/\r
 #ifndef _LIMITS_H\r
 #define _LIMITS_H\r


@@ -35,86 +25,91 @@
 /* Get the architecturally defined limits for this compilation unit. */\r
 #include  <machine/limits.h>\r
 \r
 /* Get the architecturally defined limits for this compilation unit. */\r
 #include  <machine/limits.h>\r
 \r

-/* Define the values required by Specification. */\r
+/* Define the values required by the ISO/IEC 9899 Specification. */\r

 \r
 \r

-/** maximum number of bytes in a multibyte character, for any supported locale **/\r
-#define MB_LEN_MAX  2 /* 16-bit UTC-2 */\r
+/** Maximum number of bytes in a multibyte character, for any supported locale. **/\r
+#define MB_LEN_MAX  2               /* 16-bit UTC-2 */\r

 \r
 \r

-/** Number of bits for smallest object that is not a bit-field (byte). **/\r
+/** Number of bits comprising the smallest object that is not a bit-field (byte). **/\r

 #define CHAR_BIT    __CHAR_BIT\r
 \r
 #define CHAR_BIT    __CHAR_BIT\r
 \r

-/** minimum value for an object of type signed char **/\r
+/** Minimum value for an object of type signed char. **/\r

 #define SCHAR_MIN   __SCHAR_MIN\r
 \r
 #define SCHAR_MIN   __SCHAR_MIN\r
 \r

-/** maximum value for an object of type signed char **/\r
+/** Maximum value for an object of type signed char. **/\r

 #define SCHAR_MAX   __SCHAR_MAX\r
 \r
 #define SCHAR_MAX   __SCHAR_MAX\r
 \r

-/** maximum value for an object of type unsigned char **/\r
+/** Maximum value for an object of type unsigned char. **/\r

 #define UCHAR_MAX   __UCHAR_MAX\r
 \r
 #ifdef __CHAR_UNSIGNED__\r
 #define UCHAR_MAX   __UCHAR_MAX\r
 \r
 #ifdef __CHAR_UNSIGNED__\r

-  /** maximum value for an object of type char **/\r
+  /** Maximum value for an object of type char. **/\r

   #define CHAR_MAX  UCHAR_MAX\r
   #define CHAR_MAX  UCHAR_MAX\r

-  /** minimum value for an object of type char **/\r
+  /** Minimum value for an object of type char. **/\r

   #define CHAR_MIN  0\r
 #else\r
   #define CHAR_MIN  0\r
 #else\r

-  /** maximum value for an object of type char **/\r
+  /** Maximum value for an object of type char. **/\r

   #define CHAR_MAX  SCHAR_MAX\r
   #define CHAR_MAX  SCHAR_MAX\r

-  /** minimum value for an object of type char **/\r
+  /** Minimum value for an object of type char. **/\r

   #define CHAR_MIN  SCHAR_MIN\r
 #endif\r
 \r
   #define CHAR_MIN  SCHAR_MIN\r
 #endif\r
 \r

-/** minimum value for an object of type short int **/\r
+/** Minimum value for an object of type short int. **/\r

 #define SHRT_MIN    __SHRT_MIN\r
 \r
 #define SHRT_MIN    __SHRT_MIN\r
 \r

-/** maximum value for an object of type short int **/\r
+/** Maximum value for an object of type short int. **/\r

 #define SHRT_MAX    __SHRT_MAX\r
 \r
 #define SHRT_MAX    __SHRT_MAX\r
 \r

-/** maximum value for an object of type unsigned short int **/\r
+/** Maximum value for an object of type unsigned short int. **/\r

 #define USHRT_MAX   __USHRT_MAX\r
 \r
 #define USHRT_MAX   __USHRT_MAX\r
 \r

-/** minimum value for an object of type int **/\r
+/** Minimum value for an object of type int. **/\r

 #define INT_MIN     __INT_MIN\r
 \r
 #define INT_MIN     __INT_MIN\r
 \r

-/** maximum value for an object of type int **/\r
+/** Maximum value for an object of type int. **/\r

 #define INT_MAX     __INT_MAX\r
 \r
 #define INT_MAX     __INT_MAX\r
 \r

-/** maximum value for an object of type unsigned int **/\r
+/** Maximum value for an object of type unsigned int. **/\r

 #define UINT_MAX    __UINT_MAX\r
 \r
 #define UINT_MAX    __UINT_MAX\r
 \r

-/** minimum value for an object of type long int **/\r
+/** Minimum value for an object of type long int. **/\r

 #define LONG_MIN    __LONG_MIN\r
 \r
 #define LONG_MIN    __LONG_MIN\r
 \r

-/** maximum value for an object of type long int **/\r
+/** Maximum value for an object of type long int. **/\r

 #define LONG_MAX    __LONG_MAX\r
 \r
 #define LONG_MAX    __LONG_MAX\r
 \r

-/** maximum value for an object of type unsigned long int **/\r
+/** Maximum value for an object of type unsigned long int. **/\r

 #define ULONG_MAX   __ULONG_MAX\r
 \r
 #define ULONG_MAX   __ULONG_MAX\r
 \r

-/** minimum value for an object of type long long int **/\r
+/** Minimum value for an object of type long long int. **/\r

 #define LLONG_MIN   __LLONG_MIN\r
 \r
 #define LLONG_MIN   __LLONG_MIN\r
 \r

-/** maximum value for an object of type long long int **/\r
+/** Maximum value for an object of type long long int. **/\r

 #define LLONG_MAX   __LLONG_MAX\r
 \r
 #define LLONG_MAX   __LLONG_MAX\r
 \r

-/** maximum value for an object of type unsigned long long int **/\r
+/** Maximum value for an object of type unsigned long long int. **/\r

 #define ULLONG_MAX  __ULLONG_MAX\r
 \r
 /* Object limits used in the Standard Libraries */\r
 #if (PcdGet32(PcdMaximumAsciiStringLength) > 0)\r
 #define ULLONG_MAX  __ULLONG_MAX\r
 \r
 /* Object limits used in the Standard Libraries */\r
 #if (PcdGet32(PcdMaximumAsciiStringLength) > 0)\r

+  /** Maximum length of an arbitrary "narrow-character" string. **/\r

   #define ASCII_STRING_MAX    PcdGet32(PcdMaximumAsciiStringLength)\r
 #else\r
   #define ASCII_STRING_MAX    PcdGet32(PcdMaximumAsciiStringLength)\r
 #else\r

+  /** Maximum length of an arbitrary "narrow-character" string. **/\r

   #define ASCII_STRING_MAX    256\r
 #endif\r
 \r
 #if (PcdGet32(PcdMaximumUnicodeStringLength) > 0)\r
   #define ASCII_STRING_MAX    256\r
 #endif\r
 \r
 #if (PcdGet32(PcdMaximumUnicodeStringLength) > 0)\r

+  /** Maximum length of an arbitrary "wide-character" string. **/\r

   #define UNICODE_STRING_MAX    PcdGet32(PcdMaximumUnicodeStringLength)\r
 #else\r
   #define UNICODE_STRING_MAX    PcdGet32(PcdMaximumUnicodeStringLength)\r
 #else\r

+  /** Maximum length of an arbitrary "wide-character" string. **/\r

   #define UNICODE_STRING_MAX    512\r
 #endif\r
 \r
 /* Limits for BSD Compatibility */\r
 #define NL_TEXTMAX    2048\r
   #define UNICODE_STRING_MAX    512\r
 #endif\r
 \r
 /* Limits for BSD Compatibility */\r
 #define NL_TEXTMAX    2048\r

+\r

 #include  <sys/syslimits.h>\r
 \r
 #endif  /* _LIMITS_H */\r
 #include  <sys/syslimits.h>\r
 \r
 #endif  /* _LIMITS_H */\r

diff --git a/StdLib/Include/locale.h b/StdLib/Include/locale.h
index 220f35a0438520a50bb48c55df1778b6c68d168c..73a6bf4ca773897a9f948f4c47d8bebacbf9c074 100644 (file)
--- a/StdLib/Include/locale.h
+++ b/StdLib/Include/locale.h
@@ -1,6 +1,15 @@
-/*  $NetBSD: locale.h,v 1.14 2005/02/03 04:39:32 perry Exp $  */\r
+/** @file\r
+  Localization functions and macros.\r
+\r
+  Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials are licensed and made available under\r
+  the terms and conditions of the BSD License that accompanies this distribution.\r
+  The full text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.\r
+\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

-/*\r

  * Copyright (c) 1991, 1993\r
  *  The Regents of the University of California.  All rights reserved.\r
  *\r
  * Copyright (c) 1991, 1993\r
  *  The Regents of the University of California.  All rights reserved.\r
  *\r


@@ -29,11 +38,15 @@
  * SUCH DAMAGE.\r
  *\r
  *  @(#)locale.h  8.1 (Berkeley) 6/2/93\r
  * SUCH DAMAGE.\r
  *\r
  *  @(#)locale.h  8.1 (Berkeley) 6/2/93\r

- */\r
+ *  $NetBSD: locale.h,v 1.14 2005/02/03 04:39:32 perry Exp\r
+**/\r

 \r
 #ifndef _LOCALE_H_\r
 #define _LOCALE_H_\r
 \r
 \r
 #ifndef _LOCALE_H_\r
 #define _LOCALE_H_\r
 \r

+/** This is a structure containing members pertaining to the formatting of numeric values.\r
+    There is no requirement for members of this structure to be in any particular order.\r
+**/\r

 struct lconv {\r
   char  *decimal_point;\r
   char  *thousands_sep;\r
 struct lconv {\r
   char  *decimal_point;\r
   char  *thousands_sep;\r


@@ -61,27 +74,42 @@ struct lconv {
   char  int_n_sign_posn;\r
 };\r
 \r
   char  int_n_sign_posn;\r
 };\r
 \r

-#define LC_ALL      0\r
-#define LC_COLLATE  1\r
-#define LC_CTYPE    2\r
-#define LC_MONETARY 3\r
-#define LC_NUMERIC  4\r
-#define LC_TIME     5\r
-#define LC_MESSAGES 6\r
+/** These macros expand to integer expressions suitable for use as the first\r
+    argument to the setlocale() function.\r

 \r
 \r

-#define _LC_LAST    7   /* marks end */\r
+    Only the first six macros are required by the C language specification.\r
+    Implementations are free to extend this list, as has been done with LC_MESSAGES,\r
+    with additional macro definitions, beginning with the characters LC_ and\r
+    an uppercase letter.\r
+@{\r
+**/\r
+#define LC_ALL      0   ///< The application's entire locale.\r
+#define LC_COLLATE  1   ///< Affects the behavior of the strcoll and strxfrm functions.\r
+#define LC_CTYPE    2   ///< Affects the behavior of the character handling, multibyte, and wide character functions.\r
+#define LC_MONETARY 3   ///< Affects monetary formatting information.\r
+#define LC_NUMERIC  4   ///< Affects the decimal-point character and non-monetary formatting information.\r
+#define LC_TIME     5   ///< Affects the behavior of the strftime and wcsftime functions.\r
+#define LC_MESSAGES 6\r
+#define _LC_LAST    7   ///< Number of defined macros. Marks end.\r
+/// @}\r

 \r
 #include  <sys/EfiCdefs.h>\r
 \r
 \r
 #include  <sys/EfiCdefs.h>\r
 \r

+/** @fn   char *setlocale(int, const char *)\r
+**/\r
+\r
+/** @fn   struct lconv *localeconv(void)\r
+**/\r
+\r

 __BEGIN_DECLS\r
 __BEGIN_DECLS\r

-struct lconv  *localeconv(void);\r
-  char    *__setlocale_mb_len_max_32(int, const char *);\r

 #ifdef __SETLOCALE_SOURCE__\r
   char    *setlocale(int, const char *);\r
   char    *__setlocale(int, const char *);\r
 #else /* !__SETLOCALE_SOURCE__ */\r
   char    *setlocale(int, const char *) __RENAME(__setlocale_mb_len_max_32);\r
 #endif /* !__SETLOCALE_SOURCE__ */\r
 #ifdef __SETLOCALE_SOURCE__\r
   char    *setlocale(int, const char *);\r
   char    *__setlocale(int, const char *);\r
 #else /* !__SETLOCALE_SOURCE__ */\r
   char    *setlocale(int, const char *) __RENAME(__setlocale_mb_len_max_32);\r
 #endif /* !__SETLOCALE_SOURCE__ */\r

+struct lconv  *localeconv(void);\r
+  char    *__setlocale_mb_len_max_32(int, const char *);\r

 __END_DECLS\r
 \r
 #endif /* _LOCALE_H_ */\r
 __END_DECLS\r
 \r
 #endif /* _LOCALE_H_ */\r

diff --git a/StdLib/Include/sys/syslimits.h b/StdLib/Include/sys/syslimits.h
index d308387f2a81273c0bfb4a63d388506d2c0d3091..bee810cc12bf5fc1f085913a3936c9961bfe7c59 100644 (file)
--- a/StdLib/Include/sys/syslimits.h
+++ b/StdLib/Include/sys/syslimits.h
@@ -1,6 +1,15 @@
-/*  $NetBSD: syslimits.h,v 1.23 2005/12/11 12:25:21 christos Exp $  */\r
+/** @file\r
+  Platform specific values for <limits.h>.\r
+\r
+  Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials are licensed and made available under\r
+  the terms and conditions of the BSD License that accompanies this distribution.\r
+  The full text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.\r
+\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

-/*\r

  * Copyright (c) 1988, 1993\r
  *  The Regents of the University of California.  All rights reserved.\r
  *\r
  * Copyright (c) 1988, 1993\r
  *  The Regents of the University of California.  All rights reserved.\r
  *\r


@@ -28,28 +37,30 @@
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF\r
  * SUCH DAMAGE.\r
  *\r
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF\r
  * SUCH DAMAGE.\r
  *\r

- *  @(#)syslimits.h 8.1 (Berkeley) 6/2/93\r
- */\r
+ *  syslimits.h 8.1 (Berkeley) 6/2/93\r
+ *  NetBSD: syslimits.h,v 1.23 2005/12/11 12:25:21 christos Exp\r
+**/\r

 \r
 #ifndef _SYS_SYSLIMITS_H_\r
 #define _SYS_SYSLIMITS_H_\r
 \r
 #include <sys/featuretest.h>\r
 \r
 \r
 #ifndef _SYS_SYSLIMITS_H_\r
 #define _SYS_SYSLIMITS_H_\r
 \r
 #include <sys/featuretest.h>\r
 \r

-#define ARG_MAX    (2 * 1024) /* max bytes for an exec function */\r
-#define ARGC_MAX       (64)   /* Maximum value for argc */\r
+#define ARG_MAX     (2 * 1024)  ///< Maximum bytes for an exec function.\r
+#define ARGC_MAX          (64)  ///< Maximum value for argc.\r

 \r
 \r

-#ifndef CHILD_MAX\r
-  #define CHILD_MAX     128 /* max simultaneous processes */\r
-#endif\r
-#define MAX_INPUT     255 /* max bytes in terminal input */\r
-#define NAME_MAX      255 /* max bytes in a file name */\r
+#define MAX_INPUT         255   ///< Maximum bytes in terminal input.\r
+#define NAME_MAX          255   ///< Maximum bytes in a file name.\r

 #ifndef OPEN_MAX\r
 #ifndef OPEN_MAX\r

-  #define OPEN_MAX       20 /* max open files per process */\r
+  #define OPEN_MAX         20   ///< Maximum open files per process.\r
+#endif\r
+#define PATH_MAX         1024   ///< Maximum bytes in pathname.\r
+#define PIPE_BUF          512   ///< Maximum bytes for atomic pipe writes.\r
+\r
+#ifndef CHILD_MAX\r
+  #define CHILD_MAX       128   ///< Maximum simultaneous processes.\r

 #endif\r
 #endif\r

-#define PATH_MAX     1024 /* max bytes in pathname */\r
-#define PIPE_BUF      512 /* max bytes for atomic pipe writes */\r

 \r
 \r

-#define LOGIN_NAME_MAX       17 /* max login name length incl. NUL */\r
+#define LOGIN_NAME_MAX     17   ///< Maximum login name length including the NUL.\r

 \r
 #endif /* !_SYS_SYSLIMITS_H_ */\r
 \r
 #endif /* !_SYS_SYSLIMITS_H_ */\r

diff --git a/StdLib/Include/x86/limits.h b/StdLib/Include/x86/limits.h
index 08222fa2d6b813e020b607a1da962e7ef41e293b..b5339c2fdc9f25868903b6964ca5e8f8637cd938 100644 (file)
--- a/StdLib/Include/x86/limits.h
+++ b/StdLib/Include/x86/limits.h
@@ -1,14 +1,14 @@
 /** @file\r
 /** @file\r

-  Machine specific values for <limits.h>.\r
+  Intel x86 architecture (both Ia32 and X64) specific values for <limits.h>.\r

 \r
   Within this file, the ^ character is used in comments to represent exponentiation.\r
   Thus, 2^7 means "2 to the 7th power", NOT "2 XOR 7".\r
 \r
 \r
   Within this file, the ^ character is used in comments to represent exponentiation.\r
   Thus, 2^7 means "2 to the 7th power", NOT "2 XOR 7".\r
 \r

-  Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>\r

   This program and the accompanying materials are licensed and made available under\r
   the terms and conditions of the BSD License that accompanies this distribution.\r
   The full text of the license may be found at\r
   This program and the accompanying materials are licensed and made available under\r
   the terms and conditions of the BSD License that accompanies this distribution.\r
   The full text of the license may be found at\r

-  http://opensource.org/licenses/bsd-license.php.\r
+  http://opensource.org/licenses/bsd-license.\r

 \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
   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


@@ -19,49 +19,49 @@
 /** Number of bits for smallest object that is not a bit-field (byte). **/\r
 #define __CHAR_BIT    8\r
 \r
 /** Number of bits for smallest object that is not a bit-field (byte). **/\r
 #define __CHAR_BIT    8\r
 \r

-/** minimum value for an object of type signed char **/\r
+/** Minimum value for an object of type signed char. **/\r

 #define __SCHAR_MIN   -128 // -(2^7 - 1)\r
 \r
 #define __SCHAR_MIN   -128 // -(2^7 - 1)\r
 \r

-/** maximum value for an object of type signed char **/\r
+/** Maximum value for an object of type signed char. **/\r

 #define __SCHAR_MAX   +127 // 2^7 - 1\r
 \r
 #define __SCHAR_MAX   +127 // 2^7 - 1\r
 \r

-/** maximum value for an object of type unsigned char **/\r
+/** Maximum value for an object of type unsigned char. **/\r

 #define __UCHAR_MAX   255  // 2^8 - 1\r
 \r
 #define __UCHAR_MAX   255  // 2^8 - 1\r
 \r

-/** minimum value for an object of type short int **/\r
+/** Minimum value for an object of type short int. **/\r

 #define __SHRT_MIN    -32768 // -(2^15 - 1)\r
 \r
 #define __SHRT_MIN    -32768 // -(2^15 - 1)\r
 \r

-/** maximum value for an object of type short int **/\r
+/** Maximum value for an object of type short int. **/\r

 #define __SHRT_MAX    +32767 // 2^15 - 1\r
 \r
 #define __SHRT_MAX    +32767 // 2^15 - 1\r
 \r

-/** maximum value for an object of type unsigned short int **/\r
+/** Maximum value for an object of type unsigned short int. **/\r

 #define __USHRT_MAX   65535 // 2^16 - 1\r
 \r
 #define __USHRT_MAX   65535 // 2^16 - 1\r
 \r

-/** maximum value for an object of type int **/\r
+/** Maximum value for an object of type int. **/\r

 #define __INT_MAX     +2147483647 // 2^31 - 1\r
 \r
 #define __INT_MAX     +2147483647 // 2^31 - 1\r
 \r

-/** minimum value for an object of type int **/\r
+/** Minimum value for an object of type int. **/\r

 #define __INT_MIN     (-2147483647 - 1) // -(2^31 - 1)\r
 \r
 #define __INT_MIN     (-2147483647 - 1) // -(2^31 - 1)\r
 \r

-/** maximum value for an object of type unsigned int **/\r
+/** Maximum value for an object of type unsigned int. **/\r

 #define __UINT_MAX    0xffffffff // 2^32 - 1\r
 \r
 #define __UINT_MAX    0xffffffff // 2^32 - 1\r
 \r

-/** minimum value for an object of type long long int **/\r
-//#define __LLONG_MIN   -9223372036854775808LL // -(2^63 - 1)\r
-//#define __LLONG_MIN   ((-9223372036854775807LL)-1) // -(2^63 - 1)\r
-#define __LLONG_MIN   (-9223372036854775807LL - 1LL) // -(2^63 - 1)\r
+/** Minimum value for an object of type long long int. **/\r
+#define __LLONG_MIN   (-9223372036854775807LL - 1LL)  // -(2^63 - 1)\r

 \r
 \r

-/** maximum value for an object of type long long int **/\r
+/** Maximum value for an object of type long long int. **/\r

 #define __LLONG_MAX   9223372036854775807LL // 2^63 - 1\r
 \r
 #define __LLONG_MAX   9223372036854775807LL // 2^63 - 1\r
 \r

-/** maximum value for an object of type unsigned long long int **/\r
-//#define __ULLONG_MAX  18446744073709551615ULL // 2^64 - 1\r
+/** Maximum value for an object of type unsigned long long int. **/\r

 #define __ULLONG_MAX  0xFFFFFFFFFFFFFFFFULL // 2^64 - 1\r
 \r
 #define __ULLONG_MAX  0xFFFFFFFFFFFFFFFFULL // 2^64 - 1\r
 \r

-/* Intel extensions to <limits.h> for UEFI */\r
-#define __SHORT_BIT     16\r
-#define __WCHAR_BIT     16\r
-#define __INT_BIT       32\r
-#define __LONG_LONG_BIT 64\r
+/** Intel extensions to <limits.h> for UEFI\r
+@{\r
+**/\r
+#define __SHORT_BIT     16    ///< Number of bits comprising a short int.\r
+#define __WCHAR_BIT     16    ///< Number of bits comprising a wide character.\r
+#define __INT_BIT       32    ///< Number of bits comprising an int.\r
+#define __LONG_LONG_BIT 64    ///< Number of bits comprising a long long int.\r
+/// @}\r

 \r
 #endif    /* _MACHINE_LIMITS_H */\r
 \r
 #endif    /* _MACHINE_LIMITS_H */\r

diff --git a/StdLib/LibC/Locale/setlocale.c b/StdLib/LibC/Locale/setlocale.c
index b6090d2ea0ab994b051bdbef89e3a5d25b07aaae..4d617d21da8f50ec9bab9a12aaf616b8630d5560 100644 (file)
--- a/StdLib/LibC/Locale/setlocale.c
+++ b/StdLib/LibC/Locale/setlocale.c
@@ -1,6 +1,15 @@
-/*  $NetBSD: setlocale.c,v 1.50 2006/02/16 19:19:49 tnozaki Exp $ */\r
+/** @file\r
+  Worker functions for the setlocale function.\r
+\r
+  Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials are licensed and made available under\r
+  the terms and conditions of the BSD License that accompanies this distribution.\r
+  The full text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.\r
+\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

-/*\r

  * Copyright (c) 1991, 1993\r
  *  The Regents of the University of California.  All rights reserved.\r
  *\r
  * Copyright (c) 1991, 1993\r
  *  The Regents of the University of California.  All rights reserved.\r
  *\r


@@ -30,16 +39,12 @@
  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY\r
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF\r
  * SUCH DAMAGE.\r
  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY\r
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF\r
  * SUCH DAMAGE.\r

- */\r
+\r
+    setlocale.c 8.1 (Berkeley) 7/4/93\r
+ *  NetBSD: setlocale.c,v 1.50 2006/02/16 19:19:49 tnozaki Exp\r
+**/\r

 #include  <LibConfig.h>\r
 #include  <sys/EfiCdefs.h>\r
 #include  <LibConfig.h>\r
 #include  <sys/EfiCdefs.h>\r

-#if defined(LIBC_SCCS) && !defined(lint)\r
-  #if 0\r
-    static char sccsid[] = "@(#)setlocale.c 8.1 (Berkeley) 7/4/93";\r
-  #else\r
-    __RCSID("$NetBSD: setlocale.c,v 1.50 2006/02/16 19:19:49 tnozaki Exp $");\r
-  #endif\r
-#endif /* LIBC_SCCS and not lint */\r

 \r
 #if defined(_MSC_VER)\r
   // Disable warnings about assignment within conditional expressions.\r
 \r
 #if defined(_MSC_VER)\r
   // Disable warnings about assignment within conditional expressions.\r


@@ -86,9 +91,7 @@
   const char *_PathLocale = NULL;\r
 #endif\r
 \r
   const char *_PathLocale = NULL;\r
 #endif\r
 \r

-/*\r
- * Category names for getenv()\r
- */\r
+/** Category names for getenv(). **/\r

 static const char *const categories[_LC_LAST] = {\r
     "LC_ALL",\r
     "LC_COLLATE",\r
 static const char *const categories[_LC_LAST] = {\r
     "LC_ALL",\r
     "LC_COLLATE",\r


@@ -99,9 +102,7 @@ static const char *const categories[_LC_LAST] = {
     "LC_MESSAGES"\r
 };\r
 \r
     "LC_MESSAGES"\r
 };\r
 \r

-/*\r
- * Current locales for each category\r
- */\r
+/** Current locales for each category.  **/\r

 static char current_categories[_LC_LAST][32] = {\r
     "C",\r
     "C",\r
 static char current_categories[_LC_LAST][32] = {\r
     "C",\r
     "C",\r

diff --git a/StdLib/LibC/Locale/setlocale1.c b/StdLib/LibC/Locale/setlocale1.c
index b9c30bb40d3ebdbec9ace66fad8b64a334395305..e315ec8ab03c36be6c3dbc365931b828b9a301b1 100644 (file)
--- a/StdLib/LibC/Locale/setlocale1.c
+++ b/StdLib/LibC/Locale/setlocale1.c
@@ -1,6 +1,15 @@
-/*  $NetBSD: setlocale1.c,v 1.2 2003/03/11 17:23:07 tshiozak Exp $  */\r
+/** @file\r
+  Single-byte character version of the setlocale function.\r
+\r
+  Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials are licensed and made available under\r
+  the terms and conditions of the BSD License that accompanies this distribution.\r
+  The full text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.\r
+\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

-/*-\r

  * Copyright (c)1999 Citrus Project,\r
  * All rights reserved.\r
  *\r
  * Copyright (c)1999 Citrus Project,\r
  * All rights reserved.\r
  *\r


@@ -24,12 +33,11 @@
  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY\r
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF\r
  * SUCH DAMAGE.\r
  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY\r
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF\r
  * SUCH DAMAGE.\r

- */\r
+\r
+ *  NetBSD: setlocale1.c,v 1.2 2003/03/11 17:23:07 tshiozak Exp\r
+**/\r

 #include  <LibConfig.h>\r
 #include  <sys/EfiCdefs.h>\r
 #include  <LibConfig.h>\r
 #include  <sys/EfiCdefs.h>\r

-#if defined(LIBC_SCCS) && !defined(lint)\r
-__RCSID("$NetBSD: setlocale1.c,v 1.2 2003/03/11 17:23:07 tshiozak Exp $");\r
-#endif /* LIBC_SCCS and not lint */\r

 \r
 #include "namespace.h"\r
 #define __SETLOCALE_SOURCE__\r
 \r
 #include "namespace.h"\r
 #define __SETLOCALE_SOURCE__\r