RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

cpukit: Doxygen group fixes and many warnings addressed

Browse Source 
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.
This commit is contained in:
Joel Sherrill
2013-01-10 13:20:34 -06:00
parent ed70eaea0b
commit a15eaaf9fd
67 changed files with 216 additions and 229 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
cpukit/libcsupport/include/console.h
View File

@@ -47,7 +47,7 @@ extern "C" {
* @param[in] major is the device driver major number. * @param[in] major is the device driver major number.
* @param[in] minor is the device driver minor number. * @param[in] minor is the device driver minor number.
* @param[in] arg is the parameters to this call. * @param[in] arg is the parameters to this call.
*. *
* @retval RTEMS_SUCCESSFUL The device driver is successfully initialized. * @retval RTEMS_SUCCESSFUL The device driver is successfully initialized.
*/ */
rtems_device_driver console_initialize( rtems_device_driver console_initialize(

24
cpukit/libcsupport/include/rtems/deviceio.h
View File

@@ -1,8 +1,7 @@
/** /**
* @file * @file
* *
* @brief Map Operations on IMFS Device Nodes to the RTEMS Classic API * @brief Operations on IMFS Device Nodes
* IO Manager
*/ */
/* /*
@@ -17,15 +16,17 @@
#ifndef _RTEMS_DEVICEIO_H #ifndef _RTEMS_DEVICEIO_H
#define _RTEMS_DEVICEIO_H #define _RTEMS_DEVICEIO_H
/**
* @defgroup Device IO Handler
*
*
* @{
*/
#include <rtems/libio.h> #include <rtems/libio.h>
/**
* @defgroup IMFSDevices IMFS Device IO Handler
*
* @ingroup IMFS
*
* This contains the interface to device drivers using the RTEMS Classic API.
*/
/**@{*/
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif /* __cplusplus */ #endif /* __cplusplus */
@@ -79,12 +80,11 @@ int rtems_deviceio_control(
rtems_device_minor_number minor rtems_device_minor_number minor
); );
/** @} */
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/* __cplusplus */ /* __cplusplus */
/**@}*/
#endif /* _RTEMS_DEVICEIO_H */ #endif /* _RTEMS_DEVICEIO_H */

14
cpukit/libcsupport/include/rtems/error.h
View File

@@ -20,27 +20,32 @@
* It can also include a rtems_status value which can be OR'd * It can also include a rtems_status value which can be OR'd
* with the above flags. * * with the above flags. *
* *
* EXAMPLE * Example 1:
* @code
* #include <rtems.h> * #include <rtems.h>
* #include <rtems/error.h> * #include <rtems/error.h>
* rtems_error(0, "stray interrupt %d", intr); * rtems_error(0, "stray interrupt %d", intr);
* @endcode
* *
* EXAMPLE * Example 2:
* @code
* if ((status = rtems_task_create(...)) != RTEMS_SUCCCESSFUL) * if ((status = rtems_task_create(...)) != RTEMS_SUCCCESSFUL)
* { * {
* rtems_error(status | RTEMS_ERROR_ABORT, * rtems_error(status | RTEMS_ERROR_ABORT,
* "could not create task"); * "could not create task");
* } * }
* @endcode
* *
* EXAMPLE * Example 3:
* @code
* if ((fd = open(pathname, O_RDNLY)) < 0) * if ((fd = open(pathname, O_RDNLY)) < 0)
* { * {
* rtems_error(RTEMS_ERROR_ERRNO, "open of '%s' failed", pathname); * rtems_error(RTEMS_ERROR_ERRNO, "open of '%s' failed", pathname);
* goto failed; * goto failed;
* } * }
* @endcode
*/ */
#ifndef _RTEMS_RTEMS_ERROR_H #ifndef _RTEMS_RTEMS_ERROR_H
#define _RTEMS_RTEMS_ERROR_H #define _RTEMS_RTEMS_ERROR_H
@@ -59,7 +64,6 @@ extern "C" {
* @brief Defines and externs for rtems error reporting * @brief Defines and externs for rtems error reporting
* *
*/ */
typedef Internal_errors_t rtems_error_code_t; typedef Internal_errors_t rtems_error_code_t;
/* /*

8
cpukit/libcsupport/include/sys/utsname.h
View File

@@ -19,10 +19,11 @@
#define __POSIX_SYS_UTSNAME_h #define __POSIX_SYS_UTSNAME_h
/** /**
* @defgroup utsname Service * @defgroup UTSNAME utsname Service
* *
* @{ * @ingroup POSIXAPI
*/ */
/**@{*/
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
@@ -46,7 +47,8 @@ extern "C" {
#endif #endif
struct utsname { struct utsname {
char sysname[SYS_NMLN]; /* Name of this implementation of the operating system */ char sysname[SYS_NMLN]; /* Name of this implementation of the */
/* operating system */
char nodename[SYS_NMLN]; /* Name of this node within an implementation */ char nodename[SYS_NMLN]; /* Name of this node within an implementation */
/* specified communication network */ /* specified communication network */
char release[SYS_NMLN]; /* Current release level of this implementation */ char release[SYS_NMLN]; /* Current release level of this implementation */

18
cpukit/libfs/src/devfs/devfs.h
View File

@@ -12,18 +12,18 @@
#include <rtems/libio_.h> #include <rtems/libio_.h>
/**
* @defgroup DevFsDeviceTable Device Only File System
*
* @ingroup FileSystemTypesAndMount
*
* @brief This structure defines the type of device table
*/
/**@{*/
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif
/**
* @defgroup DevFsDeviceTable Define Device Table Type
*
* @ingroup DevFs
*
* @brief This structure defines the type of device table
*
* @{
*/
typedef struct { typedef struct {
/** This member points to device name which is not a null-terminated string */ /** This member points to device name which is not a null-terminated string */

60
cpukit/libfs/src/imfs/imfs.h
View File

@@ -21,18 +21,19 @@
#include <rtems/libio_.h> #include <rtems/libio_.h>
#include <rtems/pipe.h> #include <rtems/pipe.h>
/**
* @brief In-Memory File System Support.
*
* @defgroup IMFS In-Memory File System Support
*
* @ingroup FileSystemTypesAndMount
*/
/**@{*/
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif
/**
* @defgroup IMFS POSIX In-Memory File System Support
*
* @brief In-Memory File System Support.
*
* @{
*/
/* /*
* Data types * Data types
*/ */
@@ -66,7 +67,7 @@ typedef struct {
void *context; void *context;
} IMFS_generic_t; } IMFS_generic_t;
/* /**
* IMFS "memfile" information * IMFS "memfile" information
* *
* The data structure for the in-memory "memfiles" is based on classic UNIX. * The data structure for the in-memory "memfiles" is based on classic UNIX.
@@ -79,14 +80,15 @@ typedef struct {
* memory wasted due to internal file fragmentation. The following * memory wasted due to internal file fragmentation. The following
* is a list of maximum file sizes based on various settings * is a list of maximum file sizes based on various settings
* *
* @code
* max_filesize with blocks of 16 is 1,328 * max_filesize with blocks of 16 is 1,328
* max_filesize with blocks of 32 is 18,656 * max_filesize with blocks of 32 is 18,656
* max_filesize with blocks of 64 is 279,488 * max_filesize with blocks of 64 is 279,488
* max_filesize with blocks of 128 is 4,329,344 * max_filesize with blocks of 128 is 4,329,344
* max_filesize with blocks of 256 is 68,173,568 * max_filesize with blocks of 256 is 68,173,568
* max_filesize with blocks of 512 is 1,082,195,456 * max_filesize with blocks of 512 is 1,082,195,456
* @endcode
*/ */
#define IMFS_MEMFILE_DEFAULT_BYTES_PER_BLOCK 128 #define IMFS_MEMFILE_DEFAULT_BYTES_PER_BLOCK 128
extern int imfs_rq_memfile_bytes_per_block; extern int imfs_rq_memfile_bytes_per_block;
extern int imfs_memfile_bytes_per_block; extern int imfs_memfile_bytes_per_block;
@@ -113,7 +115,6 @@ typedef struct {
/* /*
* Important block numbers for "memfiles" * Important block numbers for "memfiles"
*/ */
#define FIRST_INDIRECT (0) #define FIRST_INDIRECT (0)
#define LAST_INDIRECT (IMFS_MEMFILE_BLOCK_SLOTS - 1) #define LAST_INDIRECT (IMFS_MEMFILE_BLOCK_SLOTS - 1)
@@ -134,7 +135,6 @@ typedef struct {
/* /*
* What types of IMFS file systems entities there can be. * What types of IMFS file systems entities there can be.
*/ */
typedef enum { typedef enum {
IMFS_DIRECTORY = RTEMS_FILESYSTEM_DIRECTORY, IMFS_DIRECTORY = RTEMS_FILESYSTEM_DIRECTORY,
IMFS_DEVICE = RTEMS_FILESYSTEM_DEVICE, IMFS_DEVICE = RTEMS_FILESYSTEM_DEVICE,
@@ -165,9 +165,8 @@ typedef union {
/** /**
* @addtogroup IMFSGenericNodes * @addtogroup IMFSGenericNodes
*
* @{
*/ */
/**@{*/
/** /**
* @brief Initializes an IMFS node. * @brief Initializes an IMFS node.
@@ -282,9 +281,8 @@ typedef struct {
/** /**
* @addtogroup IMFS * @addtogroup IMFS
*
* @{
*/ */
/**@{*/
/* /*
* Major device number for the IMFS. This is not a real device number because * Major device number for the IMFS. This is not a real device number because
@@ -435,6 +433,7 @@ extern void IMFS_fsunmount(
* *
* TAR file format: * TAR file format:
* *
* @code
* Offset Length Contents * Offset Length Contents
* 0 100 bytes File name ('\0' terminated, 99 maxmum length) * 0 100 bytes File name ('\0' terminated, 99 maxmum length)
* 100 8 bytes File mode (in octal ascii) * 100 8 bytes File mode (in octal ascii)
@@ -452,15 +451,19 @@ extern void IMFS_fsunmount(
* 329 8 bytes Major device ID (in octal ascii) * 329 8 bytes Major device ID (in octal ascii)
* 337 8 bytes Minor device ID (in octal ascii) * 337 8 bytes Minor device ID (in octal ascii)
* 345 167 bytes Padding * 345 167 bytes Padding
* 512 (s+p)bytes File contents (s+p) := (((s) + 511) & ~511), * 512 (s+p) bytes File contents (s+p) := (((s) + 511) & ~511),
* round up to 512 bytes * round up to 512 bytes
* @endcode
* *
* Checksum: * Checksum:
* @code
* int i, sum; * int i, sum;
* char* header = tar_header_pointer; * char *header = tar_header_pointer;
*
* sum = 0; * sum = 0;
* for(i = 0; i < 512; i++) * for (i = 0; i < 512; i++)
* sum += 0xFF & header[i]; * sum += 0xFF & header[i];
* @endcode
*/ */
extern int rtems_tarfs_load( extern int rtems_tarfs_load(
const char *mountpoint, const char *mountpoint,
@@ -616,9 +619,8 @@ extern bool IMFS_is_imfs_instance(
* more features like support for fsync() and fdatasync(). The generic nodes * more features like support for fsync() and fdatasync(). The generic nodes
* use the reference counting of the IMFS. This provides automatic node * use the reference counting of the IMFS. This provides automatic node
* destruction when the last reference vanishes. * destruction when the last reference vanishes.
*
* @{
*/ */
/**@{*/
/** /**
* @brief Makes a generic IMFS node. * @brief Makes a generic IMFS node.
@@ -671,9 +673,8 @@ extern int IMFS_make_generic_node(
/** /**
* @addtogroup IMFS * @addtogroup IMFS
*
* @{
*/ */
/**@{*/
/** /**
* @brief Mount an IMFS. * @brief Mount an IMFS.
@@ -731,9 +732,8 @@ extern ssize_t imfs_dir_read(
* malloc'ed memory. Thus any data stored in one of these files is lost * malloc'ed memory. Thus any data stored in one of these files is lost
* at system shutdown unless special arrangements to copy the data to * at system shutdown unless special arrangements to copy the data to
* some type of non-volailte storage are made by the application. * some type of non-volailte storage are made by the application.
*
* @{
*/ */
/**@{*/
/** /**
* @brief Open a memory file. * @brief Open a memory file.
@@ -777,9 +777,8 @@ extern ssize_t memfile_write(
* *
* This section contains the set of handlers used to map operations on * This section contains the set of handlers used to map operations on
* IMFS device nodes onto calls to the RTEMS Classic API IO Manager. * IMFS device nodes onto calls to the RTEMS Classic API IO Manager.
*
* @{
*/ */
/**@{*/
extern int device_open( extern int device_open(
rtems_libio_t *iop, /* IN */ rtems_libio_t *iop, /* IN */
@@ -959,9 +958,8 @@ static inline IMFS_jnode_t *IMFS_create_node(
/** /**
* @addtogroup IMFSGenericNodes * @addtogroup IMFSGenericNodes
*
* @{
*/ */
/**@{*/
static inline void *IMFS_generic_get_context_by_node( static inline void *IMFS_generic_get_context_by_node(
const IMFS_jnode_t *node const IMFS_jnode_t *node
@@ -996,11 +994,9 @@ static inline dev_t IMFS_generic_get_device_identifier_by_node(
); );
} }
/** @} */
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/** @} */
#endif #endif
/* end of include file */ /* end of include file */

17
cpukit/libfs/src/pipe/pipe.h
View File

@@ -20,18 +20,19 @@
#include <rtems/libio.h> #include <rtems/libio.h>
/**
* @defgroup FIFO_PIPE FIFO/Pipe File System Support
*
* @ingroup FileSystemTypesAndMount
*
* @brief Interface to the POSIX FIFO/Pipe File System
*/
/**@{*/
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif
/**
* @defgroup FIFO_PIPE FIFO/pipe File System Support
*
* @brief Interface to the POSIX FIFO/pipe File System
*
* @{
*/
/* Control block to manage each pipe */ /* Control block to manage each pipe */
typedef struct pipe_control { typedef struct pipe_control {
char *Buffer; char *Buffer;

2
cpukit/libfs/src/rfs/rtems-rfs-bitmaps.h
View File

@@ -3,7 +3,7 @@
* *
* @brief RTEMS File Systems Bitmap Routines * @brief RTEMS File Systems Bitmap Routines
* *
* @ingroup rtems-rfs * @ingroup rtems_rfs
* *
* RTEMS File Systems Bitmap Routines. * RTEMS File Systems Bitmap Routines.
* *

2
cpukit/libfs/src/rfs/rtems-rfs-block-pos.h
View File

@@ -3,7 +3,7 @@
* *
* @brief RTEMS File Systems Block Position and Size Management * @brief RTEMS File Systems Block Position and Size Management
* *
* @ingroup rtems-rfs * @ingroup rtems_rfs
* *
* RTEMS File Systems Block Position and Size Management. * RTEMS File Systems Block Position and Size Management.
* *

2
cpukit/libfs/src/rfs/rtems-rfs-block.h
View File

@@ -3,7 +3,7 @@
* *
* @brief RTEMS File Systems Block Management * @brief RTEMS File Systems Block Management
* *
* @ingroup rtems-rfs * @ingroup rtems_rfs
* *
* RTEMS File Systems Block Management. * RTEMS File Systems Block Management.
* *

2
cpukit/libfs/src/rfs/rtems-rfs-buffer.h
View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup rtems-rfs * @ingroup rtems_rfs
* *
* @brief Maps Blocks to the Media Interface Layers * @brief Maps Blocks to the Media Interface Layers
* *

2
cpukit/libfs/src/rfs/rtems-rfs-data.h
View File

@@ -3,7 +3,7 @@
* *
* @brief RTEMS File System Data * @brief RTEMS File System Data
* *
* @ingroup rtems-rfs * @ingroup rtems_rfs
* *
* RTEMS File System Data. * RTEMS File System Data.
* *

2
cpukit/libfs/src/rfs/rtems-rfs-dir-hash.h
View File

@@ -3,7 +3,7 @@
* *
* @brief Provides a 32bit Hash of a String used to Search a Directory * @brief Provides a 32bit Hash of a String used to Search a Directory
* *
* @ingroup rtems-rfs * @ingroup rtems_rfs
* *
* RTEMS File Systems Directory Hash provides a 32bit hash of a string. This is * RTEMS File Systems Directory Hash provides a 32bit hash of a string. This is
* used to search a directory. * used to search a directory.

2
cpukit/libfs/src/rfs/rtems-rfs-dir.h
View File

@@ -3,7 +3,7 @@
* *
* @brief RTEMS File System Directory Support * @brief RTEMS File System Directory Support
* *
* @ingroup rtems-rfs * @ingroup rtems_rfs
* *
* RTEMS File System Directory Support * RTEMS File System Directory Support
* *

2
cpukit/libfs/src/rfs/rtems-rfs-file-system-fwd.h
View File

@@ -3,7 +3,7 @@
* *
* @brief RTEMS File Systems Data Forward Declaration * @brief RTEMS File Systems Data Forward Declaration
* *
* @ingroup rtems-rfs * @ingroup rtems_rfs
* *
* RTEMS File Systems Data forward decl. * RTEMS File Systems Data forward decl.
*/ */

2
cpukit/libfs/src/rfs/rtems-rfs-file-system.h
View File

@@ -3,7 +3,7 @@
* *
* @brief RTEMS File System Data * @brief RTEMS File System Data
* *
* @ingroup rtems-rfs * @ingroup rtems_rfs
* *
* RTEMS File System Data * RTEMS File System Data
* *

2
cpukit/libfs/src/rfs/rtems-rfs-file.h
View File

@@ -3,7 +3,7 @@
* *
* @brief RTEMS File System File Support * @brief RTEMS File System File Support
* *
* @ingroup rtems-rfs * @ingroup rtems_rfs
* *
* RTEMS File System File Support * RTEMS File System File Support
* *

2
cpukit/libfs/src/rfs/rtems-rfs-format.h
View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup rtems-rfs * @ingroup rtems_rfs
* *
* @brief RTEMS File System Format * @brief RTEMS File System Format
* *

8
cpukit/libfs/src/rfs/rtems-rfs-group.h
View File

@@ -3,7 +3,7 @@
* *
* @brief RTEMS File Systems Group Management * @brief RTEMS File Systems Group Management
* *
* @ingroup rtems-rfs * @ingroup rtems_rfs
* *
* RTEMS File Systems Group Management. * RTEMS File Systems Group Management.
* *
@@ -23,11 +23,11 @@
#define _RTEMS_RFS_GROUP_H_ #define _RTEMS_RFS_GROUP_H_
/** /**
* @defgroup rtems-rfs FS Group Management * @ingroup rtems_rfs
* *
* @ingroup rfs * RTEMS File System Group Management
* @{
*/ */
/**@{*/
#include <rtems/rfs/rtems-rfs-trace.h> #include <rtems/rfs/rtems-rfs-trace.h>
#include <rtems/rfs/rtems-rfs-bitmaps.h> #include <rtems/rfs/rtems-rfs-bitmaps.h>

2
cpukit/libfs/src/rfs/rtems-rfs-inode.h
View File

@@ -3,7 +3,7 @@
* *
* @brief RTEMS File System Information Node * @brief RTEMS File System Information Node
* *
* @ingroup rtems-rfs * @ingroup rtems_rfs
* *
* RTEMS File System Information Node. * RTEMS File System Information Node.
* *

2
cpukit/libfs/src/rfs/rtems-rfs-link.h
View File

@@ -3,7 +3,7 @@
* *
* @brief RTEMS File System Link Support * @brief RTEMS File System Link Support
* *
* @ingroup rtems-rfs * @ingroup rtems_rfs
* *
* RTEMS File System Link Support * RTEMS File System Link Support
* *

2
cpukit/libfs/src/rfs/rtems-rfs-mutex.h
View File

@@ -3,7 +3,7 @@
* *
* @brief RTEMS File System Mutex * @brief RTEMS File System Mutex
* *
* @ingroup rtems-rfs * @ingroup rtems_rfs
* *
* RTEMS File System Mutex. * RTEMS File System Mutex.
* *

2
cpukit/libfs/src/rfs/rtems-rfs-rtems.h
View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup rtems-rfs * @ingroup rtems_rfs
* *
* RTEMS File System RTEMS Header file. * RTEMS File System RTEMS Header file.
* *

2
cpukit/libfs/src/rfs/rtems-rfs-shell.h
View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup rtems-rfs * @ingroup rtems_rfs
* @brief RTEMS File Systems Shell Commands * @brief RTEMS File Systems Shell Commands
* *
* RTEMS File Systems Shell commands provide a CLI interface to support and * RTEMS File Systems Shell commands provide a CLI interface to support and

2
cpukit/libfs/src/rfs/rtems-rfs-trace.h
View File

@@ -4,7 +4,7 @@
* @brief Manages the Trace and Debugging Features of the * @brief Manages the Trace and Debugging Features of the
* RTEMS RFS File System * RTEMS RFS File System
* *
* @ingroup rtems-rfs * @ingroup rtems_rfs
* *
* RTEMS File Systems Trace manages the trace and debugging features of the * RTEMS File Systems Trace manages the trace and debugging features of the
* RTEMS RFS file system. The design allows all tracing code and strings to be * RTEMS RFS file system. The design allows all tracing code and strings to be

10
cpukit/libfs/src/rfs/rtems-rfs.h
View File

@@ -2,7 +2,7 @@
* @file * @file
* *
* @brief RFS File system Initialization * @brief RFS File system Initialization
* @ingroup rtems-rfs * @ingroup rtems_rfs
* *
* RTEMS File System * RTEMS File System
* *
@@ -22,9 +22,17 @@
#include <rtems.h> #include <rtems.h>
#include <rtems/fs.h> #include <rtems/fs.h>
/**
* @defgroup rtems_rfs RTEMS File System Group Management
*
* @ingroup FileSystemTypesAndMount
*/
/**@{*/
/** /**
* Initialise the RFS File system. * Initialise the RFS File system.
*/ */
int rtems_rfs_rtems_initialise (rtems_filesystem_mount_table_entry_t *mt_entry); int rtems_rfs_rtems_initialise (rtems_filesystem_mount_table_entry_t *mt_entry);
/**@}*/
#endif #endif

5
cpukit/libmisc/devnull/devnull.h
View File

@@ -21,14 +21,15 @@
#ifndef _RTEMS_DEVNULL_H #ifndef _RTEMS_DEVNULL_H
#define _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 * @ingroup libmisc
*/ */
/**@{*/ /**@{*/
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif

12
cpukit/libmisc/devnull/devzero.h
View File

@@ -1,9 +1,6 @@
/** /**
* @file rtems/devzero.h * @file rtems/devzero.h
* *
* @defgroup libmisc_devzero Device Driver
*
* @ingroup libmisc
* @brief RTEMS /dev/zero Device Driver * @brief RTEMS /dev/zero Device Driver
* *
* This include file defines the interface to the RTEMS /dev/zero * This include file defines the interface to the RTEMS /dev/zero
@@ -29,6 +26,13 @@
#include <rtems/io.h> #include <rtems/io.h>
/**
* @defgroup libmisc_devzero Zero Device Driver
*
* @ingroup libmisc
*/
/**@{*/
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif /* __cplusplus */ #endif /* __cplusplus */
@@ -84,5 +88,5 @@ rtems_device_driver dev_zero_control(
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif /* __cplusplus */ #endif /* __cplusplus */
/**@}*/
#endif /* _RTEMS_DEVZERO_H */ #endif /* _RTEMS_DEVZERO_H */

13
cpukit/libmisc/fb/fb.h
View File

@@ -1,9 +1,6 @@
/** /**
* @file rtems/fb.h * @file rtems/fb.h
* *
* @defgroup libmisc_fb Device Driver
*
* @ingroup libmisc
* @brief Frame Buffer Device Driver * @brief Frame Buffer Device Driver
* *
* This file defines the interface to a frame buffer device driver. * This file defines the interface to a frame buffer device driver.
@@ -21,6 +18,13 @@
#include <stdint.h> #include <stdint.h>
/**
* @defgroup libmisc_fb Frame Buffer Device Driver Interface
*
* @ingroup Device Drivers and Frameworks
*/
/**@{*/
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif
@@ -92,10 +96,9 @@ struct fb_cmap {
uint16_t *transp; /* transparency, can be NULL */ uint16_t *transp; /* transparency, can be NULL */
}; };
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/**@}*/
#endif /* _MW_FB_H */ #endif /* _MW_FB_H */

7
cpukit/libmisc/mouse/mouse_parser.h
View File

@@ -1,9 +1,6 @@
/** /**
* @file rtems/mouse_parser.h * @file rtems/mouse_parser.h
* *
* @defgroup libmisc_mouse Mouse Parser Engine
*
* @ingroup libmisc
* @brief Initialize Mouse Parser Engine * @brief Initialize Mouse Parser Engine
* *
* This file is the header file for the Mouse Parser Engine. * This file is the header file for the Mouse Parser Engine.
@@ -42,13 +39,11 @@
#include <rtems/mw_uid.h> #include <rtems/mw_uid.h>
/** /**
* @defgroup libmisc_mouse Mouse Support
* @ingroup libmisc
*
* @defgroup libmisc_mouseparser Mouse Parser Engine * @defgroup libmisc_mouseparser Mouse Parser Engine
* @ingroup libmisc_mouse * @ingroup libmisc_mouse
*/ */
/**@{*/ /**@{*/
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif

2
cpukit/posix/include/aio.h
View File

@@ -28,7 +28,7 @@ extern "C" {
/** /**
* @defgroup POSIX_AIO POSIX Asynchronous I/O Support * @defgroup POSIX_AIO POSIX Asynchronous I/O Support
* *
* @ingroup POSIX * @ingroup POSIXAPI
* *
* @brief POSIX Asynchronous Input and Output * @brief POSIX Asynchronous Input and Output
* *

2
cpukit/posix/include/mqueue.h
View File

@@ -43,7 +43,7 @@
/** /**
* @defgroup POSIX_MQUEUE POSIX Message Queues * @defgroup POSIX_MQUEUE POSIX Message Queues
* *
* @ingroup POSIX * @ingroup POSIXAPI
* *
* @{ * @{
*/ */

2
cpukit/posix/include/rtems/posix/cond.h
View File

@@ -22,7 +22,7 @@
/** /**
* @defgroup POSIX_COND_VARS POSIX Condition Variables * @defgroup POSIX_COND_VARS POSIX Condition Variables
* *
* @ingroup POSIX * @ingroup POSIXAPI
* *
* @{ * @{
*/ */

2
cpukit/posix/include/rtems/posix/key.h
View File

@@ -24,7 +24,7 @@
/** /**
* @defgroup POSIX_KEY POSIX Key * @defgroup POSIX_KEY POSIX Key
* *
* @ingroup POSIX * @ingroup POSIXAPI
* *
* @{ * @{
*/ */

2
cpukit/posix/include/rtems/posix/mqueue.h
View File

@@ -40,7 +40,7 @@
/** /**
* @defgroup POSIX_MQUEUE_P Message Queues Private Support * @defgroup POSIX_MQUEUE_P Message Queues Private Support
* *
* @ingroup POSIX_MQUEUE * @ingroup POSIXAPI
* *
* @{ * @{
*/ */

2
cpukit/posix/include/rtems/posix/mutex.h
View File

@@ -26,7 +26,7 @@ extern "C" {
/** /**
* @defgroup POSIX_MUTEX POSIX Mutex Support * @defgroup POSIX_MUTEX POSIX Mutex Support
* *
* @ingroup POSIX * @ingroup POSIXAPI
* *
* @brief Private Support Information for POSIX Mutex * @brief Private Support Information for POSIX Mutex
* *

2
cpukit/posix/include/rtems/posix/priority.h
View File

@@ -22,7 +22,7 @@
/** /**
* @defgroup POSIX_PRIORITY POSIX Priority Support * @defgroup POSIX_PRIORITY POSIX Priority Support
* *
* @ingroup POSIX * @ingroup POSIXAPI
* *
* @brief Interface to the POSIX Priority Implementation * @brief Interface to the POSIX Priority Implementation
* *

2
cpukit/posix/include/rtems/posix/psignalimpl.h
View File

@@ -21,7 +21,7 @@
/** /**
* @defgroup POSIX_SIGNALS POSIX Signals Support * @defgroup POSIX_SIGNALS POSIX Signals Support
* *
* @ingroup POSIX * @ingroup POSIXAPI
* *
* @brief Internal Information about POSIX Signals * @brief Internal Information about POSIX Signals
* *

2
cpukit/posix/include/rtems/posix/pthread.h
View File

@@ -30,7 +30,7 @@ extern "C" {
/** /**
* @defgroup POSIX_PTHREAD POSIX Threads Support * @defgroup POSIX_PTHREAD POSIX Threads Support
* *
* @ingroup POSIX * @ingroup POSIXAPI
* *
* @brief Private Support Information for POSIX Threads * @brief Private Support Information for POSIX Threads
* *

2
cpukit/posix/include/rtems/posix/ptimer.h
View File

@@ -25,7 +25,7 @@
/** /**
* @defgroup POSIX_PRIV_TIMERS POSIX Timers * @defgroup POSIX_PRIV_TIMERS POSIX Timers
* *
* @ingroup POSIX * @ingroup POSIXAPI
* *
* @{ * @{
*/ */

2
cpukit/posix/include/rtems/posix/rwlock.h
View File

@@ -32,7 +32,7 @@ extern "C" {
/** /**
* @defgroup POSIX_RWLOCK POSIX RWLock Manager * @defgroup POSIX_RWLOCK POSIX RWLock Manager
* *
* @ingroup POSIX * @ingroup POSIXAPI
* *
* @brief Constants and Structures Associated with the POSIX RWLock Manager * @brief Constants and Structures Associated with the POSIX RWLock Manager
* *

8
cpukit/posix/include/rtems/posix/semaphore.h
View File

@@ -20,10 +20,14 @@
#define _RTEMS_POSIX_SEMAPHORE_H #define _RTEMS_POSIX_SEMAPHORE_H
/** /**
* @addtogroup POSIX_SEMAPHORES * @defgroup POSIXSemaphorePrivate POSIX Semaphore Private Support
* *
* @{ * @ingroup POSIXAPI
*
* This defines the internal implementation support for POSIX semaphores.
*/ */
/**@{*/
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif

2
cpukit/posix/include/rtems/posix/spinlock.h
View File

@@ -32,7 +32,7 @@ extern "C" {
/** /**
* @defgroup POSIX_SPINLOCK POSIX Spinlock Support * @defgroup POSIX_SPINLOCK POSIX Spinlock Support
* *
* @ingroup POSIX * @ingroup POSIXAPI
* *
* @brief Constants and Structures Associated with the POSIX Spinlock Manager * @brief Constants and Structures Associated with the POSIX Spinlock Manager
* *

4
cpukit/posix/include/rtems/posix/threadsup.h
View File

@@ -23,9 +23,9 @@
#include <rtems/score/tqdata.h> #include <rtems/score/tqdata.h>
/** /**
* @defgroup POSIX_THREAD Thread API Extension * @defgroup POSIX_THREAD POSIX Thread API Extension
* *
* @ingroup POSIX * @ingroup POSIXAPI
* *
* @{ * @{
*/ */

2
cpukit/posix/include/rtems/posix/time.h
View File

@@ -24,7 +24,7 @@
/** /**
* @defgroup POSIX_TIMETYPES POSIX Time Types * @defgroup POSIX_TIMETYPES POSIX Time Types
* *
* @ingroup POSIX * @ingroup POSIXAPI
* *
* @{ * @{
*/ */

8
cpukit/posix/include/rtems/posix/timer.h
View File

@@ -24,12 +24,11 @@
#include <rtems/score/watchdog.h> /* Watchdog_Control */ #include <rtems/score/watchdog.h> /* Watchdog_Control */
/** /**
* @defgroup POSIX_INTERNAL_TIMERS Timers * @defgroup POSIX_INTERNAL_TIMERS POSIX Timer Private Support
* *
* @ingroup POSIX * @ingroup POSIXAPI
*
* @{
*/ */
/**@{*/
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
@@ -59,7 +58,6 @@ extern "C" {
#error "POSIX_TIMER_RELATIVE == TIMER_ABSTIME" #error "POSIX_TIMER_RELATIVE == TIMER_ABSTIME"
#endif #endif
/* /*
* Data for a timer * Data for a timer
*/ */

2
cpukit/posix/include/semaphore.h
View File

@@ -26,7 +26,7 @@ extern "C" {
/** /**
* @defgroup POSIX_SEMAPHORE POSIX Semaphores Support * @defgroup POSIX_SEMAPHORE POSIX Semaphores Support
* *
* @ingroup POSIX * @ingroup POSIXAPI
* *
* @brief Private Support Information for POSIX Semaphores * @brief Private Support Information for POSIX Semaphores
*/ */

4
cpukit/rtems/include/rtems.h
View File

@@ -3,7 +3,6 @@
* *
* @defgroup ClassicRTEMS RTEMS Classic API * @defgroup ClassicRTEMS RTEMS Classic API
* *
* @ingroup ClassicRTEMS
* @brief RTEMS Classic API * @brief RTEMS Classic API
* *
* the Public Interface to the RTEMS Classic API * the Public Interface to the RTEMS Classic API
@@ -24,9 +23,8 @@
* @defgroup ClassicRTEMS RTEMS Classic API * @defgroup ClassicRTEMS RTEMS Classic API
* *
* RTEMS Classic API definitions and modules. * RTEMS Classic API definitions and modules.
*
* @{
*/ */
/**@{*/
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {

5
cpukit/rtems/include/rtems/rtems/barriermp.h
View File

@@ -1,9 +1,6 @@
/** /**
* @file rtems/rtems/barriermp.h * @file rtems/rtems/barriermp.h
* *
* @defgroup ClassicBarrierMP Barrier MP Support
*
* @ingroup ClassicMP
* @brief MP Support in the Barrier Manager * @brief MP Support in the Barrier Manager
* *
* This include file contains all the constants and structures associated * This include file contains all the constants and structures associated
@@ -28,7 +25,7 @@
* *
* This encapsulates functionality which XXX * This encapsulates functionality which XXX
*/ */
/**{*/ /**@{*/
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {

5
cpukit/rtems/include/rtems/rtems/msgmp.h
View File

@@ -1,9 +1,6 @@
/** /**
* @file rtems/rtems/msgmp.h * @file rtems/rtems/msgmp.h
* *
* @defgroup ClassicMsgMP Message Queue MP Support
*
* @ingroup ClassicRTEMS
* @brief Message Manager MP Support * @brief Message Manager MP Support
* *
* This include file contains all the constants and structures associated * This include file contains all the constants and structures associated
@@ -39,7 +36,7 @@ extern "C" {
* *
* This encapsulates functionality which XXX * This encapsulates functionality which XXX
*/ */
/**{*/ /*{*/
/** /**
* The following enumerated type defines the list of * The following enumerated type defines the list of

5
cpukit/rtems/include/rtems/rtems/partmp.h
View File

@@ -1,9 +1,6 @@
/** /**
* @file rtems/rtems/partmp.h * @file rtems/rtems/partmp.h
* *
* @defgroup ClassicPartMP Partition MP Support
*
* @ingroup ClassicMP
* @brief MP Support in Partition Manager * @brief MP Support in Partition Manager
* *
* This include file contains all the constants and structures associated * This include file contains all the constants and structures associated
@@ -39,7 +36,7 @@ extern "C" {
* *
* This encapsulates functionality which XXX * This encapsulates functionality which XXX
*/ */
/**{*/ /*{*/
/** /**
* The following enumerated type defines the list of * The following enumerated type defines the list of

3
cpukit/rtems/include/rtems/rtems/sem.h
View File

@@ -1,10 +1,11 @@
/** /**
* @file rtems/rtems/sem.h * @file rtems/rtems/sem.h
* *
* @brief Semaphore Manager
*
* @defgroup ClassicSem Semaphores * @defgroup ClassicSem Semaphores
* *
* @ingroup ClassicRTEMS * @ingroup ClassicRTEMS
* @brief Semaphore Manager
* *
* This include file contains all the constants and structures associated * This include file contains all the constants and structures associated
* with the Semaphore Manager. This manager utilizes standard Dijkstra * with the Semaphore Manager. This manager utilizes standard Dijkstra

5
cpukit/rtems/include/rtems/rtems/signalmp.h
View File

@@ -1,9 +1,6 @@
/** /**
* @file rtems/rtems/signalmp.h * @file rtems/rtems/signalmp.h
* *
* @defgroup ClassicSignalMP Signal MP Support
*
* @ingroup ClassicRTEMS
* @brief Signal MP Support * @brief Signal MP Support
* *
* This include file contains all the constants and structures associated * This include file contains all the constants and structures associated
@@ -38,7 +35,7 @@ extern "C" {
* *
* This encapsulates functionality which XXX * This encapsulates functionality which XXX
*/ */
/**{*/ /*{*/
/** /**
* The following enumerated type defines the list of * The following enumerated type defines the list of

3
cpukit/rtems/mainpage.h
View File

@@ -391,11 +391,10 @@
* of RTEMS' concepts and features are interrelated. Experienced RTEMS users * of RTEMS' concepts and features are interrelated. Experienced RTEMS users
* will find that the manual organization facilitates its use as a reference * will find that the manual organization facilitates its use as a reference
* document. * document.
*
*/ */
/** /**
* @addtogroup ClassicRTEMS * @addtogroup ClassicAPI
* *
* The facilities provided by RTEMS are built upon a foundation of very * The facilities provided by RTEMS are built upon a foundation of very
* powerful concepts. These concepts must be understood before the application * powerful concepts. These concepts must be understood before the application

7
cpukit/sapi/include/rtems/rbheap.h
View File

@@ -1,8 +1,6 @@
/** /**
* @file * @file
* *
* @ingroup RBHeap
*
* @brief Red-Black Tree Heap API * @brief Red-Black Tree Heap API
*/ */
@@ -34,6 +32,8 @@ extern "C" {
/** /**
* @defgroup RBHeap Red-Black Tree Heap * @defgroup RBHeap Red-Black Tree Heap
* *
* @ingroup ClassicRTEMS
*
* @brief Red-Black Tree Heap API. * @brief Red-Black Tree Heap API.
* *
* The red-black tree heap provides a memory allocator suitable to implement * The red-black tree heap provides a memory allocator suitable to implement
@@ -45,9 +45,8 @@ extern "C" {
* by other tasks. The allocated and free memory parts of the managed area are * by other tasks. The allocated and free memory parts of the managed area are
* called chunks. Each chunk needs a descriptor which is stored outside of the * called chunks. Each chunk needs a descriptor which is stored outside of the
* managed area. * managed area.
*
* @{
*/ */
/**@{*/
/** /**
* @brief Red-black heap chunk descriptor. * @brief Red-black heap chunk descriptor.

2
cpukit/score/include/rtems/score/copyrt.h
View File

@@ -20,7 +20,7 @@
#define _RTEMS_SCORE_COPYRT_H #define _RTEMS_SCORE_COPYRT_H
/** /**
* @defgroup SuperCore RTEMS Copyright Notice * @defgroup SuperCoreCopyright RTEMS Copyright Notice
* *
* @ingroup Score * @ingroup Score
*/ */

4
cpukit/score/include/rtems/score/prioritybitmap.h
View File

@@ -20,11 +20,9 @@
#define _RTEMS_SCORE_PRIORITYBITMAP_H #define _RTEMS_SCORE_PRIORITYBITMAP_H
/** /**
* @defgroup ScorePriority Bitmap Priority Thread Routines * @defgroup ScorePriorityBitmap Bitmap Priority Thread Routines
* *
* @ingroup Score * @ingroup Score
*
* @addtogroup ScorePriority
*/ */
/**@{*/ /**@{*/

6
cpukit/score/include/rtems/score/schedulercbs.h
View File

@@ -33,11 +33,9 @@ extern "C" {
#endif #endif
/** /**
* @defgroup ScoreScheduler CBS Scheduler * @defgroup ScoreSchedulerCBS CBS Scheduler
* *
* @ingroup Score * @ingroup ScoreScheduler
*
* @addtogroup ScoreScheduler
*/ */
/**@{*/ /**@{*/

7
cpukit/score/include/rtems/score/scheduleredf.h
View File

@@ -29,12 +29,9 @@ extern "C" {
#endif #endif
/** /**
* @defgroup ScoreScheduler * @defgroup ScoreSchedulerEDF EDF Scheduler
*
* @ingroup Score
*
* @addtogroup ScoreScheduler
* *
* @ingroup ScoreScheduler
*/ */
/**@{*/ /**@{*/

6
cpukit/score/include/rtems/score/schedulerpriority.h
View File

@@ -28,11 +28,9 @@ extern "C" {
#endif #endif
/** /**
* @defgroup ScoreScheduler Priority-based Scheduler * @defgroup ScoreSchedulerDPS Deterministic Priority-based Scheduler
* *
* @ingroup Score * @ingroup ScoreScheduler
*
* @addtogroup ScoreScheduler
*/ */
/**@{*/ /**@{*/

8
cpukit/score/include/rtems/score/schedulersimple.h
View File

@@ -19,11 +19,9 @@
#define _RTEMS_SCORE_SCHEDULERSIMPLE_H #define _RTEMS_SCORE_SCHEDULERSIMPLE_H
/** /**
* @defgroup ScoreScheduler * @defgroup ScoreSchedulerSimple Simple Priority Scheduler
* *
* @ingroup Score * @ingroup ScoreScheduler
*
* @addtogroup ScoreScheduler
*/ */
/**@{*/ /**@{*/
@@ -166,7 +164,7 @@ void *_Scheduler_simple_Allocate(
); );
/** /**
* @breif Stub for simple schedule update. * @brief Stub for simple schedule update.
* *
* This routine does nothing, and is used as a stub for Schedule update * This routine does nothing, and is used as a stub for Schedule update
* The overhead of a function call will still be imposed. * The overhead of a function call will still be imposed.

6
cpukit/score/include/rtems/score/schedulersimplesmp.h
View File

@@ -23,11 +23,9 @@
#define _RTEMS_SCORE_SCHEDULERSIMPLE_SMP_H #define _RTEMS_SCORE_SCHEDULERSIMPLE_SMP_H
/** /**
* @defgroup ScoreScheduler * @defgroup ScoreSchedulerSMP Simple SMP Scheduler
* *
* @ingroup Score * @ingroup ScoreScheduler
*
* @addtogroup ScoreScheduler
* *
* The Simple SMP Scheduler attempts to faithfully implement the * The Simple SMP Scheduler attempts to faithfully implement the
* behaviour of the Deterministic Priority Scheduler while spreading * behaviour of the Deterministic Priority Scheduler while spreading

4
cpukit/score/include/rtems/score/smp.h
View File

@@ -23,7 +23,7 @@
#include <rtems/score/percpu.h> #include <rtems/score/percpu.h>
/** /**
* @defgroup SuperCore SMP Support * @defgroup SuperCoreSMP SMP Support
* *
* @ingroup Score * @ingroup Score
* *
@@ -105,7 +105,7 @@ void _SMP_Request_other_cores_to_perform_first_context_switch(void);
void _SMP_Request_other_cores_to_dispatch(void); void _SMP_Request_other_cores_to_dispatch(void);
/** /**
* @Brief Request other cores to shutdown. * @brief Request other cores to shutdown.
* *
* Send message to other cores requesting them to shutdown. * Send message to other cores requesting them to shutdown.
*/ */

5
cpukit/score/include/rtems/score/states.h
View File

@@ -3,7 +3,7 @@
* *
* @brief Thread Execution State Information * @brief Thread Execution State Information
* *
* This include file contains thread execution state information. * This include file defines thread execution state information.
*/ */
/* /*
@@ -19,8 +19,7 @@
#define _RTEMS_SCORE_STATES_H #define _RTEMS_SCORE_STATES_H
/** /**
* @defgroup Encapsulates functionality which relates to the management of * @defgroup ScoreStates SuperCore Thread States
* the state bitmap associated with each thread.
* *
* @ingroup Score * @ingroup Score
* *

2
cpukit/score/include/rtems/score/timestamp.h
View File

@@ -19,7 +19,7 @@
#define _RTEMS_SCORE_TIMESTAMP_H #define _RTEMS_SCORE_TIMESTAMP_H
/** /**
* @defgroup SuperCore Timestamp * @defgroup SuperCoreTimeStamp Score Timestamp
* *
* @ingroup Score * @ingroup Score
* *

2
cpukit/score/include/rtems/score/timestamp64.h
View File

@@ -20,7 +20,7 @@
#define _RTEMS_SCORE_TIMESTAMP64_H #define _RTEMS_SCORE_TIMESTAMP64_H
/** /**
* @defgroup SuperCore Timestamp64 * @defgroup SuperCoreTimestamp64 SuperCore Sixty-Four Bit Timestamps
* *
* @ingroup Score * @ingroup Score
* *