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

[mirror_edk2.git] / StdLib / Include / locale.h

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
  * 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
- */\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
+/** 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
@@ -61,27 +74,42 @@ struct lconv {
   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
-#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
+/** @fn   char *setlocale(int, const char *)\r
+**/\r
+\r
+/** @fn   struct lconv *localeconv(void)\r
+**/\r
+\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
+struct lconv  *localeconv(void);\r
+  char    *__setlocale_mb_len_max_32(int, const char *);\r
 __END_DECLS\r
 \r
 #endif /* _LOCALE_H_ */\r