diff options
author | Alex Ivanov <alexivanov97@gmail.com> | 2012-12-10 14:51:23 -0500 |
---|---|---|
committer | Gedare Bloom <gedare@rtems.org> | 2012-12-10 14:51:23 -0500 |
commit | 37509959b261e28607ca9ae1ce247c0463b39f42 (patch) | |
tree | c428ff39cf29e9cc8ee04d9e271ccbd4543abb51 /cpukit/libcsupport/include/rtems | |
parent | libcsupport: Doxygen enhancement task #2 (diff) | |
download | rtems-37509959b261e28607ca9ae1ce247c0463b39f42.tar.bz2 |
libcsupport: Doxygen enhancement task #5
http://www.google-melange.com/gci/task/view/google/gci2012/7992211
Diffstat (limited to '')
-rw-r--r-- | cpukit/libcsupport/include/rtems/assoc.h | 6 | ||||
-rw-r--r-- | cpukit/libcsupport/include/rtems/libcsupport.h | 11 | ||||
-rw-r--r-- | cpukit/libcsupport/include/rtems/libio_.h | 3 | ||||
-rw-r--r-- | cpukit/libcsupport/include/rtems/malloc.h | 10 |
4 files changed, 29 insertions, 1 deletions
diff --git a/cpukit/libcsupport/include/rtems/assoc.h b/cpukit/libcsupport/include/rtems/assoc.h index 2401661e1f..48234c9fb4 100644 --- a/cpukit/libcsupport/include/rtems/assoc.h +++ b/cpukit/libcsupport/include/rtems/assoc.h @@ -40,6 +40,9 @@ const rtems_assoc_t *rtems_assoc_ptr_by_name( const char * ); +/** + * @brief RTEMS Associate Pointer by Remote + */ const rtems_assoc_t *rtems_assoc_ptr_by_remote( const rtems_assoc_t *, uint32_t @@ -50,6 +53,9 @@ uint32_t rtems_assoc_remote_by_local( uint32_t ); +/** + * @brief RTEMS Associate Local by Remote + */ uint32_t rtems_assoc_local_by_remote( const rtems_assoc_t *, uint32_t diff --git a/cpukit/libcsupport/include/rtems/libcsupport.h b/cpukit/libcsupport/include/rtems/libcsupport.h index a3e5517046..600ee84562 100644 --- a/cpukit/libcsupport/include/rtems/libcsupport.h +++ b/cpukit/libcsupport/include/rtems/libcsupport.h @@ -40,6 +40,12 @@ extern void malloc_dump(void); */ extern bool malloc_walk(int source, bool printf_enabled); void malloc_set_heap_pointer(Heap_Control *new_heap); + +/** + * @brief RTEMS Malloc Get Heap Pointer + * + * This routine is primarily used for debugging. + */ Heap_Control *malloc_get_heap_pointer( void ); extern void libc_init(void); extern int host_errno(void); @@ -47,6 +53,11 @@ extern void fix_syscall_errno(void); extern size_t malloc_free_space(void); extern void open_dev_console(void); +/** + * @brief RTEMS Malloc Get Status Information + * + * Find amount of free heap remaining. + */ extern int malloc_info(Heap_Information_block *the_info); /* diff --git a/cpukit/libcsupport/include/rtems/libio_.h b/cpukit/libcsupport/include/rtems/libio_.h index 91035b1757..2ab40eef2a 100644 --- a/cpukit/libcsupport/include/rtems/libio_.h +++ b/cpukit/libcsupport/include/rtems/libio_.h @@ -680,6 +680,9 @@ static inline void rtems_filesystem_eval_path_put_back_token( ctx->tokenlen = 0; } +/** + * @brief RTEMS File System Eval Eat Delimiter Path + */ void rtems_filesystem_eval_path_eat_delimiter( rtems_filesystem_eval_path_context_t *ctx ); diff --git a/cpukit/libcsupport/include/rtems/malloc.h b/cpukit/libcsupport/include/rtems/malloc.h index 9d475d33b1..6b0dfa0e65 100644 --- a/cpukit/libcsupport/include/rtems/malloc.h +++ b/cpukit/libcsupport/include/rtems/malloc.h @@ -27,6 +27,14 @@ extern "C" { #endif /** + * @defgroup MallocSupport Malloc Support + * + * @ingroup libcsupport + * + * @brief RTEMS extensions to the Malloc Family + */ + +/** * @brief C program heap control. * * This is the pointer to the heap control structure used to manage the C @@ -211,7 +219,7 @@ rtems_status_code rtems_heap_extend( ); /** - * @brief Greedy allocate that empties the heap. + * @brief Greedy Allocate that Empties the Heap * * Afterward the heap has at most @a block_count allocatable blocks of sizes * specified by @a block_sizes. The @a block_sizes must point to an array with |