cpukit: Use Consistent Beginning of Doxygen Group Notation

This is the result of a sed script which converts all uses of @{ into a consistent form.
2026-09-22 20:02:27 +08:00 · 2013-01-10 17:06:47 -06:00
parent b10825cd5d
commit b697bc6a44
164 changed files with 290 additions and 405 deletions
@@ -38,9 +38,8 @@ extern "C" {
 * In addition to the Classic API interrupt handler with a handle are
 * supported.  You can also install multiple shared handler for one interrupt
 * vector.
- *
- * @{
 */
+/**@{**/

 /**
 * @brief Makes the interrupt handler unique.  Prevents other handler from
@@ -29,15 +29,13 @@ extern "C" {

 /**
 * @defgroup rtems_status_checks Status Checks
- *
- * @{
 */
+/**@{**/

 /**
 * @name Print Macros
- *
- * @{
 */
+/**@{**/

 /**
 * @brief General purpose debug print macro.
@@ -142,9 +140,8 @@ extern "C" {

 /**
 * @name Check Macros
- *
- * @{
 */
+/**@{**/

 /**
 * @brief Prints message @a msg and returns with status code @a sc if the status
@@ -248,9 +245,8 @@ extern "C" {

 /**
 * @name Cleanup Macros
- *
- * @{
 */
+/**@{**/

 /**
 * @brief Prints message @a msg and jumps to @a label if the status code @a sc
@@ -40,9 +40,8 @@ extern "C" {
 * @ingroup LibIO
 *
 * @brief Provides a POSIX like user environment for tasks.
- *
- * @{
 */
+/**@{**/

 #ifndef LOGIN_NAME_MAX
  #ifdef _POSIX_LOGIN_NAME_MAX
@@ -171,9 +171,8 @@ extern "C" {
 * issue with this design.  The reallocation of a group may forced recently
 * accessed buffers out of the cache when they should not.  The design should be
 * change to have groups on a LRU list if they have no buffers in use.
- *
- * @{
 */
+/**@{**/

 /**
 * @brief State of a buffer of the cache.
@@ -79,15 +79,13 @@ extern "C" {
 *  - <a href="http://en.wikipedia.org/wiki/Extended_boot_record">Extended Boot Record</a>
 *  - <a href="http://en.wikipedia.org/wiki/Cylinder-head-sector">Cylinder Head Sector</a>
 *  - <a href="http://www.win.tue.nl/~aeb/partitions/partition_types-1.html">Partition Types</a>
- *
- * @{
 */
+/**@{**/

 /**
 * @name MBR Partition Types and Flags
- *
- * @{
 */
+/**@{**/

 #define RTEMS_BDPART_MBR_EMPTY 0x0U

@@ -36,9 +36,8 @@ extern "C" {
 * control. This call puts IO @ref rtems_blkdev_request "requests" to the block
 * device for asynchronous processing. When a driver executes a request, it
 * invokes the request done callback function to finish the request.
- *
- * @{
 */
+/**@{**/

 /**
 * @brief Block device request type.
@@ -175,9 +174,8 @@ static inline void rtems_blkdev_request_done(

 /**
 * @name IO Control Request Codes
- *
- * @{
 */
+/**@{**/

 #define RTEMS_BLKIO_REQUEST         _IOWR('B', 1, rtems_blkdev_request)
 #define RTEMS_BLKIO_GETMEDIABLKSIZE _IOR('B', 2, uint32_t)
@@ -253,9 +251,8 @@ static inline int rtems_disk_fd_reset_device_stats(int fd)

 /**
 * @name Block Device Driver Capabilities
- *
- * @{
 */
+/**@{**/

 /**
 * @brief Only consecutive multi-sector buffer requests are supported.
@@ -369,9 +366,8 @@ void rtems_blkstats(
 * @ingroup rtems_blkdev
 *
 * Generic disk device operations for standard RTEMS IO drivers.
- *
- * @{
 */
+/**@{**/

 /**
 * The device driver interface conventions suppose that a driver may contain an
@@ -37,9 +37,8 @@ typedef struct rtems_disk_device rtems_disk_device;
 * contain a subset of consecutive disk blocks.  The logical disks are used to
 * represent the partitions of a disk.  The disk devices are accessed via the
 * @ref rtems_bdbuf "block device buffer module".
- *
- * @{
 */
+/**@{**/

 /**
 * @brief Block device block index type.
@@ -276,9 +275,8 @@ struct rtems_disk_device {

 /**
 * @name Disk Device Data
- *
- * @{
 */
+/**@{**/

 static inline dev_t rtems_disk_get_device_identifier(
  const rtems_disk_device *dd
@@ -340,9 +338,8 @@ static inline rtems_blkdev_bnum rtems_disk_get_block_count(

 /**
 * @name Disk Device Maintainance
- *
- * @{
 */
+/**@{**/

 /**
 * @brief Creates a physical disk with device identifier @a dev.
@@ -443,9 +440,8 @@ rtems_status_code rtems_disk_release(rtems_disk_device *dd);

 /**
 * @name Disk Management
- *
- * @{
 */
+/**@{**/

 /**
 * @brief Initializes the disk device management.
@@ -118,9 +118,8 @@
 *  }
 *  close (fd);
 * @endcode
- *
- * @{
 */
+/**@{**/

 /**
 * @brief The base name of the flash disks.
@@ -40,8 +40,8 @@ extern "C" {
 * actions.  For example a disk attach will lead to inspection of the partition
 * table and mounted file systems.  Clients can register listeners to react to
 * events.
- * @{
 */
+/**@{**/

 #define RTEMS_MEDIA_MOUNT_BASE "/media"

@@ -312,9 +312,8 @@ typedef rtems_status_code (*rtems_media_worker)(

 /**
 * @name Base
- *
- * @{
 */
+/**@{**/

 /**
 * @brief Initializes the media manager.
@@ -377,9 +376,8 @@ rtems_status_code rtems_media_post_event(

 /**
 * @name Server
- *
- * @{
 */
+/**@{**/

 /**
 * @brief Initializes the media manager and media server.
@@ -452,9 +450,8 @@ static inline rtems_status_code rtems_media_server_disk_detach(

 /**
 * @name Path Construction
- *
- * @{
 */
+/**@{**/

 /**
 * @brief Creates a new path as "prefix/name-major".
@@ -490,9 +487,8 @@ char *rtems_media_append_minor(

 /**
 * @name Support
- *
- * @{
 */
+/**@{**/

 /**
 * @brief Returns the device identifier for the device located at
@@ -25,14 +25,13 @@ extern "C" {
 *
 * @ingroup rtems_blkdev
 *
- * @{
 */
+/**@{**/

 /**
 * @name Static Configuration
- *
- * @{
 */
+/**@{**/

 /**
 * @brief RAM disk configuration table entry.
@@ -95,9 +94,8 @@ rtems_device_driver ramdisk_initialize(

 /**
 * @name Runtime Configuration
- *
- * @{
 */
+/**@{**/

 /**
 * @brief RAM disk descriptor.
@@ -37,8 +37,8 @@ extern "C" {
 *
 * @ingroup rtems_blkdev
 *
- * @{
 */
+/**@{**/

 typedef struct {
  rtems_blkdev_bnum  block;
@@ -29,9 +29,8 @@ extern "C" {
 *
 * This driver interface provides support to read and set the real-time clock
 * and to initialize the time of day for the system.
- *
- * @{
 */
+/**@{**/

 /**
 * Device file name path.
@@ -34,8 +34,8 @@ extern "C" {
 *
 * @brief RTEMS Specific Support for the Standard C Library
 *
- * @{
 */
+/**@{**/

 extern void malloc_dump(void);

@@ -47,9 +47,8 @@ extern "C" {
 * @ingroup LibIO
 *
 * @brief File system operations.
- *
- * @{
 */
+/**@{**/

 /**
 * @brief File system node types.
@@ -749,9 +748,8 @@ int rtems_filesystem_default_statvfs(
 * @ingroup LibIO
 *
 * @brief File system node handler.
- *
- * @{
 */
+/**@{**/

 /**
 * @brief Opens a node.
@@ -1143,9 +1141,8 @@ int rtems_filesystem_default_fcntl(
 * system call behavior under RTEMS.  Initially this supported only
 * IO to devices but has since been enhanced to support networking
 * and support for mounted file systems.
- *
- * @{
 */
+/**@{**/

 typedef off_t rtems_off64_t __attribute__((deprecated));

@@ -1240,9 +1237,8 @@ typedef struct {

 /**
 * @name Flag Values
- *
- * @{
 */
+/**@{**/

 #define LIBIO_FLAGS_NO_DELAY      0x0001U  /* return immediately if no data */
 #define LIBIO_FLAGS_READ          0x0002U  /* reading */
@@ -1264,9 +1260,8 @@ void rtems_libio_init(void);

 /**
 * @name External I/O Handlers
- *
- * @{
 */
+/**@{**/

 typedef int (*rtems_libio_open_t)(
  const char  *pathname,
@@ -1306,9 +1301,8 @@ typedef off_t (*rtems_libio_lseek_t)(

 /**
 * @name Permission Macros
- *
- * @{
 */
+/**@{**/

 /*
 *  The following macros are used to build up the permissions sets
@@ -1422,15 +1416,13 @@ extern int rtems_mkdir(const char *path, mode_t mode);
 * @ingroup LibIO
 *
 * @brief File system types and mount.
- *
- * @{
 */
+/**@{**/

 /**
 * @name File System Types
- *
- * @{
 */
+/**@{**/

 #define RTEMS_FILESYSTEM_TYPE_IMFS "imfs"
 #define RTEMS_FILESYSTEM_TYPE_MINIIMFS "mimfs"
@@ -1701,9 +1693,8 @@ extern const rtems_filesystem_mount_configuration
 * @ingroup LibIO
 *
 * @brief Termios
- *
- * @{
 */
+/**@{**/

 typedef struct rtems_termios_callbacks {
  int    (*firstOpen)(int major, int minor, void *arg);
@@ -36,8 +36,8 @@ extern "C" {
 *
 * @brief Internal IO library API and implementation.
 *
- * @{
 */
+/**@{**/

 #define RTEMS_FILESYSTEM_SYMLOOP_MAX 32

@@ -31,8 +31,8 @@ extern "C" {
 *
 * @brief POSIX Termios Implementation
 * 
- * @{
 */
+/**@{**/

 typedef unsigned char	cc_t;
 typedef unsigned int	speed_t;
@@ -26,4 +26,4 @@

 /**
 *  BSD 4.3 and SVR4 - Get File Status
- */
+ */
@@ -33,8 +33,8 @@ int rtems_dosfs_initialize(rtems_filesystem_mount_table_entry_t *mt_entry,
 *
 * @ingroup FileSystemTypesAndMount
 *
- * @{
 */
+/**@{**/

 #define MSDOS_FMT_INFO_LEVEL_NONE   (0)
 #define MSDOS_FMT_INFO_LEVEL_INFO   (1)
@@ -67,8 +67,8 @@ extern "C" {
 *
 * @brief I2C library.
 *
- * @{
 */
+/**@{**/

 /* Simple I2C driver API */

@@ -64,8 +64,8 @@ extern "C" {
 *
 * @ingroup FileSystemTypesAndMount
 *
- * @{
 */
+/**@{**/

 /**
 * File system mount report and abort condition flags.
@@ -70,9 +70,8 @@ extern "C" {
 *
 * For the data transfer passive (= default) and active (= fallback) mode are
 * supported.
- *
- * @{
 */
+/**@{**/

 /**
 * @brief Well-known port number for FTP control connection.
@@ -32,8 +32,8 @@ extern "C" {
 *
 * @brief POSIX Asynchronous Input and Output
 * 
- * @{
 */
+/**@{**/

 #if defined(_POSIX_ASYNCHRONOUS_IO)

@@ -45,8 +45,8 @@
 *
 * @ingroup POSIXAPI
 * 
- * @{
 */
+/**@{**/

 #ifdef __cplusplus
 extern "C" {
@@ -33,8 +33,8 @@
 * This encapsulates functionality which implements the RTEMS API
 * Barrier Manager.
 * 
- * @{
 */
+/**@{**/

 #ifdef __cplusplus
 extern "C" {
@@ -24,8 +24,8 @@
 *
 * @ingroup POSIXAPI
 * 
- * @{
 */
+/**@{**/
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -26,8 +26,8 @@
 *
 * @ingroup POSIXAPI
 * 
- * @{
 */
+/**@{**/

 #ifdef __cplusplus
 extern "C" {
@@ -42,8 +42,8 @@
 *
 *  @ingroup POSIXAPI
 * 
- * @{
 */
+/**@{**/
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -30,8 +30,8 @@ extern "C" {
 *
 * @brief Private Support Information for POSIX Mutex
 * 
- * @{
 */
+/**@{**/

 #include <rtems/score/coremutex.h>
 #include <pthread.h>
@@ -27,8 +27,8 @@
 *
 * RTEMS POSIX API definitions and modules.
 *
- * @{
 */
+/**@{**/

 /**
 * @brief Initialize POSIX API.
@@ -26,8 +26,8 @@
 *
 * @brief Interface to the POSIX Priority Implementation
 * 
- * @{
 */
+/**@{**/

 #include <rtems/score/priority.h>

@@ -25,8 +25,8 @@
 *
 * @brief Internal Information about POSIX Signals
 * 
- * @{
 */
+/**@{**/

 #include <rtems/posix/psignal.h>
 #include <rtems/posix/pthread.h>
@@ -34,8 +34,8 @@ extern "C" {
 *
 * @brief Private Support Information for POSIX Threads
 * 
- * @{
 */
+/**@{**/

 /**
 * The following sets the minimum stack size for POSIX threads.
@@ -27,8 +27,8 @@
 *
 * @ingroup POSIXAPI
 * 
- * @{
 */
+/**@{**/
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -36,8 +36,8 @@ extern "C" {
 *
 * @brief Constants and Structures Associated with the POSIX RWLock Manager
 * 
- * @{
 */
+/**@{**/

 #include <rtems/score/object.h>
 #include <rtems/score/corerwlock.h>
@@ -36,8 +36,8 @@ extern "C" {
 *
 * @brief Constants and Structures Associated with the POSIX Spinlock Manager
 * 
- * @{
 */
+/**@{**/

 #include <rtems/score/object.h>
 #include <rtems/score/corespinlock.h>
@@ -27,8 +27,8 @@
 *
 *  @ingroup POSIXAPI
 * 
- * @{
 */
+/**@{**/
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -26,8 +26,8 @@
 *
 * @ingroup POSIXAPI
 * 
- * @{
 */
+/**@{**/

 /**
 * @brief Absolute timeout conversion results.
@@ -223,9 +223,8 @@ rtems_status_code rtems_event_receive (
 * The event @ref RTEMS_EVENT_SYSTEM_TRANSIENT is used for transient usage.
 * See also @ref ClassicEventTransient.  This event may be used by every entity
 * that fulfils its usage pattern.
- *
- * @{
 */
+/**@{**/

 /**
 * @brief Reserved system event for network SBWAIT usage.
@@ -367,9 +366,8 @@ rtems_status_code rtems_event_system_receive(
 *   assert(req.work_done);
 * }
 * @endcode
- *
- * @{
 */
+/**@{**/

 /**
 * @brief See rtems_event_system_send().
@@ -26,9 +26,8 @@ extern "C" {

 /**
 * @addtogroup ClassicRTEMS
- *
- * @{
 */
+/**@{**/

 /**
 * @brief Returns the number of micro seconds for the milli seconds value @a _ms.
@@ -57,9 +56,8 @@ extern "C" {
 * @ingroup ClassicRTEMS
 *
 * Workspace definitions.
- *
- * @{
 */
+/**@{**/

 /**
 * @brief Gets Workspace Information
@@ -40,9 +40,8 @@ extern "C" {

 /**
 * @addtogroup ClassicRTEMS
- *
- * @{
 */
+/**@{**/

 #ifdef RTEMS_DEPRECATED_TYPES
 /**
@@ -1,7 +1,7 @@
 /**
 * @file rtems/rtems/region.inl
 *
- * @defgroup ClassicRegion 
+ * @addtogroup ClassicRegion 
 *
 * @ingroup ClassicRTEMS
 * @brief Macro Implementation from Region Manager
@@ -23,9 +23,8 @@

 /**
 * @addtogroup ClassicRTEMS
- *
- * @{
 */
+/**@{**/

 /**
 * @brief Returns @c true if the name is valid, and @c false otherwise.
@@ -32,9 +32,8 @@ extern "C" {
 * @ingroup ClassicRTEMS
 *
 * @brief Chain API
- *
- * @{
 */
+/**@{**/

 typedef Chain_Node rtems_chain_node;

@@ -58,9 +57,8 @@ typedef Chain_Control rtems_chain_control;

 /**
 * @addtogroup ClassicChains
- *
- * @{
 */
+/**@{**/

 /**
 * @brief Appends the @a node to the @a chain and sends the @a events to the
@@ -170,9 +170,8 @@ typedef User_extensions_routine
 * will operate correctly even if they utilize the C Library because the C
 * Library's task delete extension is invoked after that of the other
 * extensions.
- *
- * @{
 */
+/**@{**/

 typedef User_extensions_thread_create_extension   rtems_task_create_extension;
 typedef User_extensions_thread_delete_extension   rtems_task_delete_extension;
@@ -30,9 +30,8 @@ extern "C" {
 *
 * @brief The Fatal Manager provides functions for fatal system states and or
 * irrecoverable errors.
- *
- * @{
 */
+/**@{**/

 /**
 * @brief Exception frame.
@@ -34,8 +34,8 @@ extern "C" {
 *
 * @ingroup ClassicRTEMS
 *
- * @{
 */
+/**@{**/

 typedef uint32_t rtems_device_major_number;

@@ -60,9 +60,8 @@ typedef struct {

 /**
 * @name Device Driver Maintainance
- *
- * @{
 */
+/**@{**/

 /**
 * @brief Returns @c RTEMS_IO_ERROR.
@@ -26,9 +26,8 @@

 /**
 * @addtogroup ClassicChains
- *
- * @{
 */
+/**@{**/

 /**
 * @brief Initialize a chain Header.
@@ -24,9 +24,8 @@

 /**
 * @addtogroup TimespecAPI Timespec
- *
- * @{
 */
+/**@{**/

 /**
 * @brief Is timespec valid
@@ -50,9 +50,8 @@
 * @ingroup ScoreCPU
 *
 * @brief ARM Assembler Support
- *
- * @{
 */
+/**@{**/

 /*
 *  Recent versions of GNU cpp define variables which indicate the
@@ -26,9 +26,8 @@ extern "C" {

 /**
 * @addtogroup ScoreCPU
- *
- * @{
 */
+/**@{**/

 /*
 *  This file contains the information required to build
--- a/Show More
+++ b/Show More