mirror of
https://gitlab.rtems.org/rtems/rtos/rtems.git
synced 2026-10-06 10:59:48 +08:00
cpukit: Group the last ungrouped files
Seventy-three files had a Doxygen block but no @ingroup line. Doxygen documented them, but no group page listed them. The PCI headers, the driver manager headers and 46 headers under include/rtems were affected. Give each file the group of the component it belongs to. The seven default file system files follow the table they fill. A file which provides an entry of rtems_filesystem_operations_table joins LibIOFSOps. A file which provides an entry of rtems_filesystem_file_handlers_r joins LibIOFSHandler. Every file in cpukit with a Doxygen block names a group. The files malloc.h, todimpl.h and printk_plugin.c name two groups. The other files name one. Updates #5717. Assisted-by: Claude:claude-opus-5 claude-code Signed-off-by: Sebastian Huber <sebastian.huber@embedded-brains.de>
This commit is contained in:
committed by
Gedare Bloom
parent
cd47dfd2c4
commit
b4d322971c
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplFTPD
|
||||
*
|
||||
* @brief
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplDriverManager
|
||||
*
|
||||
* @brief Driver Manager Interface.
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplDriverManager
|
||||
*
|
||||
* @brief Driver Manager Configuration file.
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplDriverManager
|
||||
*
|
||||
* @brief Linked list help functions used by driver manager.
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplDriverManager
|
||||
*
|
||||
* @brief PCI bus driver Interface.
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplFreeBSDKernel
|
||||
*
|
||||
* @brief
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplFreeBSDKernel
|
||||
*
|
||||
* @brief Dummy include file for FreeBSD routines
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplPOSIXMessageQueue
|
||||
*
|
||||
* @brief POSIX Message Queues
|
||||
*
|
||||
* This file contains the definitions related to POSIX Message Queues.
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplPCI
|
||||
*
|
||||
* @brief PCI Library
|
||||
*
|
||||
* Defines in this file was taken from FreeBSD and auto-generated
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplPCI
|
||||
*
|
||||
* @brief PCI Access Methods
|
||||
*
|
||||
* Routines to access PCI memory/configuration space and other PCI related
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplPCI
|
||||
*
|
||||
* @brief PCI Configuration Library
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplPCI
|
||||
*
|
||||
* @brief PCI Auto Configuration Library
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplPCI
|
||||
*
|
||||
* @brie PCI Peripheral Configuration Libraryf
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplPCI
|
||||
*
|
||||
* @brief PCI Read Configuration Library
|
||||
*
|
||||
* Read current config where bootloader/BIOS has setup.
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplPCI
|
||||
*
|
||||
* @brief Static PCI Auto Configuration Library
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplPCI
|
||||
*
|
||||
* @brief RTEMS local PCI data base
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplPCI
|
||||
*
|
||||
* @brief PCI IRQ Library
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSLegacyBenchmarkDrivers
|
||||
*
|
||||
* @brief RTEMS Benchmark Timer API for all Boards
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplCapture
|
||||
*
|
||||
* This is the Target Interface Command Line Interface. You need
|
||||
* start the RTEMS monitor.
|
||||
*/
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplCapture
|
||||
*
|
||||
* @brief Capture Engine Component of the RTEMS Measurement and
|
||||
* Monitoring System
|
||||
*
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplCapture
|
||||
*
|
||||
* @brief Capture Implementation file
|
||||
*
|
||||
* This file contains an interface between the capture engine and
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSScoreSchedulerCBS
|
||||
*
|
||||
* @brief Constants and Structures Associated
|
||||
* with the CBS library in RTEMS
|
||||
*
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSAPIBaseDefs
|
||||
*
|
||||
* This include file defines ANSI concatenation macros.
|
||||
*/
|
||||
|
||||
|
||||
@@ -2,6 +2,8 @@
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSDeviceConsole
|
||||
*
|
||||
* @brief Console Driver for all Boards
|
||||
*
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup IMFSDevices
|
||||
*
|
||||
* @brief Operations on IMFS Device Nodes
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup libmisc_devnull
|
||||
*
|
||||
* @brief RTEMS /dev/null Device Driver
|
||||
*
|
||||
* This include file defines the interface to the RTEMS /dev/null
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup libmisc_devzero
|
||||
*
|
||||
* @brief RTEMS /dev/zero Device Driver
|
||||
*
|
||||
* This include file defines the interface to the RTEMS /dev/zero
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup libmisc_dumpbuf
|
||||
*
|
||||
* @brief Print a Memory Buffer
|
||||
*
|
||||
* This file defines the interface to the RTEMS methods to print a
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplFreeBSDKernel
|
||||
*
|
||||
* @brief Includes endian information about the target
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup ErrorPanicSupport
|
||||
*
|
||||
* @brief RTEMS Error Reporting
|
||||
*
|
||||
* Defines and externs for rtems error reporting
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup libmisc_fb
|
||||
*
|
||||
* @brief Frame Buffer Device Driver
|
||||
*
|
||||
* This file defines the interface to a frame buffer device driver.
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup libmisc_fb
|
||||
*
|
||||
* @brief Frame Buffer Device Driver for all Boards
|
||||
*
|
||||
* This file describes the Frame Buffer Device Driver for all boards.
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup FileSystemTypesAndMount
|
||||
*
|
||||
* @brief Basic Filesystem Types
|
||||
*
|
||||
* This file defines basic filesystem types
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplFTPD
|
||||
*
|
||||
* @brief FTP Server Information
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup FileSystemTypesAndMount
|
||||
*
|
||||
* @brief File Transfer Protocol file system (FTP client).
|
||||
*/
|
||||
|
||||
|
||||
@@ -2,6 +2,8 @@
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup rtems_libblock
|
||||
*
|
||||
* @brief "MS-DOS-style" Partition Tables Support
|
||||
*/
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup IMFS
|
||||
*
|
||||
* @brief This header file defines the API of the In-Memory File System.
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup IMFS
|
||||
*
|
||||
* @brief This header file contains interfaces used by the implementation of
|
||||
* the In-Memory File System.
|
||||
*/
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMS
|
||||
*
|
||||
* @brief Provide printf() PRIxxx Constante Beyond Standards
|
||||
*
|
||||
* This include file defines PRIxxx constants beyond those in
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSDeviceDrivers
|
||||
*
|
||||
* This include file defines some special characters of interest.
|
||||
*/
|
||||
|
||||
|
||||
@@ -2,6 +2,8 @@
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSDeviceDrivers
|
||||
* @brief Interrupt Handler Support
|
||||
*
|
||||
* This include file describe the data structure and the functions implemented
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup LibIOInternal
|
||||
*
|
||||
* @brief LibIO Internal Interface
|
||||
*
|
||||
* This file is the libio internal interface.
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplMonitor
|
||||
*
|
||||
* @brief The RTEMS Monitor Task
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSDeviceDrivers
|
||||
*
|
||||
* @brief Executive's Pre-Initialized Tables used in a
|
||||
* Multiprocessor Configuration
|
||||
*
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup rtems_libblock
|
||||
*
|
||||
* This driver maps an NV disk to static RAM. You can use this
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup rtems_libblock
|
||||
*
|
||||
* @brief Non-volatile Disk Block Device Implementation
|
||||
*/
|
||||
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplPCI
|
||||
*
|
||||
* PCI defines and function prototypes
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup FIFO_PIPE
|
||||
*
|
||||
* @brief POSIX FIFO/pipe File System Support
|
||||
*
|
||||
* This include file defines the interface to the POSIX FIFO/pipe file system
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup Termios
|
||||
*
|
||||
* @brief /dev/ptyXX (A first version for pseudo-terminals)
|
||||
*/
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSScoreSchedulerCBS
|
||||
*
|
||||
* @brief Constants and Structures Associated
|
||||
* with the QoS RES library in RTEMS
|
||||
*
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup rtems_ramdisk
|
||||
*
|
||||
* @brief RAM Disk Block Device API
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup TermiostypesSupport
|
||||
*
|
||||
* @brief Simple Ring Buffer Functionality
|
||||
*
|
||||
* This file provides simple ring buffer functionality.
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup rtems_rtc
|
||||
*
|
||||
* @brief Real-Time Clock Driver Interface
|
||||
*
|
||||
* Real-time clock driver interface.
|
||||
|
||||
@@ -2,6 +2,8 @@
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup libmisc_mouse
|
||||
*
|
||||
* @brief Serial Mouse Driver
|
||||
*
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSAPIShell
|
||||
*
|
||||
* @brief Instantatiate a New Terminal Shell
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSAPIShell
|
||||
*
|
||||
* RTEMS Shell Command Set Configuration
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSDeviceDrivers
|
||||
*
|
||||
* This file describes the Spurious Interrupt Driver for all boards.
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup rtems_status_checks
|
||||
*
|
||||
* @brief Header File for Status Checks
|
||||
*
|
||||
* @warning Do not include this file in other header files. Use it only in
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup TermiostypesSupport
|
||||
*
|
||||
* RTEMS termios device support internal data structures
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup TimespecAPI
|
||||
*
|
||||
* @brief Timespec API
|
||||
*
|
||||
* This include file contains API for manipulating timespecs.
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup libmisc_untar_img
|
||||
*
|
||||
* @brief Untar an Image
|
||||
*
|
||||
* This file defines the interface to methods which can untar an image.
|
||||
|
||||
@@ -2,6 +2,8 @@
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSDeviceDrivers
|
||||
*
|
||||
* @brief VMEbus Interface Library
|
||||
*
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSDeviceDrivers
|
||||
*
|
||||
* This file describes the Watchdog Driver for all boards.
|
||||
* A watchdog is a hardware device that will reset the board
|
||||
* if not touched in a specific way at a regular interval.
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup LibIOFSOps
|
||||
*
|
||||
* @brief RTEMS Default File System Change Owner
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup LibIOFSHandler
|
||||
*
|
||||
* @brief RTEMS Default File System Close
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup LibIOFSOps
|
||||
*
|
||||
* @brief RTEMS Default File System Change File Mode
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup LibIOFSOps
|
||||
*
|
||||
* @brief RTEMS Default File System Unmount
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup LibIOFSOps
|
||||
*
|
||||
* @brief RTEMS Default File System Link
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup LibIOFSHandler
|
||||
*
|
||||
* @brief RTEMS Default File System Read
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup LibIOFSOps
|
||||
*
|
||||
* @brief RTEMS Default File System Get Statistics
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup FileSystemTypesAndMount
|
||||
*
|
||||
* File Transfer Protocol file system (FTP client).
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplGnat
|
||||
*
|
||||
* @brief ada supplmental functions
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RegulatorInternalAPI
|
||||
*
|
||||
* @brief Regulator Library Implementation
|
||||
*/
|
||||
|
||||
|
||||
Reference in New Issue
Block a user