doxygen: Switch @brief and @ingroup

This order change fixes the Latex documentation build via Doxygen.
This commit is contained in:
Sebastian Huber
2020-04-27 16:14:06 +02:00
parent 0b41675971
commit cfe8f7a9b7
393 changed files with 786 additions and 393 deletions

View File

@@ -1,9 +1,10 @@
/**
* @file
*
* @brief RFS File system Initialization
* @ingroup rtems_rfs
*
* @brief RFS File system Initialization
*
* RTEMS File System
*
*/

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Manage Partitions of a Disk Device
* @ingroup rtems_bdpart
*
* @brief Manage Partitions of a Disk Device
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Prints the Partition Table @a Partitions with @a Count Partitions
* @ingroup rtems_bdpart
*
* @brief Prints the Partition Table @a Partitions with @a Count Partitions
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Block Device Partition Management
* @ingroup rtems_bdpart
*
* @brief Block Device Partition Management
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Block Device Partition Management
* @ingroup rtems_bdpart
*
* @brief Block Device Partition Management
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Block Device Partition Management
* @ingroup rtems_bdpart
*
* @brief Block Device Partition Management
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Block Device Partition Management
* @ingroup rtems_bdpart
*
* @brief Block Device Partition Management
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Block Device Partition Management
* @ingroup rtems_bdpart
*
* @brief Block Device Partition Management
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Block Device Statistics Command
* @ingroup rtems_blkdev Block Device Management
*
* @brief Block Device Statistics Command
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Block Device IMFS
* @ingroup libblock
*
* @brief Block Device IMFS
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Common IO Control Primitive
* @ingroup rtems_blkdev
*
* @brief Common IO Control Primitive
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Prints the Block Device Statistics
* @ingroup rtems_blkdev Block Device Management
*
* @brief Prints the Block Device Statistics
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Block Device Management
* @ingroup rtems_blkdev
*
* @brief Block Device Management
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Block Device Disk Management Initialize
* @ingroup rtems_disk Block Device Disk Management
*
* @brief Block Device Disk Management Initialize
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Flash Disk Block Device Implementation
* @ingroup libblock
*
* @brief Flash Disk Block Device Implementation
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Library supporting "MS-DOS-style" Partition Table
* @ingroup libblock
*
* @brief Library supporting "MS-DOS-style" Partition Table
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Provide SRAM support for the NV Disk
* @ingroup libblock
*
* @brief Provide SRAM support for the NV Disk
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Non-Volatile Disk Block Device Implementation
* @ingroup libblock
*
* @brief Non-Volatile Disk Block Device Implementation
*/
/*

View File

@@ -1,9 +1,10 @@
/**
* @file
*
* @brief Enable the Monitor to Show bdbuf Information
* @ingroup rtems_bdpart
*
* @brief Enable the Monitor to Show bdbuf Information
*
* This module inspects the bdbuf data structures,
* assuming they are static, but in fact they are used very
* dynamically. Therefore the results show MAY BE INCORRECT in

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief _realloc_r Implementation
* @ingroup libcsupport
*
* @brief _realloc_r Implementation
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief access() - POSIX 1003.1b 5.6.3 - File Accessibility
* @ingroup libcsupport
*
* @brief access() - POSIX 1003.1b 5.6.3 - File Accessibility
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Associate Local by Name
* @ingroup Associativity Routines
*
* @brief RTEMS Associate Local by Name
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Assoc Routines
* @ingroup Associativity Routines
*
* @brief RTEMS Assoc Routines
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief POSIX 1003.1b - 5.2.1 - Change Current Working Directory
* @ingroup libio Internal Interface
*
* @brief POSIX 1003.1b - 5.2.1 - Change Current Working Directory
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Change Root Directory
* @ingroup libcsupport
*
* @brief Change Root Directory
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief POSIX 1003.1b 6.3.1 - Close a File
* @ingroup libcsupport
*
* @brief POSIX 1003.1b 6.3.1 - Close a File
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief POSIX 1003.1b 6.2.1 Duplicate an Open File Descriptor
* @ingroup libcsupport
*
* @brief POSIX 1003.1b 6.2.1 Duplicate an Open File Descriptor
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief POSIX 1003.1b 6.5.2 - File Control
* @ingroup libcsupport
*
* @brief POSIX 1003.1b 6.5.2 - File Control
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief POSIX 1003.1b 6.6.2 - Synchronize the Data of a File
* @ingroup libcsupport
*
* @brief POSIX 1003.1b 6.6.2 - Synchronize the Data of a File
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief calloc()
* @ingroup libcsupport
*
* @brief calloc()
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief ioctl() system call
* @ingroup libcsupport
*
* @brief ioctl() system call
*/
/*

View File

@@ -1,9 +1,10 @@
/**
* @file
*
* @brief Kill No POSIX
* @ingroup libcsupport
*
* @brief Kill No POSIX
*
* Marginal implementations of some POSIX API routines
* to be used when POSIX is disabled.
*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Get Real User, Effective User, Ral Group, and Effective Group IDs
* @ingroup libcsupport
*
* @brief Get Real User, Effective User, Ral Group, and Effective Group IDs
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Mount table entry visitor.
* @ingroup Termios Termios
*
* @brief Mount table entry visitor.
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Get System Name
* @ingroup utsname Service
*
* @brief Get System Name
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief POSIX 1003.1b 6.4.2 - Write to a File
* @ingroup libcsupport
*
* @brief POSIX 1003.1b 6.4.2 - Write to a File
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default File System has nodes equal
* @ingroup LibIOFSOps File System Operations
*
* @brief RTEMS Default File System has nodes equal
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default File System creates a child process
* @ingroup LibIOFSOps File System Operations
*
* @brief RTEMS Default File System creates a child process
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default File System evaluates relative pathname to absolute
* @ingroup LibIOFSOps File System Operations
*
* @brief RTEMS Default File System evaluates relative pathname to absolute
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default Filesystem - Default FCNTL
* @ingroup libfs
*
* @brief RTEMS Default Filesystem - Default FCNTL
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default Filesystem - Default Freenode
* @ingroup libfs
*
* @brief RTEMS Default Filesystem - Default Freenode
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default File System gets file status
* @ingroup LibIOFSOps File System Operations
*
* @brief RTEMS Default File System gets file status
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default File System Synchronises changes to a file
* @ingroup LibIOFSOps File System Operations
*
* @brief RTEMS Default File System Synchronises changes to a file
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default Filesystem succeeds synchronizing file's in-core state
* @ingroup LibIOFSOps File System Operations
*
* @brief RTEMS Default Filesystem succeeds synchronizing file's in-core state
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default File System Truncates a file to indicated length
* @ingroup LibIOFSOps File System Operations
*
* @brief RTEMS Default File System Truncates a file to indicated length
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default Filesystem - Default Ftruncate Directory
* @ingroup libfs
*
* @brief RTEMS Default Filesystem - Default Ftruncate Directory
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default File System controls a STREAMS device
* @ingroup LibIOFSOps File System Operations
*
* @brief RTEMS Default File System controls a STREAMS device
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default File System locks and unlocks rtems filesystem
* @ingroup LibIOFSOps File System Operations
*
* @brief RTEMS Default File System locks and unlocks rtems filesystem
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default File System reposits the read/write file offset
* @ingroup LibIOFSOps File System Operations
*
* @brief RTEMS Default File System reposits the read/write file offset
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default File System reposits read/write file offset directory
* @ingroup LibIOFSOps File System Operations
*
* @brief RTEMS Default File System reposits read/write file offset directory
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default File System reposits the offset of the open file fd
* @ingroup LibIOFSOps File System Operations
*
* @brief RTEMS Default File System reposits the offset of the open file fd
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default File System creates a special or ordinary file
* @ingroup LibIOFSOps File System Operations
*
* @brief RTEMS Default File System creates a special or ordinary file
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default File System mounts a filesystem
* @ingroup LibIOFSOps File System Operations
*
* @brief RTEMS Default File System mounts a filesystem
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default Filesystem - Default Open
* @ingroup libfs
*
* @brief RTEMS Default Filesystem - Default Open
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default Filesystem - Default Readlink
* @ingroup libfs
*
* @brief RTEMS Default Filesystem - Default Readlink
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default File System Rename Files
* @ingroup LibIOFSOps File System Operations
*
* @brief RTEMS Default File System Rename Files
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default Filesystem - Default Remove Node
* @ingroup libfs
*
* @brief RTEMS Default Filesystem - Default Remove Node
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default File System creates a symbolic link to a file
* @ingroup LibIOFSOps File System Operations
*
* @brief RTEMS Default File System creates a symbolic link to a file
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default File System Unmounts
* @ingroup LibIOFSOps File System Operations
*
* @brief RTEMS Default File System Unmounts
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default File System sets file access and modification times
* @ingroup LibIOFSOps File System Operations
*
* @brief RTEMS Default File System sets file access and modification times
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Default File System sends a message to another user
* @ingroup LibIOFSOps File System Operations
*
* @brief RTEMS Default File System sends a message to another user
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Low-level Operations on a Volume with a DOSFS FAT filesystem
* @ingroup libfs
*
* @brief Low-level Operations on a Volume with a DOSFS FAT filesystem
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief General operations on File Allocation Table
* @ingroup libfs_ffo Fat Fat Operations
*
* @brief General operations on File Allocation Table
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief General operations on "fat-file"
* @ingroup libfs_ff Fat File
*
* @brief General operations on "fat-file"
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief MDOS Date Conversion
* @ingroup libfs_msdos MSDOS FileSystem
*
* @brief MDOS Date Conversion
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Create a new MSDOS FileSystem node
* @ingroup libfs_msdos MSDOS FileSystem
*
* @brief Create a new MSDOS FileSystem node
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief MSDOS Directory Handlers Implementation
* @ingroup libfs_msdos MSDOS FileSystem
*
* @brief MSDOS Directory Handlers Implementation
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief MSDOS Evaluation Routines
* @ingroup libfs
*
* @brief MSDOS Evaluation Routines
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief MSDOS File Handlers Implementation
* @ingroup libfs
*
* @brief MSDOS File Handlers Implementation
*/
/*

View File

@@ -1,9 +1,10 @@
/**
* @file
*
* @brief RTEMS MSDOS Format Functionality
* @ingroup libfs
*
* @brief RTEMS MSDOS Format Functionality
*
* This function formats a disk partition conforming to MS-DOS conventions
*/

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Call Fat-File Close Routine
* @ingroup libfs_msdos MSDOS FileSystem
*
* @brief Call Fat-File Close Routine
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Shut Down MSDOS FileSystem
* @ingroup libfs_msdos MSDOS FileSystem
*
* @brief Shut Down MSDOS FileSystem
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Directory Handlers Table for MSDOS FileSystem
* @ingroup libfs
*
* @brief Directory Handlers Table for MSDOS FileSystem
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief File Operations Table for MSDOS FileSystem
* @ingroup libfs
*
* @brief File Operations Table for MSDOS FileSystem
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Init Routine for MSDOS
* @ingroup libfs
*
* @brief Init Routine for MSDOS
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief MSDOS Filesystem Initialization
* @ingroup libfs_msdos MSDOS FileSystem
*
* @brief MSDOS Filesystem Initialization
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Miscellaneous Routines Implementation for MSDOS FileSystem
* @ingroup libfs
*
* @brief Miscellaneous Routines Implementation for MSDOS FileSystem
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Routine for Node Creation in MSDOS Filesystem
* @ingroup libfs_msdos MSDOS FileSystem
*
* @brief Routine for Node Creation in MSDOS Filesystem
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Rename a MSDOS FileSystem Node
* @ingroup libfs_msdos MSDOS FileSystem
*
* @brief Rename a MSDOS FileSystem Node
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Remove Node from MSDOS Directory
* @ingroup libfs_msdos MSDOS FileSystem
*
* @brief Remove Node from MSDOS Directory
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Obtain MS-DOS filesystem information
* @ingroup libfs_msdos MSDOS FileSystem
*
* @brief Obtain MS-DOS filesystem information
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief IMFS Device Node Handlers
* @ingroup IMFS
*
* @brief IMFS Device Node Handlers
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief IMFS Change Owner
* @ingroup IMFS
*
* @brief IMFS Change Owner
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief IMFS Limits and Options
* @ingroup IMFS
*
* @brief IMFS Limits and Options
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Create an IMFS Node
* @ingroup IMFS
*
* @brief Create an IMFS Node
*/
/*
* COPYRIGHT (c) 1989-2010.

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Evaluation IMFS Node Support
* @ingroup IMFS
*
* @brief Evaluation IMFS Node Support
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Change IMFS File Mode
* @ingroup IMFS
*
* @brief Change IMFS File Mode
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief FIFO Support
* @ingroup IMFS
*
* @brief FIFO Support
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Unmount this Instance of IMFS
* @ingroup IMFS
*
* @brief Unmount this Instance of IMFS
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Device Operations Table
* @ingroup IMFS
*
* @brief Device Operations Table
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief IMFS Node Support
* @ingroup IMFS
*
* @brief IMFS Node Support
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief IMFS Create a New Link Node
* @ingroup IMFS
*
* @brief IMFS Create a New Link Node
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief RTEMS Load Tarfs
* @ingroup IMFS
*
* @brief RTEMS Load Tarfs
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief IMFS Make a Generic Node
* @ingroup IMFS
*
* @brief IMFS Make a Generic Node
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief IMFS Memory File Handlers
* @ingroup IMFS
*
* @brief IMFS Memory File Handlers
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Create a IMFS Node
* @ingroup IMFS
*
* @brief Create a IMFS Node
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief Mount an IMFS
* @ingroup IMFS
*
* @brief Mount an IMFS
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief IMFS Node Support
* @ingroup IMFS
*
* @brief IMFS Node Support
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief IMFS Rename
* @ingroup IMFS
*
* @brief IMFS Rename
*/
/*

View File

@@ -1,8 +1,9 @@
/**
* @file
*
* @brief IMFS Node Removal Handler
* @ingroup IMFS
*
* @brief IMFS Node Removal Handler
*/
/*

Some files were not shown because too many files have changed in this diff Show More