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

[mirror_edk2.git] / StdLib / LibC / Ctype / CConv.c

diff --git a/StdLib/LibC/Ctype/CConv.c b/StdLib/LibC/Ctype/CConv.c
index 6ad4f8722d9a2e3b7dee81c98bd389429f00626f..f551c433253f759f0176171d302b087c80255913 100644 (file)
--- a/StdLib/LibC/Ctype/CConv.c
+++ b/StdLib/LibC/Ctype/CConv.c
@@ -1,5 +1,5 @@
 /** @file\r
-  Case conversion functions for <ctype.h>\r
+  Case conversion function implementations for <ctype.h>\r
 \r
   The tolower function converts an uppercase letter to a corresponding\r
   lowercase letter.  If the argument is a character for which isupper\r
@@ -15,34 +15,56 @@
   of the corresponding characters (always the same one for any given locale);\r
   otherwise, the argument is returned unchanged.\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
-\r
 **/\r
 #include  <LibConfig.h>\r
 \r
 #define NO_CTYPE_MACROS            // So that we don't define the classification macros\r
 #include  <ctype.h>\r
 \r
+/** The tolower function converts an uppercase letter to a corresponding\r
+    lowercase letter.\r
+\r
+    @param[in]    c   The character to be converted.\r
+\r
+    @return   If the argument is a character for which isupper is true and\r
+              there are one or more corresponding characters, as specified by\r
+              the current locale, for which islower is true, the tolower\r
+              function returns one of the corresponding characters (always the\r
+              same one for any given locale); otherwise, the argument is\r
+              returned unchanged.\r
+**/\r
 int\r
 tolower(\r
-  int _c\r
+  IN  int _c\r
   )\r
 {\r
-//  return ((_c < 0 || _c > 127) ? _c : _lConvT[_c]);\r
   return (isupper(_c) ? _lConvT[_c] : _c);\r
 }\r
 \r
-int toupper(\r
-  int _c\r
+/** The toupper function converts a lowercase letter to a corresponding\r
+    uppercase letter.\r
+\r
+    @param[in]    c   The character to be converted.\r
+\r
+    @return   If the argument is a character for which islower is true and\r
+              there are one or more corresponding characters, as specified by\r
+              the current locale, for which isupper is true, the toupper\r
+              function returns one of the corresponding characters (always the\r
+              same one for any given locale); otherwise, the argument is\r
+              returned unchanged.\r
+**/\r
+int\r
+toupper(\r
+  IN  int _c\r
   )\r
 {\r
-//  return ((_c < 0 || _c > 127) ? _c : _uConvT[_c]);\r
   return (islower(_c) ? _uConvT[_c] : _c);\r
 }\r