mirror of
https://gitlab.rtems.org/rtems/rtos/rtems.git
synced 2026-09-21 18:35:27 +08:00
libmisc: Doxygen Clean Up Task #1
Conflicts occured durning this patch and modifications in the repo were favored over the patch.
This commit is contained in:
Ayush Awasthi
committed by
Jennifer Averett
Jennifer Averett
parent
436f86e142
commit
a163882dae
+112
-107
@@ -1,16 +1,21 @@
|
||||
/**
|
||||
* @file rtems/stringto.h
|
||||
*
|
||||
* @defgroup libmisc_conv_help Conversion Helpers
|
||||
*
|
||||
* @ingroup libmisc
|
||||
* @brief Convert String to Pointer (with validation)
|
||||
*
|
||||
* This file defines the interface to a set of string conversion helpers.
|
||||
*/
|
||||
|
||||
/*
|
||||
* COPYRIGHT (c) 2009-2011.
|
||||
* On-Line Applications Research Corporation (OAR).
|
||||
* COPYRIGHT (c) 2009-2011.
|
||||
* On-Line Applications Research Corporation (OAR).
|
||||
*
|
||||
* 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.
|
||||
* 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 _RTEMS_STRINGTO_H
|
||||
@@ -25,18 +30,18 @@
|
||||
#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.
|
||||
* This method converts a string to a pointer (void *) with
|
||||
* basic numeric validation.
|
||||
*
|
||||
* @param[in] s is the string to convert
|
||||
* @param[in] n points to the variable to place the converted output in
|
||||
* @param[in] endptr is used to keep track of the position in the string
|
||||
* @param[in] s is the string to convert
|
||||
* @param[in] n points to the variable to place the converted output in
|
||||
* @param[in] endptr is used to keep track of the position in the string
|
||||
*
|
||||
* @return This method returns RTEMS_SUCCESSFUL on successful conversion
|
||||
* and *n is filled in. Otherwise, the status indicates the
|
||||
* source of the error.
|
||||
* @retval This method returns RTEMS_SUCCESSFUL on successful conversion
|
||||
* and *n is filled in. Otherwise, the status indicates the
|
||||
* source of the error.
|
||||
*/
|
||||
rtems_status_code rtems_string_to_pointer(
|
||||
const char *s,
|
||||
@@ -45,19 +50,19 @@ 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.
|
||||
* This method converts a string to an unsigned character with
|
||||
* range validation.
|
||||
*
|
||||
* @param[in] s is the string to convert
|
||||
* @param[in] n points to the variable to place the converted output in
|
||||
* @param[in] endptr is used to keep track of the position in the string
|
||||
* @param[in] base is the expected base of the number
|
||||
* @param[in] s is the string to convert
|
||||
* @param[in] n points to the variable to place the converted output in
|
||||
* @param[in] endptr is used to keep track of the position in the string
|
||||
* @param[in] base is the expected base of the number
|
||||
*
|
||||
* @return This method returns RTEMS_SUCCESSFUL on successful conversion
|
||||
* and *n is filled in. Otherwise, the status indicates the
|
||||
* source of the error.
|
||||
* @retval This method returns RTEMS_SUCCESSFUL on successful conversion
|
||||
* and *n is filled in. Otherwise, the status indicates the
|
||||
* source of the error.
|
||||
*/
|
||||
rtems_status_code rtems_string_to_unsigned_char(
|
||||
const char *s,
|
||||
@@ -67,18 +72,18 @@ 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.
|
||||
* This method converts a string to an int with range validation.
|
||||
*
|
||||
* @param[in] s is the string to convert
|
||||
* @param[in] n points to the variable to place the converted output in
|
||||
* @param[in] endptr is used to keep track of the position in the string
|
||||
* @param[in] base is the expected base of the number
|
||||
* @param[in] s is the string to convert
|
||||
* @param[in] n points to the variable to place the converted output in
|
||||
* @param[in] endptr is used to keep track of the position in the string
|
||||
* @param[in] base is the expected base of the number
|
||||
*
|
||||
* @return This method returns RTEMS_SUCCESSFUL on successful conversion
|
||||
* and *n is filled in. Otherwise, the status indicates the
|
||||
* source of the error.
|
||||
* @retval This method returns RTEMS_SUCCESSFUL on successful conversion
|
||||
* and *n is filled in. Otherwise, the status indicates the
|
||||
* source of the error.
|
||||
*/
|
||||
rtems_status_code rtems_string_to_int(
|
||||
const char *s,
|
||||
@@ -88,18 +93,18 @@ 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.
|
||||
* This method converts a string to an unsigned int with range validation.
|
||||
*
|
||||
* @param[in] s is the string to convert
|
||||
* @param[in] n points to the variable to place the converted output in
|
||||
* @param[in] endptr is used to keep track of the position in the string
|
||||
* @param[in] base is the expected base of the number
|
||||
* @param[in] s is the string to convert
|
||||
* @param[in] n points to the variable to place the converted output in
|
||||
* @param[in] endptr is used to keep track of the position in the string
|
||||
* @param[in] base is the expected base of the number
|
||||
*
|
||||
* @return This method returns RTEMS_SUCCESSFUL on successful conversion
|
||||
* and *n is filled in. Otherwise, the status indicates the
|
||||
* source of the error.
|
||||
* @retval This method returns RTEMS_SUCCESSFUL on successful conversion
|
||||
* and *n is filled in. Otherwise, the status indicates the
|
||||
* source of the error.
|
||||
*/
|
||||
rtems_status_code rtems_string_to_unsigned_int(
|
||||
const char *s,
|
||||
@@ -109,19 +114,19 @@ 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.
|
||||
* This method converts a string to a long with
|
||||
* range validation.
|
||||
*
|
||||
* @param[in] s is the string to convert
|
||||
* @param[in] n points to the variable to place the converted output in
|
||||
* @param[in] endptr is used to keep track of the position in the string
|
||||
* @param[in] base is the expected base of the number
|
||||
* @param[in] s is the string to convert
|
||||
* @param[in] n points to the variable to place the converted output in
|
||||
* @param[in] endptr is used to keep track of the position in the string
|
||||
* @param[in] base is the expected base of the number
|
||||
*
|
||||
* @return This method returns RTEMS_SUCCESSFUL on successful conversion
|
||||
* and *n is filled in. Otherwise, the status indicates the
|
||||
* source of the error.
|
||||
* @retval This method returns RTEMS_SUCCESSFUL on successful conversion
|
||||
* and *n is filled in. Otherwise, the status indicates the
|
||||
* source of the error.
|
||||
*/
|
||||
rtems_status_code rtems_string_to_long(
|
||||
const char *s,
|
||||
@@ -131,19 +136,19 @@ 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.
|
||||
* This method converts a string to an unsigned long with
|
||||
* range validation.
|
||||
*
|
||||
* @param[in] s is the string to convert
|
||||
* @param[in] n points to the variable to place the converted output in
|
||||
* @param[in] endptr is used to keep track of the position in the string
|
||||
* @param[in] base is the expected base of the number
|
||||
* @param[in] s is the string to convert
|
||||
* @param[in] n points to the variable to place the converted output in
|
||||
* @param[in] endptr is used to keep track of the position in the string
|
||||
* @param[in] base is the expected base of the number
|
||||
*
|
||||
* @return This method returns RTEMS_SUCCESSFUL on successful conversion
|
||||
* and *n is filled in. Otherwise, the status indicates the
|
||||
* source of the error.
|
||||
* @retval This method returns RTEMS_SUCCESSFUL on successful conversion
|
||||
* and *n is filled in. Otherwise, the status indicates the
|
||||
* source of the error.
|
||||
*/
|
||||
rtems_status_code rtems_string_to_unsigned_long(
|
||||
const char *s,
|
||||
@@ -153,19 +158,19 @@ 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.
|
||||
* This method converts a string to a long long with
|
||||
* range validation.
|
||||
*
|
||||
* @param[in] s is the string to convert
|
||||
* @param[in] n points to the variable to place the converted output in
|
||||
* @param[in] endptr is used to keep track of the position in the string
|
||||
* @param[in] base is the expected base of the number
|
||||
* @param[in] s is the string to convert
|
||||
* @param[in] n points to the variable to place the converted output in
|
||||
* @param[in] endptr is used to keep track of the position in the string
|
||||
* @param[in] base is the expected base of the number
|
||||
*
|
||||
* @return This method returns RTEMS_SUCCESSFUL on successful conversion
|
||||
* and *n is filled in. Otherwise, the status indicates the
|
||||
* source of the error.
|
||||
* @retval This method returns RTEMS_SUCCESSFUL on successful conversion
|
||||
* and *n is filled in. Otherwise, the status indicates the
|
||||
* source of the error.
|
||||
*/
|
||||
rtems_status_code rtems_string_to_long_long(
|
||||
const char *s,
|
||||
@@ -175,19 +180,19 @@ 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.
|
||||
* This method converts a string to an unsigned character with
|
||||
* range validation.
|
||||
*
|
||||
* @param[in] s is the string to convert
|
||||
* @param[in] n points to the variable to place the converted output in
|
||||
* @param[in] endptr is used to keep track of the position in the string
|
||||
* @param[in] base is the expected base of the number
|
||||
* @param[in] s is the string to convert
|
||||
* @param[in] n points to the variable to place the converted output in
|
||||
* @param[in] endptr is used to keep track of the position in the string
|
||||
* @param[in] base is the expected base of the number
|
||||
*
|
||||
* @return This method returns RTEMS_SUCCESSFUL on successful conversion
|
||||
* and *n is filled in. Otherwise, the status indicates the
|
||||
* source of the error.
|
||||
* @retval This method returns RTEMS_SUCCESSFUL on successful conversion
|
||||
* and *n is filled in. Otherwise, the status indicates the
|
||||
* source of the error.
|
||||
*/
|
||||
rtems_status_code rtems_string_to_unsigned_long_long(
|
||||
const char *s,
|
||||
@@ -197,17 +202,17 @@ 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.
|
||||
* This method converts a string to a float with range validation.
|
||||
*
|
||||
* @param[in] s is the string to convert
|
||||
* @param[in] n points to the variable to place the converted output in
|
||||
* @param[in] endptr is used to keep track of the position in the string
|
||||
* @param[in] s is the string to convert
|
||||
* @param[in] n points to the variable to place the converted output in
|
||||
* @param[in] endptr is used to keep track of the position in the string
|
||||
*
|
||||
* @return This method returns RTEMS_SUCCESSFUL on successful conversion
|
||||
* and *n is filled in. Otherwise, the status indicates the
|
||||
* source of the error.
|
||||
* @retval This method returns RTEMS_SUCCESSFUL on successful conversion
|
||||
* and *n is filled in. Otherwise, the status indicates the
|
||||
* source of the error.
|
||||
*/
|
||||
rtems_status_code rtems_string_to_float(
|
||||
const char *s,
|
||||
@@ -216,17 +221,17 @@ 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.
|
||||
* This method converts a string to a double with range validation.
|
||||
*
|
||||
* @param[in] s is the string to convert
|
||||
* @param[in] n points to the variable to place the converted output in
|
||||
* @param[in] endptr is used to keep track of the position in the string
|
||||
* @param[in] s is the string to convert
|
||||
* @param[in] n points to the variable to place the converted output in
|
||||
* @param[in] endptr is used to keep track of the position in the string
|
||||
*
|
||||
* @return This method returns RTEMS_SUCCESSFUL on successful conversion
|
||||
* and *n is filled in. Otherwise, the status indicates the
|
||||
* source of the error.
|
||||
* @retval This method returns RTEMS_SUCCESSFUL on successful conversion
|
||||
* and *n is filled in. Otherwise, the status indicates the
|
||||
* source of the error.
|
||||
*/
|
||||
rtems_status_code rtems_string_to_double(
|
||||
const char *s,
|
||||
@@ -235,17 +240,17 @@ 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.
|
||||
* This method converts a string to a long double with range validation.
|
||||
*
|
||||
* @param[in] s is the string to convert
|
||||
* @param[in] n points to the variable to place the converted output in
|
||||
* @param[in] endptr is used to keep track of the position in the string
|
||||
* @param[in] s is the string to convert
|
||||
* @param[in] n points to the variable to place the converted output in
|
||||
* @param[in] endptr is used to keep track of the position in the string
|
||||
*
|
||||
* @return This method returns RTEMS_SUCCESSFUL on successful conversion
|
||||
* and *n is filled in. Otherwise, the status indicates the
|
||||
* source of the error.
|
||||
* @retval This method returns RTEMS_SUCCESSFUL on successful conversion
|
||||
* and *n is filled in. Otherwise, the status indicates the
|
||||
* source of the error.
|
||||
*/
|
||||
rtems_status_code rtems_string_to_long_double(
|
||||
const char *s,
|
||||
@@ -254,4 +259,4 @@ rtems_status_code rtems_string_to_long_double(
|
||||
);
|
||||
|
||||
#endif
|
||||
/**@}*/
|
||||
/**@}*/
|
||||
|
||||
Reference in New Issue
Block a user