diff options
author | Joel Sherrill <joel.sherrill@oarcorp.com> | 2013-01-10 13:20:34 -0600 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2013-01-10 17:06:47 -0600 |
commit | a15eaaf9fdba8a9311623ae44711d17701a19d30 (patch) | |
tree | eb6f4439e820390ad8b0f8ed5a10ed6835461548 /cpukit/libmisc | |
parent | score: Doxygen Clean Up Task #14 (diff) | |
download | rtems-a15eaaf9fdba8a9311623ae44711d17701a19d30.tar.bz2 |
cpukit: Doxygen group fixes and many warnings addressed
The output of the modules.html is much improved. Most
filesystem and POSIX API related groups are properly nested.
Some formatting issues were addressed as were multiple
inconsistencies.
Diffstat (limited to 'cpukit/libmisc')
-rw-r--r-- | cpukit/libmisc/devnull/devnull.h | 5 | ||||
-rw-r--r-- | cpukit/libmisc/devnull/devzero.h | 12 | ||||
-rw-r--r-- | cpukit/libmisc/fb/fb.h | 13 | ||||
-rw-r--r-- | cpukit/libmisc/mouse/mouse_parser.h | 7 |
4 files changed, 20 insertions, 17 deletions
diff --git a/cpukit/libmisc/devnull/devnull.h b/cpukit/libmisc/devnull/devnull.h index 61fa60a33a..0eae69751c 100644 --- a/cpukit/libmisc/devnull/devnull.h +++ b/cpukit/libmisc/devnull/devnull.h @@ -21,14 +21,15 @@ #ifndef _RTEMS_DEVNULL_H #define _RTEMS_DEVNULL_H -#include <rtems/io.h> /* rtems_device_driver */ +#include <rtems/io.h> /** - * @defgroup libmisc_devnull Device Driver + * @defgroup libmisc_devnull Null Device Driver * * @ingroup libmisc */ /**@{*/ + #ifdef __cplusplus extern "C" { #endif diff --git a/cpukit/libmisc/devnull/devzero.h b/cpukit/libmisc/devnull/devzero.h index 6a37ca1da8..2f10e0f507 100644 --- a/cpukit/libmisc/devnull/devzero.h +++ b/cpukit/libmisc/devnull/devzero.h @@ -1,9 +1,6 @@ /** * @file rtems/devzero.h * - * @defgroup libmisc_devzero Device Driver - * - * @ingroup libmisc * @brief RTEMS /dev/zero Device Driver * * This include file defines the interface to the RTEMS /dev/zero @@ -29,6 +26,13 @@ #include <rtems/io.h> +/** + * @defgroup libmisc_devzero Zero Device Driver + * + * @ingroup libmisc + */ +/**@{*/ + #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ @@ -84,5 +88,5 @@ rtems_device_driver dev_zero_control( #ifdef __cplusplus } #endif /* __cplusplus */ - +/**@}*/ #endif /* _RTEMS_DEVZERO_H */ diff --git a/cpukit/libmisc/fb/fb.h b/cpukit/libmisc/fb/fb.h index 2304405a95..e268418a3a 100644 --- a/cpukit/libmisc/fb/fb.h +++ b/cpukit/libmisc/fb/fb.h @@ -1,9 +1,6 @@ /** * @file rtems/fb.h * - * @defgroup libmisc_fb Device Driver - * - * @ingroup libmisc * @brief Frame Buffer Device Driver * * This file defines the interface to a frame buffer device driver. @@ -21,6 +18,13 @@ #include <stdint.h> +/** + * @defgroup libmisc_fb Frame Buffer Device Driver Interface + * + * @ingroup Device Drivers and Frameworks + */ +/**@{*/ + #ifdef __cplusplus extern "C" { #endif @@ -92,10 +96,9 @@ struct fb_cmap { uint16_t *transp; /* transparency, can be NULL */ }; - - #ifdef __cplusplus } #endif +/**@}*/ #endif /* _MW_FB_H */ diff --git a/cpukit/libmisc/mouse/mouse_parser.h b/cpukit/libmisc/mouse/mouse_parser.h index 3d2dad1695..27bea1bbbc 100644 --- a/cpukit/libmisc/mouse/mouse_parser.h +++ b/cpukit/libmisc/mouse/mouse_parser.h @@ -1,9 +1,6 @@ /** * @file rtems/mouse_parser.h * - * @defgroup libmisc_mouse Mouse Parser Engine - * - * @ingroup libmisc * @brief Initialize Mouse Parser Engine * * This file is the header file for the Mouse Parser Engine. @@ -42,13 +39,11 @@ #include <rtems/mw_uid.h> /** - * @defgroup libmisc_mouse Mouse Support - * @ingroup libmisc - * * @defgroup libmisc_mouseparser Mouse Parser Engine * @ingroup libmisc_mouse */ /**@{*/ + #ifdef __cplusplus extern "C" { #endif |