diff options
author | Mathew Kallada <matkallada@gmail.com> | 2012-12-08 15:43:29 -0500 |
---|---|---|
committer | Gedare Bloom <gedare@rtems.org> | 2012-12-08 15:43:29 -0500 |
commit | ceaa99964fee5138ebec4b09b80fdf13c3407cfa (patch) | |
tree | ce1b9891c9061e6378acdc9e85d025d0afb895a6 /cpukit/libcsupport/include/rtems | |
parent | misc rtems: Clean up Doxygen GCI Task #8 (diff) | |
download | rtems-ceaa99964fee5138ebec4b09b80fdf13c3407cfa.tar.bz2 |
libcsupport: Doxygen Enhancement Task #3
http://www.google-melange.com/gci/task/view/google/gci2012/7992210
Diffstat (limited to '')
-rw-r--r-- | cpukit/libcsupport/include/rtems/assoc.h | 14 | ||||
-rw-r--r-- | cpukit/libcsupport/include/rtems/deviceio.h | 21 | ||||
-rw-r--r-- | cpukit/libcsupport/include/rtems/libio.h | 1 | ||||
-rw-r--r-- | cpukit/libcsupport/include/rtems/libio_.h | 10 |
4 files changed, 43 insertions, 3 deletions
diff --git a/cpukit/libcsupport/include/rtems/assoc.h b/cpukit/libcsupport/include/rtems/assoc.h index f55d3fe376..80a2fe7cdf 100644 --- a/cpukit/libcsupport/include/rtems/assoc.h +++ b/cpukit/libcsupport/include/rtems/assoc.h @@ -9,6 +9,11 @@ #ifndef _RTEMS_RTEMS_ASSOC_H #define _RTEMS_RTEMS_ASSOC_H +/** + * @defgroup Associativity Routines + */ +/**@{*/ + #include <stdint.h> /* uint32_t */ #ifdef __cplusplus @@ -51,6 +56,10 @@ uint32_t rtems_assoc_remote_by_name( const rtems_assoc_t *, const char * ); + +/** + * @brief RTEMS Associate Local by Name + */ uint32_t rtems_assoc_local_by_name( const rtems_assoc_t *, const char * @@ -66,6 +75,9 @@ const char *rtems_assoc_name_by_remote( uint32_t ); +/** + * @brief RTEMS Assoc Routines + */ uint32_t rtems_assoc_remote_by_local_bitfield( const rtems_assoc_t *, uint32_t @@ -111,5 +123,5 @@ const char *rtems_assoc_name_bad( #ifdef __cplusplus } #endif - +/**@}*/ #endif /* ! _RTEMS_RTEMS_ASSOC_H */ diff --git a/cpukit/libcsupport/include/rtems/deviceio.h b/cpukit/libcsupport/include/rtems/deviceio.h index d1d37fdfd1..637eef4f6c 100644 --- a/cpukit/libcsupport/include/rtems/deviceio.h +++ b/cpukit/libcsupport/include/rtems/deviceio.h @@ -1,3 +1,7 @@ +/** + * @file rtems/deviceio.h + */ + /* * COPYRIGHT (c) 1989-2012. * On-Line Applications Research Corporation (OAR). @@ -10,12 +14,25 @@ #ifndef _RTEMS_DEVICEIO_H #define _RTEMS_DEVICEIO_H +/** + * @defgroup Device IO Handler + */ +/**@{*/ + #include <rtems/libio.h> #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ +/** + * @brief IMFS Device Node Handlers + * + * IMFS Device Node Handlers + * + * This file contains the set of handlers used to map operations on + * IMFS device nodes onto calls to the RTEMS Classic API IO Manager. + */ int rtems_deviceio_errno( rtems_status_code status ); int rtems_deviceio_open( @@ -59,6 +76,8 @@ int rtems_deviceio_control( #ifdef __cplusplus } -#endif /* __cplusplus */ +#endif +/**@}*/ +/* __cplusplus */ #endif /* _RTEMS_DEVICEIO_H */ diff --git a/cpukit/libcsupport/include/rtems/libio.h b/cpukit/libcsupport/include/rtems/libio.h index 9374f3ac1a..7281765a0a 100644 --- a/cpukit/libcsupport/include/rtems/libio.h +++ b/cpukit/libcsupport/include/rtems/libio.h @@ -46,6 +46,7 @@ extern "C" { * * @{ */ +/**@{*/ /** * @brief File system node types. diff --git a/cpukit/libcsupport/include/rtems/libio_.h b/cpukit/libcsupport/include/rtems/libio_.h index 4f7a432e9a..941efb785b 100644 --- a/cpukit/libcsupport/include/rtems/libio_.h +++ b/cpukit/libcsupport/include/rtems/libio_.h @@ -19,6 +19,11 @@ #ifndef _RTEMS_RTEMS_LIBIO__H #define _RTEMS_RTEMS_LIBIO__H +/** + * @defgroup libio Internal Interface + */ +/**@{*/ + #include <errno.h> #include <rtems.h> @@ -536,6 +541,9 @@ int rtems_filesystem_mknod( dev_t dev ); +/** + * @brief POSIX 1003.1b - 5.2.1 - Change Current Working Directory + */ int rtems_filesystem_chdir( rtems_filesystem_location_info_t *loc ); int rtems_filesystem_chown( @@ -803,6 +811,6 @@ static inline bool rtems_filesystem_is_parent_directory( #ifdef __cplusplus } #endif - +/**@}*/ #endif /* end of include file */ |