diff options
author | Alex Ivanov <alexivanov97@gmail.com> | 2012-12-09 17:55:17 -0500 |
---|---|---|
committer | Gedare Bloom <gedare@rtems.org> | 2012-12-09 17:55:17 -0500 |
commit | bcd0ea64091d4c360b48cfabbfb94b4f562a9eaa (patch) | |
tree | c19e154cfb32d246159933209e1c404be752e8e6 /cpukit/libcsupport/include | |
parent | libcsupport: Fix documentation (diff) | |
download | rtems-bcd0ea64091d4c360b48cfabbfb94b4f562a9eaa.tar.bz2 |
libcsupport: Doxygen enhancement task #2
http://www.google-melange.com/gci/task/view/google/gci2012/8017203
Diffstat (limited to 'cpukit/libcsupport/include')
-rw-r--r-- | cpukit/libcsupport/include/rtems/assoc.h | 6 | ||||
-rw-r--r-- | cpukit/libcsupport/include/rtems/libcsupport.h | 10 | ||||
-rw-r--r-- | cpukit/libcsupport/include/rtems/libio_.h | 7 | ||||
-rw-r--r-- | cpukit/libcsupport/include/rtems/termiostypes.h | 20 |
4 files changed, 37 insertions, 6 deletions
diff --git a/cpukit/libcsupport/include/rtems/assoc.h b/cpukit/libcsupport/include/rtems/assoc.h index 80a2fe7cdf..2401661e1f 100644 --- a/cpukit/libcsupport/include/rtems/assoc.h +++ b/cpukit/libcsupport/include/rtems/assoc.h @@ -32,6 +32,9 @@ typedef struct { #define RTEMS_ASSOC_DEFAULT_NAME "(default)" +/** + * @brief RTEMS Associate Pointer by Name + */ const rtems_assoc_t *rtems_assoc_ptr_by_name( const rtems_assoc_t *, const char * @@ -52,6 +55,9 @@ uint32_t rtems_assoc_local_by_remote( uint32_t ); +/** + * @brief RTEMS Associate Remote by Name + */ uint32_t rtems_assoc_remote_by_name( const rtems_assoc_t *, const char * diff --git a/cpukit/libcsupport/include/rtems/libcsupport.h b/cpukit/libcsupport/include/rtems/libcsupport.h index 919b41eea3..a3e5517046 100644 --- a/cpukit/libcsupport/include/rtems/libcsupport.h +++ b/cpukit/libcsupport/include/rtems/libcsupport.h @@ -27,7 +27,17 @@ extern "C" { #endif +/** + * @defgroup libcsupport Standard C Library Support + * + * @brief RTEMS Specific Support for the Standard C Library + */ + extern void malloc_dump(void); + +/** + * @brief Malloc Walk + */ extern bool malloc_walk(int source, bool printf_enabled); void malloc_set_heap_pointer(Heap_Control *new_heap); Heap_Control *malloc_get_heap_pointer( void ); diff --git a/cpukit/libcsupport/include/rtems/libio_.h b/cpukit/libcsupport/include/rtems/libio_.h index 98f6f63d4d..91035b1757 100644 --- a/cpukit/libcsupport/include/rtems/libio_.h +++ b/cpukit/libcsupport/include/rtems/libio_.h @@ -399,6 +399,9 @@ typedef struct { rtems_filesystem_eval_path_eval_token eval_token; } rtems_filesystem_eval_path_generic_config; +/** + * @brief RTEMS File System Eval Generic Path + */ void rtems_filesystem_eval_path_generic( rtems_filesystem_eval_path_context_t *ctx, void *arg, @@ -535,7 +538,9 @@ static inline void rtems_filesystem_location_error( errno = eno; } } - +/** + * @brief RTEMS File System Mknod + */ int rtems_filesystem_mknod( const rtems_filesystem_location_info_t *parentloc, const char *name, diff --git a/cpukit/libcsupport/include/rtems/termiostypes.h b/cpukit/libcsupport/include/rtems/termiostypes.h index 74653b0252..7f2a3eae84 100644 --- a/cpukit/libcsupport/include/rtems/termiostypes.h +++ b/cpukit/libcsupport/include/rtems/termiostypes.h @@ -26,6 +26,14 @@ extern "C" { #endif +/** + * @defgroup TermiostypesSupport RTEMS Termios Device Support + * + * @ingroup libcsupport + * + * @brief RTEMS Termios Device Support Internal Data Structures + */ + /* * Wakeup callback data structure */ @@ -186,11 +194,11 @@ typedef uint32_t rtems_termios_baud_t; extern const rtems_assoc_t rtems_termios_baud_table []; /** - * @brief Converts the integral baud value @a baud to the Termios control flag - * representation. + * @brief Converts the Integral Baud value @a baud to the Termios Control Flag + * Representation * - * @retval B0 Invalid baud value or a baud value of 0. - * @retval other Baud constant according to @a baud. + * @retval B0 Invalid baud value or a baud value of 0. + * @retval other Baud constant according to @a baud. */ tcflag_t rtems_termios_number_to_baud(rtems_termios_baud_t baud); @@ -205,7 +213,9 @@ tcflag_t rtems_termios_number_to_baud(rtems_termios_baud_t baud); */ rtems_termios_baud_t rtems_termios_baud_to_number(tcflag_t c_cflag); -/* convert Bxxx constant to index */ +/** + * @brief Convert Bxxx Constant to Index + */ int rtems_termios_baud_to_index(rtems_termios_baud_t termios_baud); /** |