From f5f267682478f7ccca40c9751ccc0dc01e76bd86 Mon Sep 17 00:00:00 2001 From: Mathew Kallada Date: Fri, 21 Dec 2012 11:13:06 -0600 Subject: libmisc: Doxygen Enhancement Task #1 --- cpukit/libmisc/bspcmdline/bspcmdline_get.c | 7 ++++ cpukit/libmisc/bspcmdline/bspcmdline_getparam.c | 7 ++++ cpukit/libmisc/bspcmdline/bspcmdline_getparamraw.c | 7 ++++ cpukit/libmisc/bspcmdline/bspcmdline_getparamrhs.c | 7 ++++ cpukit/libmisc/cpuuse/cpuusagedata.c | 11 ++++-- cpukit/libmisc/cpuuse/cpuusagereport.c | 9 +++-- cpukit/libmisc/cpuuse/cpuusagereset.c | 9 +++-- cpukit/libmisc/cpuuse/cpuuse.h | 20 ++++++++--- cpukit/libmisc/devnull/devnull.c | 10 ++++-- cpukit/libmisc/devnull/devnull.h | 8 ++++- cpukit/libmisc/devnull/devzero.c | 7 ++++ cpukit/libmisc/dumpbuf/dumpbuf.c | 7 ++++ cpukit/libmisc/dumpbuf/dumpbuf.h | 10 ++++-- cpukit/libmisc/fb/mw_print.c | 9 ++++- cpukit/libmisc/fb/mw_uid.c | 8 ++++- cpukit/libmisc/fb/mw_uid.h | 8 ++++- cpukit/libmisc/fsmount/fsmount.c | 40 +++++++++------------- cpukit/libmisc/fsmount/fsmount.h | 2 ++ cpukit/libmisc/mouse/mouse_parser.c | 11 ++++-- cpukit/libmisc/mouse/mouse_parser.h | 12 +++++-- cpukit/libmisc/mouse/serial_mouse.c | 9 ++++- cpukit/libmisc/mouse/serial_mouse.h | 23 ++++++++----- cpukit/libmisc/stackchk/check.c | 15 +++++--- cpukit/libmisc/stackchk/stackchk.h | 14 +++++--- cpukit/libmisc/stringto/stringto.h | 22 ++++++------ cpukit/libmisc/stringto/stringtofloat.c | 9 ++++- cpukit/libmisc/stringto/stringtolongdouble.c | 9 ++++- cpukit/libmisc/stringto/stringtounsignedchar.c | 9 ++++- cpukit/libmisc/stringto/stringtounsignedlonglong.c | 9 ++++- 29 files changed, 247 insertions(+), 81 deletions(-) diff --git a/cpukit/libmisc/bspcmdline/bspcmdline_get.c b/cpukit/libmisc/bspcmdline/bspcmdline_get.c index 5fda357c1e..c4ff6a01a2 100644 --- a/cpukit/libmisc/bspcmdline/bspcmdline_get.c +++ b/cpukit/libmisc/bspcmdline/bspcmdline_get.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Obtain Pointer to BSP Boot Command String + * @ingroup BSPCommandLine BSP Command Line Helpers + */ + /* * COPYRIGHT (c) 1989-2009. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/libmisc/bspcmdline/bspcmdline_getparam.c b/cpukit/libmisc/bspcmdline/bspcmdline_getparam.c index 5ece7584d2..a375ed46c8 100644 --- a/cpukit/libmisc/bspcmdline/bspcmdline_getparam.c +++ b/cpukit/libmisc/bspcmdline/bspcmdline_getparam.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Obtain COPY of the Entire Matching Argument + * @ingroup BSPCommandLine BSP Command Line Helpers + */ + /* * COPYRIGHT (c) 1989-2009. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/libmisc/bspcmdline/bspcmdline_getparamraw.c b/cpukit/libmisc/bspcmdline/bspcmdline_getparamraw.c index 22e29aa764..70a20bf7e4 100644 --- a/cpukit/libmisc/bspcmdline/bspcmdline_getparamraw.c +++ b/cpukit/libmisc/bspcmdline/bspcmdline_getparamraw.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Obtain Pointer to the Entire Matching Argument + * @ingroup BSPCommandLine BSP Command Line Helpers + */ + /* * COPYRIGHT (c) 1989-2009. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/libmisc/bspcmdline/bspcmdline_getparamrhs.c b/cpukit/libmisc/bspcmdline/bspcmdline_getparamrhs.c index cf2afcec97..f293cb8e5e 100644 --- a/cpukit/libmisc/bspcmdline/bspcmdline_getparamrhs.c +++ b/cpukit/libmisc/bspcmdline/bspcmdline_getparamrhs.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Obtain COPY of the Right Hand Side of the Matching Argument + * @ingroup BSPCommandLine BSP Command Line Helpers + */ + /* * COPYRIGHT (c) 1989-2009. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/libmisc/cpuuse/cpuusagedata.c b/cpukit/libmisc/cpuuse/cpuusagedata.c index cc3f13e0d7..fd3993d37d 100644 --- a/cpukit/libmisc/cpuuse/cpuusagedata.c +++ b/cpukit/libmisc/cpuuse/cpuusagedata.c @@ -1,6 +1,13 @@ -/* - * CPU Usage Reporter - Shared Data +/** + * @file + * + * @brief CPU Usage Data + * @ingroup libmisc_cpuuse CPU Usage * + * CPU Usage Reporter - Shared Data + */ + +/* * COPYRIGHT (c) 1989-2009 * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libmisc/cpuuse/cpuusagereport.c b/cpukit/libmisc/cpuuse/cpuusagereport.c index e884d44e12..0255c19848 100644 --- a/cpukit/libmisc/cpuuse/cpuusagereport.c +++ b/cpukit/libmisc/cpuuse/cpuusagereport.c @@ -1,6 +1,11 @@ -/* - * CPU Usage Reporter +/** + * @file * + * @brief CPU Usage Report + * @ingroup libmisc_cpuuse CPU Usage + */ + +/* * COPYRIGHT (c) 1989-2010. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libmisc/cpuuse/cpuusagereset.c b/cpukit/libmisc/cpuuse/cpuusagereset.c index 6c5f13e702..92497d75cd 100644 --- a/cpukit/libmisc/cpuuse/cpuusagereset.c +++ b/cpukit/libmisc/cpuuse/cpuusagereset.c @@ -1,6 +1,11 @@ -/* - * CPU Usage Reporter +/** + * @file * + * @brief CPU Usage Reset + * @ingroup libmisc_cpuuse CPU Usage + */ + +/* * COPYRIGHT (c) 1989-2009 * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libmisc/cpuuse/cpuuse.h b/cpukit/libmisc/cpuuse/cpuuse.h index b63e3fa476..7dfe5ba388 100644 --- a/cpukit/libmisc/cpuuse/cpuuse.h +++ b/cpukit/libmisc/cpuuse/cpuuse.h @@ -24,6 +24,12 @@ #include #endif +/** + * @defgroup libmisc_cpuuse CPU Usage + * + * @ingroup libmisc + */ +/**@{*/ #ifdef __cplusplus extern "C" { #endif @@ -43,14 +49,18 @@ void rtems_cpu_usage_report_with_plugin( rtems_printk_plugin_t handler ); -/* - * rtems_cpu_usage_report +/** + * @brief Report CPU usage. + * + * CPU Usage Reporter */ void rtems_cpu_usage_report( void ); -/* - * rtems_cpu_usage_reset +/** + * @brief Reset CPU usage. + * + * CPU Usage Reporter */ void rtems_cpu_usage_reset( void ); @@ -58,6 +68,6 @@ void rtems_cpu_usage_reset( void ); #ifdef __cplusplus } #endif - +/**@}*/ #endif /* end of include file */ diff --git a/cpukit/libmisc/devnull/devnull.c b/cpukit/libmisc/devnull/devnull.c index 12387f5159..23a78afdec 100644 --- a/cpukit/libmisc/devnull/devnull.c +++ b/cpukit/libmisc/devnull/devnull.c @@ -1,7 +1,13 @@ -/* /dev/null +/** + * @file * - * Derived from rtems' stub driver. + * @brief Null Device Driver Init Routine + * @ingroup libmisc_devnull Device Driver * + * Derived from rtems' stub driver. + */ + +/* * Author: Ralf Corsepius (corsepiu@faw.uni-ulm.de) * * COPYRIGHT (c) 1989-2000. diff --git a/cpukit/libmisc/devnull/devnull.h b/cpukit/libmisc/devnull/devnull.h index c9f47362e8..84e1475471 100644 --- a/cpukit/libmisc/devnull/devnull.h +++ b/cpukit/libmisc/devnull/devnull.h @@ -21,6 +21,12 @@ #include /* rtems_device_driver */ +/** + * @defgroup libmisc_devnull Device Driver + * + * @ingroup libmisc + */ +/**@{*/ #ifdef __cplusplus extern "C" { #endif @@ -70,6 +76,6 @@ rtems_device_driver null_control( #ifdef __cplusplus } #endif - +/**@}*/ #endif /* end of include file */ diff --git a/cpukit/libmisc/devnull/devzero.c b/cpukit/libmisc/devnull/devzero.c index 0159a16555..638198213c 100644 --- a/cpukit/libmisc/devnull/devzero.c +++ b/cpukit/libmisc/devnull/devzero.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Devzero + * @ingroup libmisc_devnull Device Driver + */ + /* * Copyright (c) 2011 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/libmisc/dumpbuf/dumpbuf.c b/cpukit/libmisc/dumpbuf/dumpbuf.c index b4957c1acd..e7da7bdf22 100644 --- a/cpukit/libmisc/dumpbuf/dumpbuf.c +++ b/cpukit/libmisc/dumpbuf/dumpbuf.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Dump Buffer + * @ingroup libmisc_dumpbuf Print Memory Buffer + */ + /* * COPYRIGHT (c) 1997-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/libmisc/dumpbuf/dumpbuf.h b/cpukit/libmisc/dumpbuf/dumpbuf.h index 23e472dce6..d03274a1bc 100644 --- a/cpukit/libmisc/dumpbuf/dumpbuf.h +++ b/cpukit/libmisc/dumpbuf/dumpbuf.h @@ -17,12 +17,18 @@ #ifndef __DUMP_BUFFER_h #define __DUMP_BUFFER_h +/** + * @defgroup libmisc_dumpbuf Print Memory Buffer + * + * @ingroup libmisc + */ +/**@{*/ #ifdef __cplusplus extern "C" { #endif /** - * @brief Print Memory Buffer + * @brief Print memory buffer. * * This method prints @a length bytes beginning at @a buffer in * a nice format similar to what one would expect from a debugger @@ -39,6 +45,6 @@ void rtems_print_buffer( #ifdef __cplusplus } #endif - +/**@}*/ #endif /* end of include file */ diff --git a/cpukit/libmisc/fb/mw_print.c b/cpukit/libmisc/fb/mw_print.c index bdc48d763c..72c8d309fc 100644 --- a/cpukit/libmisc/fb/mw_print.c +++ b/cpukit/libmisc/fb/mw_print.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief MicroWindows Print + * @ingroup libmisc_fb_mw Input Devices for MicroWindows + */ + /* * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). @@ -86,5 +93,5 @@ void uid_print_message_with_plugin( (*handler)( context, "Invalid device type\n" ); break; } - + } diff --git a/cpukit/libmisc/fb/mw_uid.c b/cpukit/libmisc/fb/mw_uid.c index f335ac1972..cb138dca75 100644 --- a/cpukit/libmisc/fb/mw_uid.c +++ b/cpukit/libmisc/fb/mw_uid.c @@ -1,5 +1,11 @@ -/* +/** + * @file * + * @brief MicroWindows UID + * @ingroup libmisc_fb_mw Input Devices for MicroWindows + */ + +/* * Copyright (c) 2000 - Rosimildo da Silva * * MODULE DESCRIPTION: diff --git a/cpukit/libmisc/fb/mw_uid.h b/cpukit/libmisc/fb/mw_uid.h index 5d2dd0b8a7..ba91a76b8c 100644 --- a/cpukit/libmisc/fb/mw_uid.h +++ b/cpukit/libmisc/fb/mw_uid.h @@ -15,6 +15,12 @@ #include #include +/** + * @defgroup libmisc_fb_mw Input Devices for MicroWindows + * + * @ingroup libmisc + */ +/**@{*/ #ifdef __cplusplus extern "C" { #endif @@ -182,5 +188,5 @@ void uid_print_message_with_plugin( #ifdef __cplusplus } #endif - +/**@}*/ #endif /* _MW_UID_H */ diff --git a/cpukit/libmisc/fsmount/fsmount.c b/cpukit/libmisc/fsmount/fsmount.c index 1d82b94391..3e785c7162 100644 --- a/cpukit/libmisc/fsmount/fsmount.c +++ b/cpukit/libmisc/fsmount/fsmount.c @@ -1,32 +1,24 @@ /** * @file * - * File system mount functions. + * @brief File System Mount Functions + * @ingroup rtems_fstab File System Mount Support */ -/*===============================================================*\ -| Project: RTEMS fsmount | -+-----------------------------------------------------------------+ -| File: fsmount.c | -+-----------------------------------------------------------------+ -| Copyright (c) 2003 IMD | -| Ingenieurbuero fuer Microcomputertechnik Th. Doerfler | -| | -| all rights reserved | -+-----------------------------------------------------------------+ -| this file contains the fsmount functions. These functions | -| are used to mount a list of filesystems (and create their mount | -| points before) | -| | -| The license and distribution terms for this file may be | -| found in the file LICENSE in this distribution or at | -| http://www.rtems.com/license/LICENSE. | -| | -+-----------------------------------------------------------------+ -| date history ID | -| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | -| 02.07.03 creation doe | -\*===============================================================*/ +/* + * Copyright (c) 2003 IMD + * Ingenieurbuero fuer Microcomputertechnik Th. Doerfler + * + * all rights reserved + * + * This file contains the fsmount functions. These functions + * are used to mount a list of filesystems (and create their mount + * points before). + * + * The license and distribution terms for this file may be + * found in the file LICENSE in this distribution or at + * http://www.rtems.com/license/LICENSE. + */ #ifndef HAVE_CONFIG_H #include "config.h" diff --git a/cpukit/libmisc/fsmount/fsmount.h b/cpukit/libmisc/fsmount/fsmount.h index ede0ea2eb6..af1d9a532f 100644 --- a/cpukit/libmisc/fsmount/fsmount.h +++ b/cpukit/libmisc/fsmount/fsmount.h @@ -123,6 +123,8 @@ typedef struct { } rtems_fstab_entry; /** + * @brief Mounts the file systems listed in the file system mount table. + * * Mounts the file systems listed in the file system mount table @a fstab of * size @a size. * diff --git a/cpukit/libmisc/mouse/mouse_parser.c b/cpukit/libmisc/mouse/mouse_parser.c index 2f96e1567f..6ca871bf52 100644 --- a/cpukit/libmisc/mouse/mouse_parser.c +++ b/cpukit/libmisc/mouse/mouse_parser.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Opens a Serial Port Directly, and Interprets Serial Data + * @ingroup libmisc_mouse Mouse Parser Engine + */ + /* * This code is derived from a UNIX Serial Port Mouse Driver with * the following notice: @@ -19,7 +26,7 @@ * ================================================================== * * It has been modified to support the concept of being just a parser - * fed data from an arbitrary source. It is independent of either + * fed data from an arbitrary source. It is independent of either * a PS/2 driver or a serial port. * * It was moved to cpukit/libmisc/mouse by Joel Sherrill. @@ -135,7 +142,7 @@ static int MOU_Data( int ch, COORD *dx, COORD *dy, COORD *dz, BUTTON *bptr) if ( !parse ) { printk( "Mouse parser is not initialized!\n" ); return -1; - } + } /* * Loop over all the bytes read in the buffer, parsing them. diff --git a/cpukit/libmisc/mouse/mouse_parser.h b/cpukit/libmisc/mouse/mouse_parser.h index 51bcb2deef..8b42c4464f 100644 --- a/cpukit/libmisc/mouse/mouse_parser.h +++ b/cpukit/libmisc/mouse/mouse_parser.h @@ -25,7 +25,7 @@ * ================================================================== * * It has been modified to support the concept of being just a parser - * fed data from an arbitrary source. It is independent of either + * fed data from an arbitrary source. It is independent of either * a PS/2 driver or a serial port. * * It was moved to cpukit/libmisc/mouse by Joel Sherrill. @@ -36,6 +36,12 @@ #include +/** + * @defgroup libmisc_mouse Mouse Parser Engine + * + * @ingroup libmisc + */ +/**@{*/ #ifdef __cplusplus extern "C" { #endif @@ -79,7 +85,7 @@ typedef unsigned int BUTTON; typedef void (*mouse_parser_enqueue_handler)(unsigned char *, size_t); /** - * @brief Initialize the Mouse Parser Engine + * @brief Initialize the mouse parser engine. * * This method initializes the Mouse Parser Engine for the mouse * of @a type. The @a type should be one of the following strings: @@ -92,7 +98,7 @@ typedef void (*mouse_parser_enqueue_handler)(unsigned char *, size_t); int mouse_parser_initialize(const char *type); /** - * @brief Enqueue Input to the Mouse Parser Engine + * @brief Enqueue input to the mouse parser engine. * * This method is used to pass mouse input to the Mouse Parser Engine. * diff --git a/cpukit/libmisc/mouse/serial_mouse.c b/cpukit/libmisc/mouse/serial_mouse.c index 4175fa07fe..cdeaa29faf 100644 --- a/cpukit/libmisc/mouse/serial_mouse.c +++ b/cpukit/libmisc/mouse/serial_mouse.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Serial Mouse Driver + * @ingroup libmisc_mouse Serial Mouse Driver + */ + /* * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). @@ -26,7 +33,7 @@ const char *serial_mouse_type; static int serial_mouse_l_rint(int c, struct rtems_termios_tty *tp) { unsigned char buf = c; - + /* call mouse_parser( void *ptr, char *buffer, int size ) */ mouse_parser_enqueue( &buf, 1 ); return 0; diff --git a/cpukit/libmisc/mouse/serial_mouse.h b/cpukit/libmisc/mouse/serial_mouse.h index 8cb966ec7b..314e49bbd0 100644 --- a/cpukit/libmisc/mouse/serial_mouse.h +++ b/cpukit/libmisc/mouse/serial_mouse.h @@ -23,6 +23,13 @@ #define __SERIAL_MOUSE_h__ /* functions */ + +/** + * @defgroup libmisc_mouse Serial Mouse Driver + * + * @ingroup libmisc + */ +/**@{*/ #ifdef __cplusplus extern "C" { #endif @@ -35,7 +42,7 @@ extern "C" { serial_mouse_read, serial_mouse_write, serial_mouse_control } /** - * @brief Serial Mouse Driver Initialization + * @brief The initialization of the serial mouse driver. * * This method initializes the serial mouse driver. * @@ -50,7 +57,7 @@ rtems_device_driver serial_mouse_initialize( ); /** - * @brief Serial Mouse Driver Open + * @brief Open device driver entry point for the serial mouse driver. * * This method implements the Open device driver entry * point for the serial mouse driver. @@ -66,7 +73,7 @@ rtems_device_driver serial_mouse_open( ); /** - * @brief Serial Mouse Driver Close + * @brief Close device driver entry point for the serial mouse driver. * * This method implements the Close device driver entry * point for the serial mouse driver. @@ -82,7 +89,7 @@ rtems_device_driver serial_mouse_close( ); /** - * @brief Serial Mouse Driver Read + * @brief Read device driver entry point for the serial mouse driver. * * This method implements the Read device driver entry * point for the serial mouse driver. @@ -98,7 +105,7 @@ rtems_device_driver serial_mouse_read( ); /** - * @brief Serial Mouse Driver Write + * @brief Write device driver entry point for the serial mouse driver. * * This method implements the Write device driver entry * point for the serial mouse driver. @@ -114,7 +121,7 @@ rtems_device_driver serial_mouse_write( ); /** - * @brief Serial Mouse Driver IO Control + * @brief IO Control device driver entry point for the serial mouse driver. * * This method implements the IO Control device driver entry * point for the serial mouse driver. @@ -130,7 +137,7 @@ rtems_device_driver serial_mouse_control( ); /** - * @brief Obtain Serial Mouse Configuration Information + * @brief Obtain serial mouse configuration information. * * This method is implemented by the BSP or application and * tells the driver what device to open() and what type of @@ -150,5 +157,5 @@ bool bsp_get_serial_mouse_device( #ifdef __cplusplus } #endif - +/**@}*/ #endif /* __tty_drv__ */ diff --git a/cpukit/libmisc/stackchk/check.c b/cpukit/libmisc/stackchk/check.c index c14b52c780..d6bca502eb 100644 --- a/cpukit/libmisc/stackchk/check.c +++ b/cpukit/libmisc/stackchk/check.c @@ -1,11 +1,16 @@ -/* - * Stack Overflow Check User Extension Set +/** + * @file + * + * @brief Stack Overflow Check User Extension Set + * @ingroup libmisc_stackchk Stack Checker Mechanism * - * NOTE: This extension set automatically determines at + * NOTE: This extension set automatically determines at * initialization time whether the stack for this * CPU grows up or down and installs the correct * extension routines for that direction. - * + */ + +/* * COPYRIGHT (c) 1989-2010. * On-Line Applications Research Corporation (OAR). * @@ -409,7 +414,7 @@ static void Stack_check_Dump_threads_usage( stack = &Stack_check_Interrupt_stack; the_thread = 0; current = 0; - } else + } else #endif { stack = &the_thread->Start.Initial_stack; diff --git a/cpukit/libmisc/stackchk/stackchk.h b/cpukit/libmisc/stackchk/stackchk.h index efa029391b..e4931715c9 100644 --- a/cpukit/libmisc/stackchk/stackchk.h +++ b/cpukit/libmisc/stackchk/stackchk.h @@ -21,12 +21,18 @@ #include /* Thread_Control */ #include +/** + * @defgroup libmisc_stackchk Stack Checker Mechanism + * + * @ingroup libmisc + */ +/**@{*/ #ifdef __cplusplus extern "C" { #endif /** - * @brief Has Current Task Blown Its Stack + * @brief Checks if current task is blown its stack. * * This method is used to determine if the current stack pointer * of the currently executing task is within bounds. @@ -38,7 +44,7 @@ extern "C" { bool rtems_stack_checker_is_blown( void ); /** - * @brief Print Stack Usage Report + * @brief Print the stack usage report using printk. * * This method prints a stack usage report for the curently executing * task. @@ -48,7 +54,7 @@ bool rtems_stack_checker_is_blown( void ); void rtems_stack_checker_report_usage( void ); /** - * @brief Print Stack Usage Report + * @brief Print the stack usage report using caller's routine. * * This method prints a stack usage report for the curently executing * task. @@ -135,6 +141,6 @@ void rtems_stack_checker_switch_extension( #ifdef __cplusplus } #endif - +/**@}*/ #endif /* end of include file */ 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 /** - * @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; -- cgit v1.2.3