From 3247b16f7a7c2099574ec28600e7acc9e8429e72 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Fri, 2 Sep 2022 10:29:00 +0200 Subject: Add items to Doxygen groups --- cpukit/include/rtems/fatal.h | 2 ++ cpukit/include/rtems/init.h | 2 ++ cpukit/include/rtems/rtems/cache.h | 2 ++ cpukit/include/rtems/rtems/config.h | 2 ++ cpukit/include/rtems/rtems/dpmem.h | 2 ++ cpukit/include/rtems/rtems/intr.h | 2 ++ cpukit/include/rtems/rtems/modes.h | 2 ++ cpukit/include/rtems/rtems/mp.h | 2 ++ cpukit/include/rtems/rtems/object.h | 2 ++ cpukit/include/rtems/rtems/options.h | 2 ++ cpukit/include/rtems/rtems/region.h | 2 ++ cpukit/include/rtems/rtems/status.h | 2 ++ cpukit/include/rtems/rtems/support.h | 2 ++ cpukit/include/rtems/rtems/tasks.h | 36 ++++++++++++++++++----------------- cpukit/include/rtems/rtems/types.h | 2 ++ cpukit/include/rtems/score/basedefs.h | 6 ++++++ 16 files changed, 53 insertions(+), 17 deletions(-) (limited to 'cpukit') diff --git a/cpukit/include/rtems/fatal.h b/cpukit/include/rtems/fatal.h index 0253ab4343..1cc59076fe 100644 --- a/cpukit/include/rtems/fatal.h +++ b/cpukit/include/rtems/fatal.h @@ -3,6 +3,8 @@ /** * @file * + * @ingroup RTEMSImplClassic + * * @brief This header file defines the Fatal Error Manager API. */ diff --git a/cpukit/include/rtems/init.h b/cpukit/include/rtems/init.h index a821f92107..d386a0bcea 100644 --- a/cpukit/include/rtems/init.h +++ b/cpukit/include/rtems/init.h @@ -3,6 +3,8 @@ /** * @file * + * @ingroup RTEMSImplClassic + * * @brief This header file defines the Initialization Manager API. */ diff --git a/cpukit/include/rtems/rtems/cache.h b/cpukit/include/rtems/rtems/cache.h index c7c19b80e2..e869769393 100644 --- a/cpukit/include/rtems/rtems/cache.h +++ b/cpukit/include/rtems/rtems/cache.h @@ -3,6 +3,8 @@ /** * @file * + * @ingroup RTEMSImplClassicCache + * * @brief This header file defines the Cache Manager API. */ diff --git a/cpukit/include/rtems/rtems/config.h b/cpukit/include/rtems/rtems/config.h index 2a12c8f3cb..3d813c55b6 100644 --- a/cpukit/include/rtems/rtems/config.h +++ b/cpukit/include/rtems/rtems/config.h @@ -3,6 +3,8 @@ /** * @file * + * @ingroup RTEMSImplClassic + * * @brief This header file provides parts of the application configuration * information API. */ diff --git a/cpukit/include/rtems/rtems/dpmem.h b/cpukit/include/rtems/rtems/dpmem.h index 9ecdf3a170..855ea3ddc6 100644 --- a/cpukit/include/rtems/rtems/dpmem.h +++ b/cpukit/include/rtems/rtems/dpmem.h @@ -3,6 +3,8 @@ /** * @file * + * @ingroup RTEMSImplClassicDPMem + * * @brief This header file defines the Dual-Ported Memory Manager API. */ diff --git a/cpukit/include/rtems/rtems/intr.h b/cpukit/include/rtems/rtems/intr.h index c53cf694ba..1113f3f76b 100644 --- a/cpukit/include/rtems/rtems/intr.h +++ b/cpukit/include/rtems/rtems/intr.h @@ -3,6 +3,8 @@ /** * @file * + * @ingroup RTEMSImplClassic + * * @brief This header file defines the Interrupt Manager API. */ diff --git a/cpukit/include/rtems/rtems/modes.h b/cpukit/include/rtems/rtems/modes.h index 559029d2da..038a84676d 100644 --- a/cpukit/include/rtems/rtems/modes.h +++ b/cpukit/include/rtems/rtems/modes.h @@ -3,6 +3,8 @@ /** * @file * + * @ingroup RTEMSImplClassicModes + * * @brief This header file provides the task modes API of the Task Manager. */ diff --git a/cpukit/include/rtems/rtems/mp.h b/cpukit/include/rtems/rtems/mp.h index 91c31047fb..614a65fe4c 100644 --- a/cpukit/include/rtems/rtems/mp.h +++ b/cpukit/include/rtems/rtems/mp.h @@ -3,6 +3,8 @@ /** * @file * + * @ingroup RTEMSImplClassic + * * @brief This header file defines the Multiprocessing Manager API. */ diff --git a/cpukit/include/rtems/rtems/object.h b/cpukit/include/rtems/rtems/object.h index e80303da28..02b8ef01e2 100644 --- a/cpukit/include/rtems/rtems/object.h +++ b/cpukit/include/rtems/rtems/object.h @@ -3,6 +3,8 @@ /** * @file * + * @ingroup RTEMSImplClassicObject + * * @brief This header file provides the Object Services API. */ diff --git a/cpukit/include/rtems/rtems/options.h b/cpukit/include/rtems/rtems/options.h index 60d90f997e..5328c383b5 100644 --- a/cpukit/include/rtems/rtems/options.h +++ b/cpukit/include/rtems/rtems/options.h @@ -3,6 +3,8 @@ /** * @file * + * @ingroup RTEMSImplClassic + * * @brief This header file provides the Classic API directive options. */ diff --git a/cpukit/include/rtems/rtems/region.h b/cpukit/include/rtems/rtems/region.h index 1e35344f7d..94a8d7008f 100644 --- a/cpukit/include/rtems/rtems/region.h +++ b/cpukit/include/rtems/rtems/region.h @@ -3,6 +3,8 @@ /** * @file * + * @ingroup RTEMSImplClassicRegion + * * @brief This header file defines the Region Manager API. */ diff --git a/cpukit/include/rtems/rtems/status.h b/cpukit/include/rtems/rtems/status.h index 872bb9b2b3..29bcb27dc1 100644 --- a/cpukit/include/rtems/rtems/status.h +++ b/cpukit/include/rtems/rtems/status.h @@ -3,6 +3,8 @@ /** * @file * + * @ingroup RTEMSImplClassic + * * @brief This header file provides the status codes of Classic API directives * and support functions. */ diff --git a/cpukit/include/rtems/rtems/support.h b/cpukit/include/rtems/rtems/support.h index 60e090ccec..356e29739b 100644 --- a/cpukit/include/rtems/rtems/support.h +++ b/cpukit/include/rtems/rtems/support.h @@ -3,6 +3,8 @@ /** * @file * + * @ingroup RTEMSImplClassic + * * @brief This header file defines support services of the API. */ diff --git a/cpukit/include/rtems/rtems/tasks.h b/cpukit/include/rtems/rtems/tasks.h index ba05d92531..6d643b7fbe 100644 --- a/cpukit/include/rtems/rtems/tasks.h +++ b/cpukit/include/rtems/rtems/tasks.h @@ -283,6 +283,25 @@ typedef struct { rtems_task_argument argument; } rtems_initialization_tasks_table; +/* Generated from spec:/rtems/task/if/maximum-priority-impl */ + +/** + * @ingroup RTEMSImplClassicTask + * + * @brief Returns the maximum priority of the scheduler with index zero. + */ +rtems_task_priority _RTEMS_Maximum_priority( void ); + +/* Generated from spec:/rtems/task/if/maximum-priority */ + +/** + * @ingroup RTEMSAPIClassicTasks + * + * @brief This runtime constant represents the lowest (least important) task + * priority of the scheduler with index zero. + */ +#define RTEMS_MAXIMUM_PRIORITY _RTEMS_Maximum_priority() + /* Generated from spec:/rtems/task/if/minimum-priority */ /** @@ -401,23 +420,6 @@ typedef bool( *rtems_task_visitor )( rtems_tcb *, void * ); */ #define RTEMS_YIELD_PROCESSOR WATCHDOG_NO_TIMEOUT -/* Generated from spec:/score/if/maximum-priority */ - -/** - * @brief Returns the maximum priority of the scheduler with index zero. - */ -rtems_task_priority _RTEMS_Maximum_priority( void ); - -/* Generated from spec:/rtems/task/if/maximum-priority */ - -/** - * @ingroup RTEMSAPIClassicTasks - * - * @brief This runtime constant represents the lowest (least important) task - * priority of the scheduler with index zero. - */ -#define RTEMS_MAXIMUM_PRIORITY _RTEMS_Maximum_priority() - /* Generated from spec:/rtems/task/if/create */ /** diff --git a/cpukit/include/rtems/rtems/types.h b/cpukit/include/rtems/rtems/types.h index caa75b4f0d..4779e61b9c 100644 --- a/cpukit/include/rtems/rtems/types.h +++ b/cpukit/include/rtems/rtems/types.h @@ -3,6 +3,8 @@ /** * @file * + * @ingroup RTEMSImplClassic + * * @brief This header file provides types used by the Classic API. */ diff --git a/cpukit/include/rtems/score/basedefs.h b/cpukit/include/rtems/score/basedefs.h index 7a37299eee..d5a78f1950 100644 --- a/cpukit/include/rtems/score/basedefs.h +++ b/cpukit/include/rtems/score/basedefs.h @@ -3,6 +3,8 @@ /** * @file * + * @ingroup RTEMSScore + * * @brief This header file provides basic definitions used by the API and the * implementation. */ @@ -426,6 +428,8 @@ extern "C" { /* Generated from spec:/score/if/assert-unreachable */ /** + * @ingroup RTEMSScore + * * @brief Asserts that this program point is unreachable. */ #if defined(RTEMS_DEBUG) @@ -438,6 +442,8 @@ extern "C" { /* Generated from spec:/score/if/dequalify-types-not-compatible */ /** + * @ingroup RTEMSScore + * * @brief A not implemented function to trigger compile time errors with an * error message. */ -- cgit v1.2.3