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

doxygen: Restructured cpukit/include/rtems/rtems

Browse Source 
Update #3706.
This commit is contained in:
Andreas Dachsberger
2019-03-28 13:27:05 +01:00
committed by Sebastian Huber
parent b86148a624
commit b07c721fc4
55 changed files with 90 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
cpukit/doxygen.h
View File

@@ -3,3 +3,17 @@
*
* @brief RTEMS Implementation.
*/
/**
* @defgroup RTEMSInternalClassic Classic
*
* @ingroup RTEMSInternal
*
* @brief Classic
*/
/**
* @defgroup RTEMSAPI API
*
* @brief API
*/

16
cpukit/include/rtems.h
View File

@@ -1,9 +1,7 @@
/**
* @file
*
* @defgroup ClassicRTEMS RTEMS Classic API
*
* @brief RTEMS Classic API
*
* @ingroup RTEMSAPIClassic
*
* the Public Interface to the RTEMS Classic API
*/
@@ -20,11 +18,13 @@
#define _RTEMS_H
/**
* @defgroup ClassicRTEMS RTEMS Classic API
* @defgroup RTEMSAPIClassic Classic
*
* RTEMS Classic API definitions and modules.
* @ingroup RTEMSAPI
*
* @brief RTEMS Classic API definitions and modules.
*/
/**@{*/
/** @{ */
#include <rtems/system.h>
#include <rtems/rtems/status.h>
@@ -187,7 +187,7 @@ const char *rtems_get_version_string(void);
}
#endif
/**@}*/
/** @} */
#endif
/* end of include file */

2
cpukit/include/rtems/chain.h
View File

