[rtems commit] libmisc: Doxygen Enhancement Task #2
Gedare Bloom
gedare at rtems.org
Wed Dec 19 14:47:11 UTC 2012
Module: rtems
Branch: master
Commit: 148e3de629fff11c7598ff178cb125ae3f8b5d12
Changeset: http://git.rtems.org/rtems/commit/?id=148e3de629fff11c7598ff178cb125ae3f8b5d12
Author: Mathew Kallada <matkallada at gmail.com>
Date: Wed Dec 19 09:51:38 2012 -0500
libmisc: Doxygen Enhancement Task #2
http://www.google-melange.com/gci/task/view/google/gci2012/7959228
---
cpukit/libmisc/stringto/stringto.h | 7 +++++++
cpukit/libmisc/stringto/stringtodouble.c | 9 ++++++++-
cpukit/libmisc/stringto/stringtoint.c | 9 ++++++++-
cpukit/libmisc/stringto/stringtolong.c | 9 ++++++++-
cpukit/libmisc/stringto/stringtolonglong.c | 9 ++++++++-
cpukit/libmisc/stringto/stringtopointer.c | 7 +++++++
cpukit/libmisc/stringto/stringtounsignedint.c | 9 ++++++++-
cpukit/libmisc/stringto/stringtounsignedlong.c | 9 ++++++++-
cpukit/libmisc/untar/untar.c | 13 +++++++++++--
cpukit/libmisc/untar/untar.h | 8 +++++++-
10 files changed, 80 insertions(+), 9 deletions(-)
diff --git a/cpukit/libmisc/stringto/stringto.h b/cpukit/libmisc/stringto/stringto.h
index c8ed6b4..d461151 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 4ef94ab..09605ce 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 ee2e31f..df3de2b 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 15e7e4d..ab830c5 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 8f70f0e..64df7cf 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 13e6847..6cf5bff 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 b7a24be..53aaf10 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 305f23f..4e5ae94 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 337782b..5cebc2d 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 at 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 dca8216..81cbd0e 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 */
More information about the vc
mailing list