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

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

2 files changed, 31 insertions, 22 deletions

diff --git a/edk2/StdLib/LibC/Locale/setlocale.c b/edk2/StdLib/LibC/Locale/setlocale.c
index b6090d2ea..4d617d21d 100644
--- a/edk2/StdLib/LibC/Locale/setlocale.c
+++ b/edk2/StdLib/LibC/Locale/setlocale.c
@@ -1,6 +1,15 @@
-/*  $NetBSD: setlocale.c,v 1.50 2006/02/16 19:19:49 tnozaki Exp $ */

+/** @file

+  Worker functions for the setlocale function.

+

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

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

+  the terms and conditions of the BSD License that accompanies this distribution.

+  The full text of the license may be found at

+  http://opensource.org/licenses/bsd-license.

+

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

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

 

-/*

  * Copyright (c) 1991, 1993

  *  The Regents of the University of California.  All rights reserved.

  *

@@ -30,16 +39,12 @@
  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY

  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

  * SUCH DAMAGE.

- */

+

+    setlocale.c 8.1 (Berkeley) 7/4/93

+ *  NetBSD: setlocale.c,v 1.50 2006/02/16 19:19:49 tnozaki Exp

+**/

 #include  <LibConfig.h>

 #include  <sys/EfiCdefs.h>

-#if defined(LIBC_SCCS) && !defined(lint)

-  #if 0

-    static char sccsid[] = "@(#)setlocale.c 8.1 (Berkeley) 7/4/93";

-  #else

-    __RCSID("$NetBSD: setlocale.c,v 1.50 2006/02/16 19:19:49 tnozaki Exp $");

-  #endif

-#endif /* LIBC_SCCS and not lint */

 

 #if defined(_MSC_VER)

   // Disable warnings about assignment within conditional expressions.

@@ -86,9 +91,7 @@
   const char *_PathLocale = NULL;

 #endif

 

-/*

- * Category names for getenv()

- */

+/** Category names for getenv(). **/

 static const char *const categories[_LC_LAST] = {

     "LC_ALL",

     "LC_COLLATE",

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

 };

 

-/*

- * Current locales for each category

- */

+/** Current locales for each category.  **/

 static char current_categories[_LC_LAST][32] = {

     "C",

     "C",

diff --git a/edk2/StdLib/LibC/Locale/setlocale1.c b/edk2/StdLib/LibC/Locale/setlocale1.c
index b9c30bb40..e315ec8ab 100644
--- a/edk2/StdLib/LibC/Locale/setlocale1.c
+++ b/edk2/StdLib/LibC/Locale/setlocale1.c
@@ -1,6 +1,15 @@
-/*  $NetBSD: setlocale1.c,v 1.2 2003/03/11 17:23:07 tshiozak Exp $  */

+/** @file

+  Single-byte character version of the setlocale function.

+

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

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

+  the terms and conditions of the BSD License that accompanies this distribution.

+  The full text of the license may be found at

+  http://opensource.org/licenses/bsd-license.

+

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

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

 

-/*-

  * Copyright (c)1999 Citrus Project,

  * All rights reserved.

  *

@@ -24,12 +33,11 @@
  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY

  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

  * SUCH DAMAGE.

- */

+

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

+**/

 #include  <LibConfig.h>

 #include  <sys/EfiCdefs.h>

-#if defined(LIBC_SCCS) && !defined(lint)

-__RCSID("$NetBSD: setlocale1.c,v 1.2 2003/03/11 17:23:07 tshiozak Exp $");

-#endif /* LIBC_SCCS and not lint */

 

 #include "namespace.h"

 #define __SETLOCALE_SOURCE__