@@ -28,7 +28,7 @@ extern "C" {
/**
* @defgroup ClassicChains Chains
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* @brief Chain API
*/

2
cpukit/include/rtems/counter.h
View File

@@ -32,7 +32,7 @@ extern "C" {
/**
* @defgroup ClassicCounter Free-Running Counter and Busy Wait Delay
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* @brief Free-running counter and busy wait delay functions.
*

2
cpukit/include/rtems/extension.h
View File

@@ -32,7 +32,7 @@ typedef User_extensions_routine
/**
* @defgroup ClassicUserExtensions User Extensions
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* @brief The User Extensions Manager allows the application developer to
* augment the executive by allowing them to supply extension routines which

2
cpukit/include/rtems/fatal.h
View File

@@ -26,7 +26,7 @@ extern "C" {
/**
* @defgroup ClassicFatal Fatal
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* @brief The Fatal Manager provides functions for fatal system states and or
* irrecoverable errors.

2
cpukit/include/rtems/io.h
View File

@@ -28,7 +28,7 @@ extern "C" {
/**
* @defgroup ClassicIO Input/Output
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
*/
/**@{**/

2
cpukit/include/rtems/rbheap.h
View File

@@ -32,7 +32,7 @@ extern "C" {
/**
* @defgroup RBHeap Red-Black Tree Heap
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* @brief Red-Black Tree Heap API.
*

2
cpukit/include/rtems/rbtree.h
View File

@@ -29,7 +29,7 @@ extern "C" {
/**
* @defgroup ClassicRBTrees Red-Black Trees
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* @brief A Red-Black Tree container.
*

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

@@ -1,7 +1,7 @@
/**
* @file
*
* @addtogroup ClassicASR
* @ingroup ClassicASR
*
* This include file contains all the constants and structures associated
* with the Asynchronous Signal Handler. This Handler provides the low-level
@@ -28,7 +28,7 @@ extern "C" {
/**
* @defgroup ClassicASR ASR Support
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* This encapsulates functionality related to the Classic API Signal
* Manager.

2
cpukit/include/rtems/rtems/asrimpl.h
View File

@@ -28,7 +28,7 @@ extern "C" {
/**
* @defgroup ClassicASRImpl Classic ASR Implementation
*
* @ingroup ClassicASR
* @ingroup RTEMSInternalClassic
*
* @{
*/

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

@@ -1,7 +1,7 @@
/**
* @file
*
* @addtogroup ClassicAttributes
* @ingroup ClassicAttributes
*
* This include file contains all information about the Object Attributes
* Handler.
@@ -27,7 +27,7 @@ extern "C" {
/**
* @defgroup ClassicAttributes Attributes
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* This encapsulates functionality which defines and manages the
* set of Classic API object attributes.

2
cpukit/include/rtems/rtems/attrimpl.h
View File

@@ -28,7 +28,7 @@ extern "C" {
/**
* @defgroup ClassicAttributesImpl Classic Attributes Implementation
*
* @ingroup ClassicAttributes
* @ingroup RTEMSInternalClassic
*
* @{
*/

2
cpukit/include/rtems/rtems/barrier.h
View File

@@ -28,7 +28,7 @@ extern "C" {
/**
* @defgroup ClassicBarrier Barriers
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* This encapsulates functionality which implements the Classic API
* Barrier Manager.

2
cpukit/include/rtems/rtems/barrierimpl.h
View File

@@ -29,7 +29,7 @@ extern "C" {
/**
* @defgroup ClassicBarrierImpl Classic Barrier Implementation
*
* @ingroup ClassicBarrier
* @ingroup RTEMSInternalClassic
*
* @{
*/

2
cpukit/include/rtems/rtems/cache.h
View File

@@ -28,7 +28,7 @@ extern "C" {
/**
* @defgroup ClassicCache Cache
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* @brief The Cache Manager provides functions to perform maintenance
* operations for data and instruction caches.

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

@@ -1,7 +1,7 @@
/**
* @file
*
* @addtogroup ClassicClock
* @ingroup ClassicClock
*
* This include file contains all the constants and structures associated
* with the Clock Manager. This manager provides facilities to set, obtain,
@@ -33,7 +33,7 @@
/**
* @defgroup ClassicClock Clocks
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* This encapsulates functionality related to the Classic API Clock
* Manager.

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

@@ -1,7 +1,7 @@
/**
* @file
*
* @addtogroup ClassicConfig
* @ingroup ClassicConfig
*
* This include file contains the table of user defined configuration
* parameters specific for the RTEMS API.
@@ -28,7 +28,7 @@ extern "C" {
/**
* @defgroup ClassicConfig Configuration
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* This encapsulates functionality related to the application's configuration
* of the Classic API including the maximum number of each class of objects.

2
cpukit/include/rtems/rtems/dpmem.h
View File

@@ -27,7 +27,7 @@ extern "C" {
/**
* @defgroup ClassicDPMEM Dual Ported Memory
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* This encapsulates functionality related to the
* Classic API Dual Ported Memory Manager.

2
cpukit/include/rtems/rtems/dpmemimpl.h
View File

@@ -27,7 +27,7 @@ extern "C" {
/**
* @defgroup ClassicDPMEMImpl Dual Ported Memory Manager Implementation
*
* @ingroup ClassicDPMEM
* @ingroup RTEMSInternalClassic
*
* @{
*/

2
cpukit/include/rtems/rtems/event.h
View File

@@ -114,7 +114,7 @@ typedef uint32_t rtems_event_set;
/**
* @defgroup ClassicEvent Events
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* @brief The event manager provides a high performance method of intertask
* communication and synchronization.

2
cpukit/include/rtems/rtems/eventimpl.h
View File

@@ -27,7 +27,7 @@ extern "C" {
/**
* @defgroup ClassicEventImpl Classic Event Implementation
*
* @ingroup ClassicEvent
* @ingroup RTEMSInternalClassic
*
* @{
*/

2
cpukit/include/rtems/rtems/eventmp.h
View File

@@ -1,7 +1,7 @@
/**
* @file
*
* @addtogroup ClassicEventMP
* @ingroup ClassicEventMP
*
* This include file contains all the constants and structures associated
* with the Multiprocessing Support in the Event Manager.

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

@@ -1,7 +1,7 @@
/**
* @file
*
* @addtogroup ClassicINTR
* @ingroup ClassicINTR
*
* This include file contains all the constants and structures associated with
* the Interrupt Manager.
@@ -29,7 +29,7 @@ extern "C" {
/**
* @defgroup ClassicINTR Interrupts
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* This encapsulates functionality related to the Classic API Interrupt
* Manager.

2
cpukit/include/rtems/rtems/mainpage.h
View File

@@ -923,7 +923,7 @@
/**
* @defgroup LocalPackages Local Packages
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* @brief Local packages.
*/

2
cpukit/include/rtems/rtems/message.h
View File

@@ -29,7 +29,7 @@ extern "C" {
/**
* @defgroup ClassicMessageQueue Message Queues
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* This encapsulates functionality related to the Classic API Message Queue
* Manager.

2
cpukit/include/rtems/rtems/messageimpl.h
View File

@@ -28,7 +28,7 @@ extern "C" {
/**
* @defgroup ClassicMessageQueueImpl Classic Message Queue Implementation
*
* @ingroup ClassicMessageQueue
* @ingroup RTEMSInternalClassic
*
* @{
*/

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

@@ -1,7 +1,7 @@
/**
* @file
*
* @addtogroup ClassicModes
* @ingroup ClassicModes
*
* This include file contains all constants and structures associated
* with the RTEMS thread and RTEMS_ASR modes.
@@ -27,7 +27,7 @@ extern "C" {
/**
* @defgroup ClassicModes Modes
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* This encapsulates functionality related to the task modes supported
* by the Classic API Task Manager.

2
cpukit/include/rtems/rtems/modesimpl.h
View File

@@ -27,7 +27,7 @@ extern "C" {
/**
* @defgroup ClassicModesImpl Classic Modes Implementation
*
* @ingroup ClassicModes
* @ingroup RTEMSInternalClassic
*
* @{
*/

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

@@ -1,7 +1,7 @@
/**
* @file
*
* @addtogroup ClassicMP
* @ingroup ClassicMP
*
* This include file contains all the constants and structures associated
* with the Multiprocessing Manager.
@@ -21,7 +21,7 @@
/**
* @defgroup ClassicMP Multiprocessing
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* This encapsulates functionality related to the distributed
* Multiprocessing support in the Classic API.

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

@@ -1,7 +1,7 @@
/**
* @file
*
* @addtogroup ClassicClassInfo
* @ingroup ClassicClassInfo
*
* This include file defines Classic API interfaces to Object Services.
*/
@@ -29,7 +29,7 @@ extern "C" {
/**
* @defgroup ClassicClassInfo Object Class Information
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* This encapsulates functionality related to the Classic API Object
* Class Services.

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

@@ -1,7 +1,7 @@
/**
* @file
*
* @addtogroup ClassicOptions
* @ingroup ClassicOptions
*
* This include file contains information which defines the
* options available on many directives.
@@ -27,7 +27,7 @@ extern "C" {
/**
* @defgroup ClassicOptions Classic API Options
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* This encapsulates functionality related to the options argument
* to Classic API blocking operations. The primary option is whether

2
cpukit/include/rtems/rtems/optionsimpl.h
View File

@@ -26,7 +26,7 @@ extern "C" {
/**
* @defgroup ClassicOptionsImpl Classic Options Implementation
*
* @ingroup ClassicOptions
* @ingroup RTEMSInternalClassic
*
* @{
*/

2
cpukit/include/rtems/rtems/part.h
View File

@@ -28,7 +28,7 @@ extern "C" {
/**
* @defgroup ClassicPart Partitions
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* This encapsulates functionality related to the
* Classic API Partition Manager.

2
cpukit/include/rtems/rtems/partimpl.h
View File

@@ -29,7 +29,7 @@ extern "C" {
/**
* @defgroup ClassicPartImpl Classic Partition Manager Implementation
*
* @ingroup ClassicPart
* @ingroup RTEMSInternalClassic
*
* @{
*/

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

@@ -1,7 +1,7 @@
/**
* @file
*
* @addtogroup ClassicRateMon
* @ingroup ClassicRateMon
*
* This include file contains all the constants, structures, and
* prototypes associated with the Rate Monotonic Manager. This manager
@@ -42,7 +42,7 @@ extern "C" {
/**
* @defgroup ClassicRateMon Rate Monotonic Scheduler
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* This encapsulates functionality related to the Classic API Rate
* Monotonic Manager.

2
cpukit/include/rtems/rtems/ratemonimpl.h
View File

@@ -34,7 +34,7 @@ extern "C" {
/**
* @defgroup ClassicRateMonImpl Classic Rate Monotonic Scheduler Implementation
*
* @ingroup ClassicRateMon
* @ingroup RTEMSInternalClassic
*
* @{
*/

2
cpukit/include/rtems/rtems/region.h
View File

@@ -29,7 +29,7 @@ extern "C" {
/**
* @defgroup ClassicRegion Regions
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* This encapsulates functionality related to the Classic API Region
* Manager.

2
cpukit/include/rtems/rtems/regionimpl.h
View File

@@ -30,7 +30,7 @@ extern "C" {
/**
* @defgroup ClassicRegionImpl Classic Region Manager Implementation
*
* @ingroup ClassicRegion
* @ingroup RTEMSInternalClassic
*
* @{
*/

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

@@ -30,7 +30,7 @@ extern "C" {
/**
* @defgroup ClassicSem Semaphores
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* This encapsulates functionality related to the Classic API
* Semaphore Manager.

2
cpukit/include/rtems/rtems/semimpl.h
View File

@@ -29,7 +29,7 @@ extern "C" {
/**
* @defgroup ClassicSemImpl Semaphore Manager Implementation
*
* @ingroup ClassicSem
* @ingroup RTEMSInternalClassic
*
* @{
*/

2
cpukit/include/rtems/rtems/semmp.h
View File

@@ -1,7 +1,7 @@
/**
* @file
*
* @addtogroup ClassicSEM
* @ingroup ClassicSEM
*
* This include file contains all the constants and structures associated
* with the Multiprocessing Support in the Semaphore Manager.

2
cpukit/include/rtems/rtems/signal.h
View File

@@ -29,7 +29,7 @@ extern "C" {
/**
* @defgroup ClassicSignal Signals
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* Directives provided are:
*

2
cpukit/include/rtems/rtems/signalimpl.h
View File

@@ -27,7 +27,7 @@ extern "C" {
/**
* @defgroup ClassicSignalImpl Signals Implementation
*
* @ingroup ClassicSignal
* @ingroup RTEMSInternalClassic
*/
/**@{*/

2
cpukit/include/rtems/rtems/smp.h
View File

@@ -27,7 +27,7 @@ extern "C" {
/**
* @defgroup ClassicSMP SMP Services
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* This encapsulates functionality which is useful for SMP applications.
*

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

@@ -1,7 +1,7 @@
/**
* @file
*
* @addtogroup ClassicStatus
* @ingroup ClassicStatus
*
* This include file contains the status codes returned from the
* executive directives.
@@ -27,7 +27,7 @@ extern "C" {
/**
* @defgroup ClassicStatus Status Codes
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* This encapsulates functionality related to the status codes returned
* by Classic API directives.

2
cpukit/include/rtems/rtems/statusimpl.h
View File

@@ -27,7 +27,7 @@ extern "C" {
/**
* @defgroup ClassicStatusImpl Classic Status Implementation
*
* @ingroup ClassicStatus
* @ingroup RTEMSInternalClassic
*
* @{
*/

6
cpukit/include/rtems/rtems/support.h
View File

@@ -1,7 +1,7 @@
/**
* @file
*
* @addtogroup ClassicRTEMSWorkspace
* @ingroup ClassicRTEMSWorkspace
*/
/* COPYRIGHT (c) 1989-2008.
@@ -23,7 +23,7 @@ extern "C" {
#endif
/**
* @addtogroup ClassicRTEMS
* @addtogroup ClassicTasks
*/
/**@{**/
@@ -78,7 +78,7 @@ RTEMS_INLINE_ROUTINE void rtems_name_to_characters(
/**
* @defgroup ClassicRTEMSWorkspace Workspace
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* Workspace definitions.
*/

2
cpukit/include/rtems/rtems/taskmp.h
View File

@@ -1,7 +1,7 @@
/**
* @file
*
* @addtogroup ClassicTaskMP
* @ingroup ClassicTaskMP
*
* This include file contains all the constants and structures associated
* with the multiprocessing support in the task manager.

2
cpukit/include/rtems/rtems/tasks.h
View File

@@ -29,7 +29,7 @@ extern "C" {
/**
* @defgroup ClassicTasks Tasks
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* This encapsulates the functionality of the Classic API Task Manager.
* This functionality includes task services such as creation, deletion,

2
cpukit/include/rtems/rtems/tasksimpl.h
View File

@@ -29,7 +29,7 @@ extern "C" {
/**
* @defgroup ClassicTasksImpl Classic Tasks Manager Implementation
*
* @ingroup ClassicTasks
* @ingroup RTEMSInternalClassic
*
* @{
*/

2
cpukit/include/rtems/rtems/timer.h
View File

@@ -32,7 +32,7 @@ extern "C" {
/**
* @defgroup ClassicTimer Timers
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* This encapsulates functionality related to the Classic API Timer
* Manager. This manager provides functionality which allows the

2
cpukit/include/rtems/rtems/timerimpl.h
View File

@@ -32,7 +32,7 @@ extern "C" {
/**
* @defgroup ClassicTimerImpl Classic Timer Implementation
*
* @ingroup ClassicTimer
* @ingroup RTEMSInternalClassic
*
* @{
*/

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

@@ -3,7 +3,8 @@
*
* @defgroup ClassicTypes Types
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* @brief Types used by Classic API.
*/
@@ -39,7 +40,7 @@ extern "C" {
#endif
/**
* @addtogroup ClassicRTEMS
* @addtogroup ClassicTasks
*/
/**@{**/

2
cpukit/include/rtems/timespec.h
View File

@@ -27,7 +27,7 @@ extern "C" {
/**
* @defgroup TimespecAPI Timespec
*
* @ingroup ClassicRTEMS
* @ingroup RTEMSAPIClassic
*
* @brief Timespec API
*