summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@oarcorp.com>2013-01-10 13:20:34 -0600
committerJoel Sherrill <joel.sherrill@oarcorp.com>2013-01-10 17:06:47 -0600
commita15eaaf9fdba8a9311623ae44711d17701a19d30 (patch)
treeeb6f4439e820390ad8b0f8ed5a10ed6835461548
parentscore: Doxygen Clean Up Task #14 (diff)
downloadrtems-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.
-rw-r--r--cpukit/libcsupport/include/console.h2
-rw-r--r--cpukit/libcsupport/include/rtems/deviceio.h20
-rw-r--r--cpukit/libcsupport/include/rtems/error.h14
-rw-r--r--cpukit/libcsupport/include/sys/utsname.h8
-rw-r--r--cpukit/libfs/src/devfs/devfs.h14
-rw-r--r--cpukit/libfs/src/imfs/imfs.h100
-rw-r--r--cpukit/libfs/src/pipe/pipe.h15
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-bitmaps.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-block-pos.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-block.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-buffer.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-data.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-dir-hash.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-dir.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-file-system-fwd.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-file-system.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-file.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-format.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-group.h10
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-inode.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-link.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-mutex.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-rtems.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-shell.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-trace.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs.h10
-rw-r--r--cpukit/libmisc/devnull/devnull.h5
-rw-r--r--cpukit/libmisc/devnull/devzero.h12
-rw-r--r--cpukit/libmisc/fb/fb.h13
-rw-r--r--cpukit/libmisc/mouse/mouse_parser.h7
-rw-r--r--cpukit/posix/include/aio.h2
-rw-r--r--cpukit/posix/include/mqueue.h2
-rw-r--r--cpukit/posix/include/rtems/posix/cond.h2
-rw-r--r--cpukit/posix/include/rtems/posix/key.h2
-rw-r--r--cpukit/posix/include/rtems/posix/mqueue.h2
-rw-r--r--cpukit/posix/include/rtems/posix/mutex.h2
-rw-r--r--cpukit/posix/include/rtems/posix/priority.h2
-rw-r--r--cpukit/posix/include/rtems/posix/psignalimpl.h2
-rw-r--r--cpukit/posix/include/rtems/posix/pthread.h2
-rw-r--r--cpukit/posix/include/rtems/posix/ptimer.h2
-rw-r--r--cpukit/posix/include/rtems/posix/rwlock.h2
-rw-r--r--cpukit/posix/include/rtems/posix/semaphore.h10
-rw-r--r--cpukit/posix/include/rtems/posix/spinlock.h2
-rw-r--r--cpukit/posix/include/rtems/posix/threadsup.h4
-rw-r--r--cpukit/posix/include/rtems/posix/time.h2
-rw-r--r--cpukit/posix/include/rtems/posix/timer.h14
-rw-r--r--cpukit/posix/include/semaphore.h2
-rw-r--r--cpukit/rtems/include/rtems.h4
-rw-r--r--cpukit/rtems/include/rtems/rtems/barriermp.h5
-rw-r--r--cpukit/rtems/include/rtems/rtems/msgmp.h5
-rw-r--r--cpukit/rtems/include/rtems/rtems/partmp.h5
-rw-r--r--cpukit/rtems/include/rtems/rtems/sem.h3
-rw-r--r--cpukit/rtems/include/rtems/rtems/signalmp.h5
-rw-r--r--cpukit/rtems/mainpage.h3
-rw-r--r--cpukit/sapi/include/rtems/rbheap.h7
-rw-r--r--cpukit/score/include/rtems/score/copyrt.h4
-rw-r--r--cpukit/score/include/rtems/score/prioritybitmap.h6
-rw-r--r--cpukit/score/include/rtems/score/scheduler.h2
-rw-r--r--cpukit/score/include/rtems/score/schedulercbs.h8
-rw-r--r--cpukit/score/include/rtems/score/scheduleredf.h9
-rw-r--r--cpukit/score/include/rtems/score/schedulerpriority.h8
-rw-r--r--cpukit/score/include/rtems/score/schedulersimple.h10
-rw-r--r--cpukit/score/include/rtems/score/schedulersimplesmp.h8
-rw-r--r--cpukit/score/include/rtems/score/smp.h6
-rw-r--r--cpukit/score/include/rtems/score/states.h7
-rw-r--r--cpukit/score/include/rtems/score/timestamp.h4
-rw-r--r--cpukit/score/include/rtems/score/timestamp64.h4
67 files changed, 210 insertions, 223 deletions
diff --git a/cpukit/libcsupport/include/console.h b/cpukit/libcsupport/include/console.h
index 9cd0e9651f..6b8b8c9455 100644
--- a/cpukit/libcsupport/include/console.h
+++ b/cpukit/libcsupport/include/console.h
@@ -47,7 +47,7 @@ extern "C" {
* @param[in] major is the device driver major number.
* @param[in] minor is the device driver minor number.
* @param[in] arg is the parameters to this call.
- *.
+ *
* @retval RTEMS_SUCCESSFUL The device driver is successfully initialized.
*/
rtems_device_driver console_initialize(
diff --git a/cpukit/libcsupport/include/rtems/deviceio.h b/cpukit/libcsupport/include/rtems/deviceio.h
index df78852bb4..571b3e14ec 100644
--- a/cpukit/libcsupport/include/rtems/deviceio.h
+++ b/cpukit/libcsupport/include/rtems/deviceio.h
@@ -1,8 +1,7 @@
/**
* @file
*
- * @brief Map Operations on IMFS Device Nodes to the RTEMS Classic API
- * IO Manager
+ * @brief Operations on IMFS Device Nodes
*/
/*
@@ -17,14 +16,16 @@
#ifndef _RTEMS_DEVICEIO_H
#define _RTEMS_DEVICEIO_H
+#include <rtems/libio.h>
+
/**
- * @defgroup Device IO Handler
- *
+ * @defgroup IMFSDevices IMFS Device IO Handler
*
- * @{
+ * @ingroup IMFS
+ *
+ * This contains the interface to device drivers using the RTEMS Classic API.
*/
-
-#include <rtems/libio.h>
+/**@{*/
#ifdef __cplusplus
extern "C" {
@@ -79,12 +80,11 @@ int rtems_deviceio_control(
rtems_device_minor_number minor
);
-/** @} */
-
#ifdef __cplusplus
}
#endif
-
/* __cplusplus */
+/**@}*/
+
#endif /* _RTEMS_DEVICEIO_H */
diff --git a/cpukit/libcsupport/include/rtems/error.h b/cpukit/libcsupport/include/rtems/error.h
index 31a37e025b..4eae14f912 100644
--- a/cpukit/libcsupport/include/rtems/error.h
+++ b/cpukit/libcsupport/include/rtems/error.h
@@ -20,27 +20,32 @@
* It can also include a rtems_status value which can be OR'd
* with the above flags. *
*
- * EXAMPLE
+ * Example 1:
+ * @code
* #include <rtems.h>
* #include <rtems/error.h>
* rtems_error(0, "stray interrupt %d", intr);
+ * @endcode
*
- * EXAMPLE
+ * Example 2:
+ * @code
* if ((status = rtems_task_create(...)) != RTEMS_SUCCCESSFUL)
* {
* rtems_error(status | RTEMS_ERROR_ABORT,
* "could not create task");
* }
+ * @endcode
*
- * EXAMPLE
+ * Example 3:
+ * @code
* if ((fd = open(pathname, O_RDNLY)) < 0)
* {
* rtems_error(RTEMS_ERROR_ERRNO, "open of '%s' failed", pathname);
* goto failed;
* }
+ * @endcode
*/
-
#ifndef _RTEMS_RTEMS_ERROR_H
#define _RTEMS_RTEMS_ERROR_H
@@ -59,7 +64,6 @@ extern "C" {
* @brief Defines and externs for rtems error reporting
*
*/
-
typedef Internal_errors_t rtems_error_code_t;
/*
diff --git a/cpukit/libcsupport/include/sys/utsname.h b/cpukit/libcsupport/include/sys/utsname.h
index 93d331637e..2bad0e2572 100644
--- a/cpukit/libcsupport/include/sys/utsname.h
+++ b/cpukit/libcsupport/include/sys/utsname.h
@@ -19,10 +19,11 @@
#define __POSIX_SYS_UTSNAME_h
/**
- * @defgroup utsname Service
+ * @defgroup UTSNAME utsname Service
*
- * @{
+ * @ingroup POSIXAPI
*/
+/**@{*/
#ifdef __cplusplus
extern "C" {
@@ -46,7 +47,8 @@ extern "C" {
#endif
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 */
/* specified communication network */
char release[SYS_NMLN]; /* Current release level of this implementation */
diff --git a/cpukit/libfs/src/devfs/devfs.h b/cpukit/libfs/src/devfs/devfs.h
index 0f5e248225..fbeb13bca5 100644
--- a/cpukit/libfs/src/devfs/devfs.h
+++ b/cpukit/libfs/src/devfs/devfs.h
@@ -12,18 +12,18 @@
#include <rtems/libio_.h>
-#ifdef __cplusplus
-extern "C" {
-#endif
/**
- * @defgroup DevFsDeviceTable Define Device Table Type
+ * @defgroup DevFsDeviceTable Device Only File System
*
- * @ingroup DevFs
+ * @ingroup FileSystemTypesAndMount
*
* @brief This structure defines the type of device table
- *
- * @{
*/
+/**@{*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
typedef struct {
/** This member points to device name which is not a null-terminated string */
diff --git a/cpukit/libfs/src/imfs/imfs.h b/cpukit/libfs/src/imfs/imfs.h
index ba05c5baf2..6874523154 100644
--- a/cpukit/libfs/src/imfs/imfs.h
+++ b/cpukit/libfs/src/imfs/imfs.h
@@ -21,17 +21,18 @@
#include <rtems/libio_.h>
#include <rtems/pipe.h>
-#ifdef __cplusplus
-extern "C" {
-#endif
-
/**
- * @defgroup IMFS POSIX In-Memory File System Support
- *
* @brief In-Memory File System Support.
*
- * @{
+ * @defgroup IMFS In-Memory File System Support
+ *
+ * @ingroup FileSystemTypesAndMount
*/
+/**@{*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
/*
* Data types
@@ -66,7 +67,7 @@ typedef struct {
void *context;
} IMFS_generic_t;
-/*
+/**
* IMFS "memfile" information
*
* 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
* 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 32 is 18,656
* max_filesize with blocks of 64 is 279,488
* 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 512 is 1,082,195,456
+ * @endcode
*/
-
#define IMFS_MEMFILE_DEFAULT_BYTES_PER_BLOCK 128
extern int imfs_rq_memfile_bytes_per_block;
extern int imfs_memfile_bytes_per_block;
@@ -113,7 +115,6 @@ typedef struct {
/*
* Important block numbers for "memfiles"
*/
-
#define FIRST_INDIRECT (0)
#define LAST_INDIRECT (IMFS_MEMFILE_BLOCK_SLOTS - 1)
@@ -134,7 +135,6 @@ typedef struct {
/*
* What types of IMFS file systems entities there can be.
*/
-
typedef enum {
IMFS_DIRECTORY = RTEMS_FILESYSTEM_DIRECTORY,
IMFS_DEVICE = RTEMS_FILESYSTEM_DEVICE,
@@ -165,9 +165,8 @@ typedef union {
/**
* @addtogroup IMFSGenericNodes
- *
- * @{
*/
+/**@{*/
/**
* @brief Initializes an IMFS node.
@@ -282,9 +281,8 @@ typedef struct {
/**
* @addtogroup IMFS
- *
- * @{
*/
+/**@{*/
/*
* Major device number for the IMFS. This is not a real device number because
@@ -435,32 +433,37 @@ extern void IMFS_fsunmount(
*
* TAR file format:
*
- * Offset Length Contents
- * 0 100 bytes File name ('\0' terminated, 99 maxmum length)
- * 100 8 bytes File mode (in octal ascii)
- * 108 8 bytes User ID (in octal ascii)
- * 116 8 bytes Group ID (in octal ascii)
- * 124 12 bytes File size (s) (in octal ascii)
- * 136 12 bytes Modify time (in octal ascii)
- * 148 8 bytes Header checksum (in octal ascii)
- * 156 1 bytes Link flag
- * 157 100 bytes Linkname ('\0' terminated, 99 maxmum length)
- * 257 8 bytes Magic PAX ("ustar\0" + 2 bytes padding)
- * 257 8 bytes Magic GNU tar ("ustar \0")
- * 265 32 bytes User name ('\0' terminated, 31 maxmum length)
- * 297 32 bytes Group name ('\0' terminated, 31 maxmum length)
- * 329 8 bytes Major device ID (in octal ascii)
- * 337 8 bytes Minor device ID (in octal ascii)
- * 345 167 bytes Padding
- * 512 (s+p)bytes File contents (s+p) := (((s) + 511) & ~511),
- * round up to 512 bytes
+ * @code
+ * Offset Length Contents
+ * 0 100 bytes File name ('\0' terminated, 99 maxmum length)
+ * 100 8 bytes File mode (in octal ascii)
+ * 108 8 bytes User ID (in octal ascii)
+ * 116 8 bytes Group ID (in octal ascii)
+ * 124 12 bytes File size (s) (in octal ascii)
+ * 136 12 bytes Modify time (in octal ascii)
+ * 148 8 bytes Header checksum (in octal ascii)
+ * 156 1 bytes Link flag
+ * 157 100 bytes Linkname ('\0' terminated, 99 maxmum length)
+ * 257 8 bytes Magic PAX ("ustar\0" + 2 bytes padding)
+ * 257 8 bytes Magic GNU tar ("ustar \0")
+ * 265 32 bytes User name ('\0' terminated, 31 maxmum length)
+ * 297 32 bytes Group name ('\0' terminated, 31 maxmum length)
+ * 329 8 bytes Major device ID (in octal ascii)
+ * 337 8 bytes Minor device ID (in octal ascii)
+ * 345 167 bytes Padding
+ * 512 (s+p) bytes File contents (s+p) := (((s) + 511) & ~511),
+ * round up to 512 bytes
+ * @endcode
*
* Checksum:
- * int i, sum;
- * char* header = tar_header_pointer;
- * sum = 0;
- * for(i = 0; i < 512; i++)
- * sum += 0xFF & header[i];
+ * @code
+ * int i, sum;
+ * char *header = tar_header_pointer;
+ *
+ * sum = 0;
+ * for (i = 0; i < 512; i++)
+ * sum += 0xFF & header[i];
+ * @endcode
*/
extern int rtems_tarfs_load(
const char *mountpoint,
@@ -616,9 +619,8 @@ extern bool IMFS_is_imfs_instance(
* more features like support for fsync() and fdatasync(). The generic nodes
* use the reference counting of the IMFS. This provides automatic node
* destruction when the last reference vanishes.
- *
- * @{
*/
+/**@{*/
/**
* @brief Makes a generic IMFS node.
@@ -671,9 +673,8 @@ extern int IMFS_make_generic_node(
/**
* @addtogroup 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
* at system shutdown unless special arrangements to copy the data to
* some type of non-volailte storage are made by the application.
- *
- * @{
*/
+/**@{*/
/**
* @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
* IMFS device nodes onto calls to the RTEMS Classic API IO Manager.
- *
- * @{
*/
+/**@{*/
extern int device_open(
rtems_libio_t *iop, /* IN */
@@ -959,9 +958,8 @@ static inline IMFS_jnode_t *IMFS_create_node(
/**
* @addtogroup IMFSGenericNodes
- *
- * @{
*/
+/**@{*/
static inline void *IMFS_generic_get_context_by_node(
const IMFS_jnode_t *node
@@ -996,11 +994,9 @@ static inline dev_t IMFS_generic_get_device_identifier_by_node(
);
}
-/** @} */
-
#ifdef __cplusplus
}
#endif
-
+/** @} */
#endif
/* end of include file */
diff --git a/cpukit/libfs/src/pipe/pipe.h b/cpukit/libfs/src/pipe/pipe.h
index f51855c173..e9b9117f54 100644
--- a/cpukit/libfs/src/pipe/pipe.h
+++ b/cpukit/libfs/src/pipe/pipe.h
@@ -20,17 +20,18 @@
#include <rtems/libio.h>
-#ifdef __cplusplus
-extern "C" {
-#endif
-
/**
- * @defgroup FIFO_PIPE FIFO/pipe File System Support
+ * @defgroup FIFO_PIPE FIFO/Pipe File System Support
*
- * @brief Interface to the POSIX FIFO/pipe File System
+ * @ingroup FileSystemTypesAndMount
*
- * @{
+ * @brief Interface to the POSIX FIFO/Pipe File System
*/
+/**@{*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
/* Control block to manage each pipe */
typedef struct pipe_control {
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-bitmaps.h b/cpukit/libfs/src/rfs/rtems-rfs-bitmaps.h
index c2497764e2..b8ed9c8d54 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-bitmaps.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-bitmaps.h
@@ -3,7 +3,7 @@
*
* @brief RTEMS File Systems Bitmap Routines
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File Systems Bitmap Routines.
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-block-pos.h b/cpukit/libfs/src/rfs/rtems-rfs-block-pos.h
index 1aab489027..3a3aab6b97 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-block-pos.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-block-pos.h
@@ -3,7 +3,7 @@
*
* @brief RTEMS File Systems Block Position and Size Management
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File Systems Block Position and Size Management.
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-block.h b/cpukit/libfs/src/rfs/rtems-rfs-block.h
index 928186f52b..ee758bafb3 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-block.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-block.h
@@ -3,7 +3,7 @@
*
* @brief RTEMS File Systems Block Management
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File Systems Block Management.
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-buffer.h b/cpukit/libfs/src/rfs/rtems-rfs-buffer.h
index ec35e648d7..40b5891a2f 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-buffer.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-buffer.h
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* @brief Maps Blocks to the Media Interface Layers
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-data.h b/cpukit/libfs/src/rfs/rtems-rfs-data.h
index 0e20423adc..954f4bc697 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-data.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-data.h
@@ -3,7 +3,7 @@
*
* @brief RTEMS File System Data
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File System Data.
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-dir-hash.h b/cpukit/libfs/src/rfs/rtems-rfs-dir-hash.h
index 46b2719a7e..0b2d7a40b6 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-dir-hash.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-dir-hash.h
@@ -3,7 +3,7 @@
*
* @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
* used to search a directory.
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-dir.h b/cpukit/libfs/src/rfs/rtems-rfs-dir.h
index ddfcb5418e..91ea713710 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-dir.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-dir.h
@@ -3,7 +3,7 @@
*
* @brief RTEMS File System Directory Support
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File System Directory Support
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-file-system-fwd.h b/cpukit/libfs/src/rfs/rtems-rfs-file-system-fwd.h
index 19b03587e1..8010c40a16 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-file-system-fwd.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-file-system-fwd.h
@@ -3,7 +3,7 @@
*
* @brief RTEMS File Systems Data Forward Declaration
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File Systems Data forward decl.
*/
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-file-system.h b/cpukit/libfs/src/rfs/rtems-rfs-file-system.h
index 1d059ae92c..7c80aed5da 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-file-system.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-file-system.h
@@ -3,7 +3,7 @@
*
* @brief RTEMS File System Data
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File System Data
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-file.h b/cpukit/libfs/src/rfs/rtems-rfs-file.h
index 9665c60ea5..efafb88e56 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-file.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-file.h
@@ -3,7 +3,7 @@
*
* @brief RTEMS File System File Support
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File System File Support
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-format.h b/cpukit/libfs/src/rfs/rtems-rfs-format.h
index f0d9f0c2b1..dd2b08d2a2 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-format.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-format.h
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* @brief RTEMS File System Format
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-group.h b/cpukit/libfs/src/rfs/rtems-rfs-group.h
index 90c6a9aa88..595a3c0886 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-group.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-group.h
@@ -3,7 +3,7 @@
*
* @brief RTEMS File Systems Group Management
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File Systems Group Management.
*
@@ -23,11 +23,11 @@
#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-bitmaps.h>
@@ -178,4 +178,4 @@ int rtems_rfs_group_usage (rtems_rfs_file_system* fs,
size_t* inodes);
/** @} */
-#endif \ No newline at end of file
+#endif
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-inode.h b/cpukit/libfs/src/rfs/rtems-rfs-inode.h
index a8be80f6ff..773db4751d 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-inode.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-inode.h
@@ -3,7 +3,7 @@
*
* @brief RTEMS File System Information Node
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File System Information Node.
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-link.h b/cpukit/libfs/src/rfs/rtems-rfs-link.h
index 6a1cf18f6d..c10e336d49 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-link.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-link.h
@@ -3,7 +3,7 @@
*
* @brief RTEMS File System Link Support
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File System Link Support
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-mutex.h b/cpukit/libfs/src/rfs/rtems-rfs-mutex.h
index edf67f4f7b..a37d9fee72 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-mutex.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-mutex.h
@@ -3,7 +3,7 @@
*
* @brief RTEMS File System Mutex
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File System Mutex.
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-rtems.h b/cpukit/libfs/src/rfs/rtems-rfs-rtems.h
index bbff3aeaf3..d923999f62 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-rtems.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-rtems.h
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File System RTEMS Header file.
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-shell.h b/cpukit/libfs/src/rfs/rtems-rfs-shell.h
index a917b8556c..46f3d2902f 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-shell.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-shell.h
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
* @brief RTEMS File Systems Shell Commands
*
* RTEMS File Systems Shell commands provide a CLI interface to support and
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-trace.h b/cpukit/libfs/src/rfs/rtems-rfs-trace.h
index 030e6c2058..7ffdea0d56 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-trace.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-trace.h
@@ -4,7 +4,7 @@
* @brief Manages the Trace and Debugging Features of the
* RTEMS RFS File System
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* 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
diff --git a/cpukit/libfs/src/rfs/rtems-rfs.h b/cpukit/libfs/src/rfs/rtems-rfs.h
index b1684e0ebd..ffd2f806fb 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs.h
@@ -2,7 +2,7 @@
* @file
*
* @brief RFS File system Initialization
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File System
*
@@ -23,8 +23,16 @@
#include <rtems/fs.h>
/**
+ * @defgroup rtems_rfs RTEMS File System Group Management
+ *
+ * @ingroup FileSystemTypesAndMount
+ */
+/**@{*/
+
+/**
* Initialise the RFS File system.
*/
int rtems_rfs_rtems_initialise (rtems_filesystem_mount_table_entry_t *mt_entry);
+/**@}*/
#endif
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
diff --git a/cpukit/posix/include/aio.h b/cpukit/posix/include/aio.h
index 769f0b37f2..f43e088930 100644
--- a/cpukit/posix/include/aio.h
+++ b/cpukit/posix/include/aio.h
@@ -28,7 +28,7 @@ extern "C" {
/**
* @defgroup POSIX_AIO POSIX Asynchronous I/O Support
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @brief POSIX Asynchronous Input and Output
*
diff --git a/cpukit/posix/include/mqueue.h b/cpukit/posix/include/mqueue.h
index a3e43ee712..2c228544de 100644
--- a/cpukit/posix/include/mqueue.h
+++ b/cpukit/posix/include/mqueue.h
@@ -43,7 +43,7 @@
/**
* @defgroup POSIX_MQUEUE POSIX Message Queues
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @{
*/
diff --git a/cpukit/posix/include/rtems/posix/cond.h b/cpukit/posix/include/rtems/posix/cond.h
index 5fdc1a1a31..2bd02604c0 100644
--- a/cpukit/posix/include/rtems/posix/cond.h
+++ b/cpukit/posix/include/rtems/posix/cond.h
@@ -22,7 +22,7 @@
/**
* @defgroup POSIX_COND_VARS POSIX Condition Variables
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @{
*/
diff --git a/cpukit/posix/include/rtems/posix/key.h b/cpukit/posix/include/rtems/posix/key.h
index f0f039ec1d..bd92a01316 100644
--- a/cpukit/posix/include/rtems/posix/key.h
+++ b/cpukit/posix/include/rtems/posix/key.h
@@ -24,7 +24,7 @@
/**
* @defgroup POSIX_KEY POSIX Key
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @{
*/
diff --git a/cpukit/posix/include/rtems/posix/mqueue.h b/cpukit/posix/include/rtems/posix/mqueue.h
index cef85e8045..1b24098170 100644
--- a/cpukit/posix/include/rtems/posix/mqueue.h
+++ b/cpukit/posix/include/rtems/posix/mqueue.h
@@ -40,7 +40,7 @@
/**
* @defgroup POSIX_MQUEUE_P Message Queues Private Support
*
- * @ingroup POSIX_MQUEUE
+ * @ingroup POSIXAPI
*
* @{
*/
diff --git a/cpukit/posix/include/rtems/posix/mutex.h b/cpukit/posix/include/rtems/posix/mutex.h
index f44a1c64b1..a84ed7ec77 100644
--- a/cpukit/posix/include/rtems/posix/mutex.h
+++ b/cpukit/posix/include/rtems/posix/mutex.h
@@ -26,7 +26,7 @@ extern "C" {
/**
* @defgroup POSIX_MUTEX POSIX Mutex Support
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @brief Private Support Information for POSIX Mutex
*
diff --git a/cpukit/posix/include/rtems/posix/priority.h b/cpukit/posix/include/rtems/posix/priority.h
index 1a12900057..cf47ed0677 100644
--- a/cpukit/posix/include/rtems/posix/priority.h
+++ b/cpukit/posix/include/rtems/posix/priority.h
@@ -22,7 +22,7 @@
/**
* @defgroup POSIX_PRIORITY POSIX Priority Support
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @brief Interface to the POSIX Priority Implementation
*
diff --git a/cpukit/posix/include/rtems/posix/psignalimpl.h b/cpukit/posix/include/rtems/posix/psignalimpl.h
index d09722ddbf..6db7948840 100644
--- a/cpukit/posix/include/rtems/posix/psignalimpl.h
+++ b/cpukit/posix/include/rtems/posix/psignalimpl.h
@@ -21,7 +21,7 @@
/**
* @defgroup POSIX_SIGNALS POSIX Signals Support
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @brief Internal Information about POSIX Signals
*
diff --git a/cpukit/posix/include/rtems/posix/pthread.h b/cpukit/posix/include/rtems/posix/pthread.h
index d0d2c2db5d..7037adc672 100644
--- a/cpukit/posix/include/rtems/posix/pthread.h
+++ b/cpukit/posix/include/rtems/posix/pthread.h
@@ -30,7 +30,7 @@ extern "C" {
/**
* @defgroup POSIX_PTHREAD POSIX Threads Support
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @brief Private Support Information for POSIX Threads
*
diff --git a/cpukit/posix/include/rtems/posix/ptimer.h b/cpukit/posix/include/rtems/posix/ptimer.h
index 50840ac5f6..9f6122ad04 100644
--- a/cpukit/posix/include/rtems/posix/ptimer.h
+++ b/cpukit/posix/include/rtems/posix/ptimer.h
@@ -25,7 +25,7 @@
/**
* @defgroup POSIX_PRIV_TIMERS POSIX Timers
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @{
*/
diff --git a/cpukit/posix/include/rtems/posix/rwlock.h b/cpukit/posix/include/rtems/posix/rwlock.h
index 57351be532..0dbd268aa3 100644
--- a/cpukit/posix/include/rtems/posix/rwlock.h
+++ b/cpukit/posix/include/rtems/posix/rwlock.h
@@ -32,7 +32,7 @@ extern "C" {
/**
* @defgroup POSIX_RWLOCK POSIX RWLock Manager
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @brief Constants and Structures Associated with the POSIX RWLock Manager
*
diff --git a/cpukit/posix/include/rtems/posix/semaphore.h b/cpukit/posix/include/rtems/posix/semaphore.h
index 031a511d70..3127c3f9aa 100644
--- a/cpukit/posix/include/rtems/posix/semaphore.h
+++ b/cpukit/posix/include/rtems/posix/semaphore.h
@@ -20,10 +20,14 @@
#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
extern "C" {
#endif
diff --git a/cpukit/posix/include/rtems/posix/spinlock.h b/cpukit/posix/include/rtems/posix/spinlock.h
index a535c6bae6..c8af7fa03b 100644
--- a/cpukit/posix/include/rtems/posix/spinlock.h
+++ b/cpukit/posix/include/rtems/posix/spinlock.h
@@ -32,7 +32,7 @@ extern "C" {
/**
* @defgroup POSIX_SPINLOCK POSIX Spinlock Support
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @brief Constants and Structures Associated with the POSIX Spinlock Manager
*
diff --git a/cpukit/posix/include/rtems/posix/threadsup.h b/cpukit/posix/include/rtems/posix/threadsup.h
index 2d9c6adfa6..72fa1d35af 100644
--- a/cpukit/posix/include/rtems/posix/threadsup.h
+++ b/cpukit/posix/include/rtems/posix/threadsup.h
@@ -23,9 +23,9 @@
#include <rtems/score/tqdata.h>
/**
- * @defgroup POSIX_THREAD Thread API Extension
+ * @defgroup POSIX_THREAD POSIX Thread API Extension
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @{
*/
diff --git a/cpukit/posix/include/rtems/posix/time.h b/cpukit/posix/include/rtems/posix/time.h
index d00fc02491..f5e55a55be 100644
--- a/cpukit/posix/include/rtems/posix/time.h
+++ b/cpukit/posix/include/rtems/posix/time.h
@@ -24,7 +24,7 @@
/**
* @defgroup POSIX_TIMETYPES POSIX Time Types
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @{
*/
diff --git a/cpukit/posix/include/rtems/posix/timer.h b/cpukit/posix/include/rtems/posix/timer.h
index 544acd712a..0b70cc9950 100644
--- a/cpukit/posix/include/rtems/posix/timer.h
+++ b/cpukit/posix/include/rtems/posix/timer.h
@@ -24,12 +24,11 @@
#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
extern "C" {
@@ -38,13 +37,13 @@ extern "C" {
/* Timer is free */
#define POSIX_TIMER_STATE_FREE 0x01
-/* Created timer but not running */
+/* Created timer but not running */
#define POSIX_TIMER_STATE_CREATE_NEW 0x02
-/* Created timer and running */
+/* Created timer and running */
#define POSIX_TIMER_STATE_CREATE_RUN 0x03
-/* Created, ran and stopped timer */
+/* Created, ran and stopped timer */
#define POSIX_TIMER_STATE_CREATE_STOP 0x04
/* Indicates that the fire time is relative to the current one */
@@ -59,7 +58,6 @@ extern "C" {
#error "POSIX_TIMER_RELATIVE == TIMER_ABSTIME"
#endif
-
/*
* Data for a timer
*/
diff --git a/cpukit/posix/include/semaphore.h b/cpukit/posix/include/semaphore.h
index 65708c96f1..489258ecb0 100644
--- a/cpukit/posix/include/semaphore.h
+++ b/cpukit/posix/include/semaphore.h
@@ -26,7 +26,7 @@ extern "C" {
/**
* @defgroup POSIX_SEMAPHORE POSIX Semaphores Support
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @brief Private Support Information for POSIX Semaphores
*/
diff --git a/cpukit/rtems/include/rtems.h b/cpukit/rtems/include/rtems.h
index d4af28a8ec..a644fa051c 100644
--- a/cpukit/rtems/include/rtems.h
+++ b/cpukit/rtems/include/rtems.h
@@ -3,7 +3,6 @@
*
* @defgroup ClassicRTEMS RTEMS Classic API
*
- * @ingroup ClassicRTEMS
* @brief RTEMS Classic API
*
* the Public Interface to the RTEMS Classic API
@@ -24,9 +23,8 @@
* @defgroup ClassicRTEMS RTEMS Classic API
*
* RTEMS Classic API definitions and modules.
- *
- * @{
*/
+/**@{*/
#ifdef __cplusplus
extern "C" {
diff --git a/cpukit/rtems/include/rtems/rtems/barriermp.h b/cpukit/rtems/include/rtems/rtems/barriermp.h
index da5d372c0a..d2a203b162 100644
--- a/cpukit/rtems/include/rtems/rtems/barriermp.h
+++ b/cpukit/rtems/include/rtems/rtems/barriermp.h
@@ -1,9 +1,6 @@
/**
* @file rtems/rtems/barriermp.h
*
- * @defgroup ClassicBarrierMP Barrier MP Support
- *
- * @ingroup ClassicMP
* @brief MP Support in the Barrier Manager
*
* This include file contains all the constants and structures associated
@@ -28,7 +25,7 @@
*
* This encapsulates functionality which XXX
*/
-/**{*/
+/**@{*/
#ifdef __cplusplus
extern "C" {
diff --git a/cpukit/rtems/include/rtems/rtems/msgmp.h b/cpukit/rtems/include/rtems/rtems/msgmp.h
index 5d895dea1c..f01a687ae3 100644
--- a/cpukit/rtems/include/rtems/rtems/msgmp.h
+++ b/cpukit/rtems/include/rtems/rtems/msgmp.h
@@ -1,9 +1,6 @@
/**
* @file rtems/rtems/msgmp.h
*
- * @defgroup ClassicMsgMP Message Queue MP Support
- *
- * @ingroup ClassicRTEMS
* @brief Message Manager MP Support
*
* This include file contains all the constants and structures associated
@@ -39,7 +36,7 @@ extern "C" {
*
* This encapsulates functionality which XXX
*/
-/**{*/
+/*{*/
/**
* The following enumerated type defines the list of
diff --git a/cpukit/rtems/include/rtems/rtems/partmp.h b/cpukit/rtems/include/rtems/rtems/partmp.h
index 0405f8036b..3d3f47fe52 100644
--- a/cpukit/rtems/include/rtems/rtems/partmp.h
+++ b/cpukit/rtems/include/rtems/rtems/partmp.h
@@ -1,9 +1,6 @@
/**
* @file rtems/rtems/partmp.h
*
- * @defgroup ClassicPartMP Partition MP Support
- *
- * @ingroup ClassicMP
* @brief MP Support in Partition Manager
*
* This include file contains all the constants and structures associated
@@ -39,7 +36,7 @@ extern "C" {
*
* This encapsulates functionality which XXX
*/
-/**{*/
+/*{*/
/**
* The following enumerated type defines the list of
diff --git a/cpukit/rtems/include/rtems/rtems/sem.h b/cpukit/rtems/include/rtems/rtems/sem.h
index bc5f4dc30b..4442b1d68c 100644
--- a/cpukit/rtems/include/rtems/rtems/sem.h
+++ b/cpukit/rtems/include/rtems/rtems/sem.h
@@ -1,10 +1,11 @@
/**
* @file rtems/rtems/sem.h
*
+ * @brief Semaphore Manager
+ *
* @defgroup ClassicSem Semaphores
*
* @ingroup ClassicRTEMS
- * @brief Semaphore Manager
*
* This include file contains all the constants and structures associated
* with the Semaphore Manager. This manager utilizes standard Dijkstra
diff --git a/cpukit/rtems/include/rtems/rtems/signalmp.h b/cpukit/rtems/include/rtems/rtems/signalmp.h
index de32f3cc0e..82a7e07ef8 100644
--- a/cpukit/rtems/include/rtems/rtems/signalmp.h
+++ b/cpukit/rtems/include/rtems/rtems/signalmp.h
@@ -1,9 +1,6 @@
/**
* @file rtems/rtems/signalmp.h
*
- * @defgroup ClassicSignalMP Signal MP Support
- *
- * @ingroup ClassicRTEMS
* @brief Signal MP Support
*
* This include file contains all the constants and structures associated
@@ -38,7 +35,7 @@ extern "C" {
*
* This encapsulates functionality which XXX
*/
-/**{*/
+/*{*/
/**
* The following enumerated type defines the list of
diff --git a/cpukit/rtems/mainpage.h b/cpukit/rtems/mainpage.h
index 5aee1ccc46..b772b37892 100644
--- a/cpukit/rtems/mainpage.h
+++ b/cpukit/rtems/mainpage.h
@@ -391,11 +391,10 @@
* of RTEMS' concepts and features are interrelated. Experienced RTEMS users
* will find that the manual organization facilitates its use as a reference
* document.
- *
*/
/**
- * @addtogroup ClassicRTEMS
+ * @addtogroup ClassicAPI
*
* The facilities provided by RTEMS are built upon a foundation of very
* powerful concepts. These concepts must be understood before the application
diff --git a/cpukit/sapi/include/rtems/rbheap.h b/cpukit/sapi/include/rtems/rbheap.h
index 835be5a624..22a6cf08f3 100644
--- a/cpukit/sapi/include/rtems/rbheap.h
+++ b/cpukit/sapi/include/rtems/rbheap.h
@@ -1,8 +1,6 @@
/**
* @file
*
- * @ingroup RBHeap
- *
* @brief Red-Black Tree Heap API
*/
@@ -34,6 +32,8 @@ extern "C" {
/**
* @defgroup RBHeap Red-Black Tree Heap
*
+ * @ingroup ClassicRTEMS
+ *
* @brief Red-Black Tree Heap API.
*
* 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
* called chunks. Each chunk needs a descriptor which is stored outside of the
* managed area.
- *
- * @{
*/
+/**@{*/
/**
* @brief Red-black heap chunk descriptor.
diff --git a/cpukit/score/include/rtems/score/copyrt.h b/cpukit/score/include/rtems/score/copyrt.h
index 58c1809af8..cc66f5cf52 100644
--- a/cpukit/score/include/rtems/score/copyrt.h
+++ b/cpukit/score/include/rtems/score/copyrt.h
@@ -20,7 +20,7 @@
#define _RTEMS_SCORE_COPYRT_H
/**
- * @defgroup SuperCore RTEMS Copyright Notice
+ * @defgroup SuperCoreCopyright RTEMS Copyright Notice
*
* @ingroup Score
*/
@@ -47,4 +47,4 @@ extern const char _Copyright_Notice[];
/**@}*/
#endif
-/* end of include file */ \ No newline at end of file
+/* end of include file */
diff --git a/cpukit/score/include/rtems/score/prioritybitmap.h b/cpukit/score/include/rtems/score/prioritybitmap.h
index 280a0674fd..8e8f21ce34 100644
--- a/cpukit/score/include/rtems/score/prioritybitmap.h
+++ b/cpukit/score/include/rtems/score/prioritybitmap.h
@@ -20,11 +20,9 @@
#define _RTEMS_SCORE_PRIORITYBITMAP_H
/**
- * @defgroup ScorePriority Bitmap Priority Thread Routines
+ * @defgroup ScorePriorityBitmap Bitmap Priority Thread Routines
*
* @ingroup Score
- *
- * @addtogroup ScorePriority
*/
/**@{*/
@@ -124,4 +122,4 @@ typedef struct {
/**@}*/
#endif
-/* end of include file */ \ No newline at end of file
+/* end of include file */
diff --git a/cpukit/score/include/rtems/score/scheduler.h b/cpukit/score/include/rtems/score/scheduler.h
index 91a6bbdff4..5c35a36de1 100644
--- a/cpukit/score/include/rtems/score/scheduler.h
+++ b/cpukit/score/include/rtems/score/scheduler.h
@@ -150,4 +150,4 @@ void _Scheduler_Handler_initialization( void );
#endif
#endif
-/* end of include file */ \ No newline at end of file
+/* end of include file */
diff --git a/cpukit/score/include/rtems/score/schedulercbs.h b/cpukit/score/include/rtems/score/schedulercbs.h
index 96fd6fac3f..53452e044a 100644
--- a/cpukit/score/include/rtems/score/schedulercbs.h
+++ b/cpukit/score/include/rtems/score/schedulercbs.h
@@ -33,11 +33,9 @@ extern "C" {
#endif
/**
- * @defgroup ScoreScheduler CBS Scheduler
+ * @defgroup ScoreSchedulerCBS CBS Scheduler
*
- * @ingroup Score
- *
- * @addtogroup ScoreScheduler
+ * @ingroup ScoreScheduler
*/
/**@{*/
@@ -346,4 +344,4 @@ void *_Scheduler_CBS_Allocate(
/**@}*/
#endif
-/* end of include file */ \ No newline at end of file
+/* end of include file */
diff --git a/cpukit/score/include/rtems/score/scheduleredf.h b/cpukit/score/include/rtems/score/scheduleredf.h
index 5c5c2c4f97..24f9a1ac32 100644
--- a/cpukit/score/include/rtems/score/scheduleredf.h
+++ b/cpukit/score/include/rtems/score/scheduleredf.h
@@ -29,12 +29,9 @@ extern "C" {
#endif
/**
- * @defgroup ScoreScheduler
- *
- * @ingroup Score
- *
- * @addtogroup ScoreScheduler
+ * @defgroup ScoreSchedulerEDF EDF Scheduler
*
+ * @ingroup ScoreScheduler
*/
/**@{*/
@@ -270,4 +267,4 @@ void _Scheduler_EDF_Release_job (
/**@}*/
#endif
-/* end of include file */ \ No newline at end of file
+/* end of include file */
diff --git a/cpukit/score/include/rtems/score/schedulerpriority.h b/cpukit/score/include/rtems/score/schedulerpriority.h
index 9c2dc8cbbb..f97bb7f075 100644
--- a/cpukit/score/include/rtems/score/schedulerpriority.h
+++ b/cpukit/score/include/rtems/score/schedulerpriority.h
@@ -28,11 +28,9 @@ extern "C" {
#endif
/**
- * @defgroup ScoreScheduler Priority-based Scheduler
+ * @defgroup ScoreSchedulerDPS Deterministic Priority-based Scheduler
*
- * @ingroup Score
- *
- * @addtogroup ScoreScheduler
+ * @ingroup ScoreScheduler
*/
/**@{*/
@@ -254,4 +252,4 @@ extern Priority_bit_map_Control _Priority_Bit_map[16] CPU_STRUCTURE_ALIGNMENT;
/**@}*/
#endif
-/* end of include file */ \ No newline at end of file
+/* end of include file */
diff --git a/cpukit/score/include/rtems/score/schedulersimple.h b/cpukit/score/include/rtems/score/schedulersimple.h
index f350d533ad..df52a586be 100644
--- a/cpukit/score/include/rtems/score/schedulersimple.h
+++ b/cpukit/score/include/rtems/score/schedulersimple.h
@@ -19,11 +19,9 @@
#define _RTEMS_SCORE_SCHEDULERSIMPLE_H
/**
- * @defgroup ScoreScheduler
+ * @defgroup ScoreSchedulerSimple Simple Priority Scheduler
*
- * @ingroup Score
- *
- * @addtogroup ScoreScheduler
+ * @ingroup 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
* The overhead of a function call will still be imposed.
@@ -225,4 +223,4 @@ void _Scheduler_simple_Ready_queue_enqueue_first(
/**@}*/
#endif
-/* end of include file */ \ No newline at end of file
+/* end of include file */
diff --git a/cpukit/score/include/rtems/score/schedulersimplesmp.h b/cpukit/score/include/rtems/score/schedulersimplesmp.h
index 86c7d9a900..63213c6b2a 100644
--- a/cpukit/score/include/rtems/score/schedulersimplesmp.h
+++ b/cpukit/score/include/rtems/score/schedulersimplesmp.h
@@ -23,11 +23,9 @@
#define _RTEMS_SCORE_SCHEDULERSIMPLE_SMP_H
/**
- * @defgroup ScoreScheduler
+ * @defgroup ScoreSchedulerSMP Simple SMP Scheduler
*
- * @ingroup Score
- *
- * @addtogroup ScoreScheduler
+ * @ingroup ScoreScheduler
*
* The Simple SMP Scheduler attempts to faithfully implement the
* behaviour of the Deterministic Priority Scheduler while spreading
@@ -120,4 +118,4 @@ void _Scheduler_simple_smp_Tick( void );
/**@}*/
#endif
-/* end of include file */ \ No newline at end of file
+/* end of include file */
diff --git a/cpukit/score/include/rtems/score/smp.h b/cpukit/score/include/rtems/score/smp.h
index b3d964b8d2..f4bf72edd9 100644
--- a/cpukit/score/include/rtems/score/smp.h
+++ b/cpukit/score/include/rtems/score/smp.h
@@ -23,7 +23,7 @@
#include <rtems/score/percpu.h>
/**
- * @defgroup SuperCore SMP Support
+ * @defgroup SuperCoreSMP SMP Support
*
* @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);
/**
- * @Brief Request other cores to shutdown.
+ * @brief Request other cores to shutdown.
*
* Send message to other cores requesting them to shutdown.
*/
@@ -121,4 +121,4 @@ void _SMP_Request_other_cores_to_shutdown(void);
/**@}*/
#endif
-/* end of include file */ \ No newline at end of file
+/* end of include file */
diff --git a/cpukit/score/include/rtems/score/states.h b/cpukit/score/include/rtems/score/states.h
index 9732875228..9fab5d4748 100644
--- a/cpukit/score/include/rtems/score/states.h
+++ b/cpukit/score/include/rtems/score/states.h
@@ -3,7 +3,7 @@
*
* @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
/**
- * @defgroup Encapsulates functionality which relates to the management of
- * the state bitmap associated with each thread.
+ * @defgroup ScoreStates SuperCore Thread States
*
* @ingroup Score
*
@@ -130,4 +129,4 @@ typedef uint32_t States_Control;
/**@}*/
#endif
-/* end of include file */ \ No newline at end of file
+/* end of include file */
diff --git a/cpukit/score/include/rtems/score/timestamp.h b/cpukit/score/include/rtems/score/timestamp.h
index fb297da06d..638ae7bf52 100644
--- a/cpukit/score/include/rtems/score/timestamp.h
+++ b/cpukit/score/include/rtems/score/timestamp.h
@@ -19,7 +19,7 @@
#define _RTEMS_SCORE_TIMESTAMP_H
/**
- * @defgroup SuperCore Timestamp
+ * @defgroup SuperCoreTimeStamp Score Timestamp
*
* @ingroup Score
*
@@ -370,4 +370,4 @@ extern "C" {
/**@}*/
#endif
-/* end of include file */ \ No newline at end of file
+/* end of include file */
diff --git a/cpukit/score/include/rtems/score/timestamp64.h b/cpukit/score/include/rtems/score/timestamp64.h
index 65da8f3497..306ee35fee 100644
--- a/cpukit/score/include/rtems/score/timestamp64.h
+++ b/cpukit/score/include/rtems/score/timestamp64.h
@@ -20,7 +20,7 @@
#define _RTEMS_SCORE_TIMESTAMP64_H
/**
- * @defgroup SuperCore Timestamp64
+ * @defgroup SuperCoreTimestamp64 SuperCore Sixty-Four Bit Timestamps
*
* @ingroup Score
*
@@ -428,4 +428,4 @@ static inline void _Timestamp64_implementation_To_timeval(
/**@}*/
#endif
-/* end of include file */ \ No newline at end of file
+/* end of include file */