libmisc: Doxygen Enhancement Task #2

http://www.google-melange.com/gci/task/view/google/gci2012/7959228

10 files changed, 80 insertions, 9 deletions

diff --git a/cpukit/libmisc/stringto/stringto.h b/cpukit/libmisc/stringto/stringto.h
index c8ed6b49ef..d4611518c7 100644
--- a/cpukit/libmisc/stringto/stringto.h
+++ b/cpukit/libmisc/stringto/stringto.h
@@ -15,6 +15,12 @@
 
 #ifndef _RTEMS_STRINGTO_H
 #define _RTEMS_STRINGTO_H
+/**
+ *  @defgroup libmisc_conv_help Conversion Helpers
+ *
+ *  @ingroup libmisc
+ */
+/**@{*/
 
 #include <rtems.h>
 
@@ -248,3 +254,4 @@ rtems_status_code rtems_string_to_long_double(
 );
 
 #endif
+/**@}*/
\ No newline at end of file
diff --git a/cpukit/libmisc/stringto/stringtodouble.c b/cpukit/libmisc/stringto/stringtodouble.c
index 4ef94ab435..09605ce528 100644
--- a/cpukit/libmisc/stringto/stringtodouble.c
+++ b/cpukit/libmisc/stringto/stringtodouble.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Convert String to Double (with validation)
+ * @ingroup libmisc_conv_help Conversion Helpers
+ */
+
 /*
  *  COPYRIGHT (c) 2009.
  *  On-Line Applications Research Corporation (OAR).
@@ -46,7 +53,7 @@ rtems_status_code rtems_string_to_double (
   if ( end == s )
     return RTEMS_NOT_DEFINED;
 
-  if ( ( errno == ERANGE ) && 
+  if ( ( errno == ERANGE ) &&
     (( result == 0 ) || ( result == HUGE_VAL ) || ( result == -HUGE_VAL )))
       return RTEMS_INVALID_NUMBER;
 
diff --git a/cpukit/libmisc/stringto/stringtoint.c b/cpukit/libmisc/stringto/stringtoint.c
index ee2e31f2f8..df3de2b39f 100644
--- a/cpukit/libmisc/stringto/stringtoint.c
+++ b/cpukit/libmisc/stringto/stringtoint.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Convert String to Int (with validation)
+ * @ingroup libmisc_conv_help Conversion Helpers
+ */
+
 /*
  *  COPYRIGHT (c) 2009.
  *  On-Line Applications Research Corporation (OAR).
@@ -47,7 +54,7 @@ rtems_status_code rtems_string_to_int (
   if ( end == s )
     return RTEMS_NOT_DEFINED;
 
-  if ( ( errno == ERANGE ) && 
+  if ( ( errno == ERANGE ) &&
     (( result == 0 ) || ( result == LONG_MAX ) || ( result == LONG_MIN )))
       return RTEMS_INVALID_NUMBER;
 
diff --git a/cpukit/libmisc/stringto/stringtolong.c b/cpukit/libmisc/stringto/stringtolong.c
index 15e7e4d747..ab830c5a83 100644
--- a/cpukit/libmisc/stringto/stringtolong.c
+++ b/cpukit/libmisc/stringto/stringtolong.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Convert String to Long (with validation)
+ * @ingroup libmisc_conv_help Conversion Helpers
+ */
+
 /*
  *  COPYRIGHT (c) 2009.
  *  On-Line Applications Research Corporation (OAR).
@@ -47,7 +54,7 @@ rtems_status_code rtems_string_to_long (
   if ( end == s )
     return RTEMS_NOT_DEFINED;
 
-  if ( ( errno == ERANGE ) && 
+  if ( ( errno == ERANGE ) &&
     (( result == 0 ) || ( result == LONG_MAX ) || ( result == LONG_MIN )))
       return RTEMS_INVALID_NUMBER;
 
diff --git a/cpukit/libmisc/stringto/stringtolonglong.c b/cpukit/libmisc/stringto/stringtolonglong.c
index 8f70f0e172..64df7cfeb1 100644
--- a/cpukit/libmisc/stringto/stringtolonglong.c
+++ b/cpukit/libmisc/stringto/stringtolonglong.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Convert String to Long Long (with validation)
+ * @ingroup libmisc_conv_help Conversion Helpers
+ */
+
 /*
  *  COPYRIGHT (c) 2009.
  *  On-Line Applications Research Corporation (OAR).
@@ -56,7 +63,7 @@ rtems_status_code rtems_string_to_long_long (
   if ( end == s )
     return RTEMS_NOT_DEFINED;
 
-  if ( ( errno == ERANGE ) && 
+  if ( ( errno == ERANGE ) &&
     (( result == 0 ) || ( result == LONG_LONG_MAX ) || ( result == LONG_LONG_MIN )))
       return RTEMS_INVALID_NUMBER;
 
diff --git a/cpukit/libmisc/stringto/stringtopointer.c b/cpukit/libmisc/stringto/stringtopointer.c
index 13e68475b9..6cf5bff08a 100644
--- a/cpukit/libmisc/stringto/stringtopointer.c
+++ b/cpukit/libmisc/stringto/stringtopointer.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Convert String to Pointer (with validation)
+ * @ingroup libmisc_conv_help Conversion Helpers
+ */
+
 /*
  *  COPYRIGHT (c) 2009.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/libmisc/stringto/stringtounsignedint.c b/cpukit/libmisc/stringto/stringtounsignedint.c
index b7a24be54d..53aaf10bf8 100644
--- a/cpukit/libmisc/stringto/stringtounsignedint.c
+++ b/cpukit/libmisc/stringto/stringtounsignedint.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Convert String to Unsigned Int (with validation)
+ * @ingroup libmisc_conv_help Conversion Helpers
+ */
+
 /*
  *  COPYRIGHT (c) 2009.
  *  On-Line Applications Research Corporation (OAR).
@@ -47,7 +54,7 @@ rtems_status_code rtems_string_to_unsigned_int (
   if ( end == s )
     return RTEMS_NOT_DEFINED;
 
-  if ( ( errno == ERANGE ) && 
+  if ( ( errno == ERANGE ) &&
     (( result == 0 ) || ( result == ULONG_MAX )))
       return RTEMS_INVALID_NUMBER;
 
diff --git a/cpukit/libmisc/stringto/stringtounsignedlong.c b/cpukit/libmisc/stringto/stringtounsignedlong.c
index 305f23f327..4e5ae94089 100644
--- a/cpukit/libmisc/stringto/stringtounsignedlong.c
+++ b/cpukit/libmisc/stringto/stringtounsignedlong.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Convert String to Unsigned Long Long (with validation)
+ * @ingroup libmisc_conv_help Conversion Helpers
+ */
+
 /*
  *  COPYRIGHT (c) 2009.
  *  On-Line Applications Research Corporation (OAR).
@@ -47,7 +54,7 @@ rtems_status_code rtems_string_to_unsigned_long (
   if ( end == s )
     return RTEMS_NOT_DEFINED;
 
-  if ( ( errno == ERANGE ) && 
+  if ( ( errno == ERANGE ) &&
     (( result == 0 ) || ( result == ULONG_MAX )))
       return RTEMS_INVALID_NUMBER;
 
diff --git a/cpukit/libmisc/untar/untar.c b/cpukit/libmisc/untar/untar.c
index 337782b5c1..5cebc2d9ed 100644
--- a/cpukit/libmisc/untar/untar.c
+++ b/cpukit/libmisc/untar/untar.c
@@ -1,8 +1,17 @@
-/* FIXME:
+/**
+ * @file
+ *
+ * @brief Untar an Image
+ * @ingroup libmisc_untar_img Untar Image
+ *
+ * FIXME:
  *   1. Symbolic links are not created.
  *   2. Untar_FromMemory uses FILE *fp.
  *   3. How to determine end of archive?
  *
+ */
+
+/*
  *  Written by: Jake Janovetz <janovetz@tempest.ece.uiuc.edu>
  *
  *  The license and distribution terms for this file may be
@@ -274,7 +283,7 @@ Untar_FromFile(
    if (bufr == NULL) {
       return(UNTAR_FAIL);
    }
-   
+
    while (1)
    {
       /* Read the header */
diff --git a/cpukit/libmisc/untar/untar.h b/cpukit/libmisc/untar/untar.h
index dca8216644..81cbd0e8ba 100644
--- a/cpukit/libmisc/untar/untar.h
+++ b/cpukit/libmisc/untar/untar.h
@@ -18,6 +18,12 @@
 #include <stddef.h>
 #include <tar.h>
 
+/**
+ *  @defgroup libmisc_untar_img Untar Image
+ *
+ *  @ingroup libmisc
+ */
+/**@{*/
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -49,5 +55,5 @@ _rtems_tar_header_checksum(const char *bufr);
 #ifdef __cplusplus
 }
 #endif
-
+/**@}*/
 #endif  /* _RTEMS_UNTAR_H */