RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

libmisc: Doxygen Enhancement Task #2

Browse Source 
http://www.google-melange.com/gci/task/view/google/gci2012/7959228
This commit is contained in:
Mathew Kallada
2012-12-19 09:51:38 -05:00
committed by Gedare Bloom
parent 9889d51724
commit 148e3de629
10 changed files with 80 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
cpukit/libmisc/stringto/stringto.h
View File

@@ -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
/**@}*/

9
cpukit/libmisc/stringto/stringtodouble.c
View File

@@ -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;

9
cpukit/libmisc/stringto/stringtoint.c
View File

@@ -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;

9
cpukit/libmisc/stringto/stringtolong.c
View File

@@ -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;

9
cpukit/libmisc/stringto/stringtolonglong.c
View File

@@ -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;

7
cpukit/libmisc/stringto/stringtopointer.c
View File

@@ -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).

9
cpukit/libmisc/stringto/stringtounsignedint.c
View File

@@ -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;

9
cpukit/libmisc/stringto/stringtounsignedlong.c
View File

@@ -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;

13
cpukit/libmisc/untar/untar.c
View File

@@ -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 */

8
cpukit/libmisc/untar/untar.h
View File

@@ -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 */