libmisc: Doxygen Enhancement Task #1

5 files changed, 43 insertions, 15 deletions

diff --git a/cpukit/libmisc/stringto/stringto.h b/cpukit/libmisc/stringto/stringto.h
index d4611518c7..f643949ed9 100644
--- a/cpukit/libmisc/stringto/stringto.h
+++ b/cpukit/libmisc/stringto/stringto.h
@@ -25,7 +25,7 @@
 #include <rtems.h>
 
 /**
- *  @brief Convert String to Pointer (with validation)
+ *  @brief Convert String to Pointer (with validation).
  *
  *  This method converts a string to a pointer (void *) with
  *  basic numeric validation.
@@ -45,7 +45,7 @@ rtems_status_code rtems_string_to_pointer(
 );
 
 /**
- *  @brief Convert String to Unsigned Character (with validation)
+ *  @brief Convert String to Unsigned Character (with validation).
  *
  *  This method converts a string to an unsigned character with
  *  range validation.
@@ -67,7 +67,7 @@ rtems_status_code rtems_string_to_unsigned_char(
 );
 
 /**
- *  @brief Convert String to Int (with validation)
+ *  @brief Convert String to Int (with validation).
  *
  *  This method converts a string to an int with range validation.
  *
@@ -88,7 +88,7 @@ rtems_status_code rtems_string_to_int(
 );
 
 /**
- *  @brief Convert String to Unsigned Int (with validation)
+ *  @brief Convert String to Unsigned Int (with validation).
  *
  *  This method converts a string to an unsigned int with range validation.
  *
@@ -109,7 +109,7 @@ rtems_status_code rtems_string_to_unsigned_int(
 );
 
 /**
- *  @brief Convert String to Long (with validation)
+ *  @brief Convert String to Long (with validation).
  *
  *  This method converts a string to a long with
  *  range validation.
@@ -131,7 +131,7 @@ rtems_status_code rtems_string_to_long(
 );
 
 /**
- *  @brief Convert String to Unsigned Long (with validation)
+ *  @brief Convert String to Unsigned Long (with validation).
  *
  *  This method converts a string to an unsigned long with
  *  range validation.
@@ -153,7 +153,7 @@ rtems_status_code rtems_string_to_unsigned_long(
 );
 
 /**
- *  @brief Convert String to Long Long (with validation)
+ *  @brief Convert String to Long Long (with validation).
  *
  *  This method converts a string to a long long with
  *  range validation.
@@ -175,7 +175,7 @@ rtems_status_code rtems_string_to_long_long(
 );
 
 /**
- *  @brief Convert String to Unsigned Long Long (with validation)
+ *  @brief Convert String to Unsigned Long Long (with validation).
  *
  *  This method converts a string to an unsigned character with
  *  range validation.
@@ -197,7 +197,7 @@ rtems_status_code rtems_string_to_unsigned_long_long(
 );
 
 /**
- *  @brief Convert String to Float (with validation)
+ *  @brief Convert String to Float (with validation).
  *
  *  This method converts a string to a float with range validation.
  *
@@ -216,7 +216,7 @@ rtems_status_code rtems_string_to_float(
 );
 
 /**
- *  @brief Convert String to Double (with validation)
+ *  @brief Convert String to Double (with validation).
  *
  *  This method converts a string to a double with range validation.
  *
@@ -235,7 +235,7 @@ rtems_status_code rtems_string_to_double(
 );
 
 /**
- *  @brief Convert String to long double (with validation)
+ *  @brief Convert String to long double (with validation).
  *
  *  This method converts a string to a long double with range validation.
  *
diff --git a/cpukit/libmisc/stringto/stringtofloat.c b/cpukit/libmisc/stringto/stringtofloat.c
index 1a3382bc1d..e9c398df3d 100644
--- a/cpukit/libmisc/stringto/stringtofloat.c
+++ b/cpukit/libmisc/stringto/stringtofloat.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Convert String to Float (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_float (
   if ( end == s )
     return RTEMS_NOT_DEFINED;
 
-  if ( ( errno == ERANGE ) && 
+  if ( ( errno == ERANGE ) &&
     (( result == 0 ) || ( result == HUGE_VALF ) || ( result == -HUGE_VALF )))
       return RTEMS_INVALID_NUMBER;
 
diff --git a/cpukit/libmisc/stringto/stringtolongdouble.c b/cpukit/libmisc/stringto/stringtolongdouble.c
index 3e7b6cfd26..f13b6f1890 100644
--- a/cpukit/libmisc/stringto/stringtolongdouble.c
+++ b/cpukit/libmisc/stringto/stringtolongdouble.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Convert String to long 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_long_double (
   if ( end == s )
     return RTEMS_NOT_DEFINED;
 
-  if ( ( errno == ERANGE ) && 
+  if ( ( errno == ERANGE ) &&
     (( result == 0 ) || ( result == HUGE_VALL ) || ( result == -HUGE_VALL )))
       return RTEMS_INVALID_NUMBER;
 
diff --git a/cpukit/libmisc/stringto/stringtounsignedchar.c b/cpukit/libmisc/stringto/stringtounsignedchar.c
index 384bc734da..b3f5877f9b 100644
--- a/cpukit/libmisc/stringto/stringtounsignedchar.c
+++ b/cpukit/libmisc/stringto/stringtounsignedchar.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Convert String to Unsigned Character (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_char (
   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/stringtounsignedlonglong.c b/cpukit/libmisc/stringto/stringtounsignedlonglong.c
index 7ef6500158..a2ad544d64 100644
--- a/cpukit/libmisc/stringto/stringtounsignedlonglong.c
+++ b/cpukit/libmisc/stringto/stringtounsignedlonglong.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).
@@ -52,7 +59,7 @@ rtems_status_code rtems_string_to_unsigned_long_long (
   if ( end == s )
     return RTEMS_NOT_DEFINED;
 
-  if ( ( errno == ERANGE ) && 
+  if ( ( errno == ERANGE ) &&
     (( result == 0 ) || ( result == ULONG_LONG_MAX )))
       return RTEMS_INVALID_NUMBER;