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

[mirror_edk2.git] / StdLib / Include / x86 / limits.h

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
-  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
-  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
-  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
@@ -19,49 +19,49 @@
 /** 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
-/** 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
-/** 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
-/** 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
-/** 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
-/** 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
-/** 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
-/** 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
-/** 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
-/** 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
-/** 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
-/** 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
-/* 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