diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-11-30 14:00:08 +0100 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-12-02 07:45:53 +0100 |
commit | 70dbafbf5ed26d0d434d6428d9f3de1be2ee502a (patch) | |
tree | 872ccc19606d492beddbdc2875a2ef79d8d8bcf0 /cpukit | |
parent | sapi: Canonicalize @defgroup and @file comments (diff) | |
download | rtems-70dbafbf5ed26d0d434d6428d9f3de1be2ee502a.tar.bz2 |
config: Canonicalize @defgroup and @file comments
Adjust group identifier and names to be in line with a common pattern.
Use common phrases for the group and file brief descriptions.
Update #3706.
Diffstat (limited to 'cpukit')
39 files changed, 118 insertions, 73 deletions
diff --git a/cpukit/include/rtems/confdefs.h b/cpukit/include/rtems/confdefs.h index fb4a7b9800..e6dd3d70ee 100644 --- a/cpukit/include/rtems/confdefs.h +++ b/cpukit/include/rtems/confdefs.h @@ -3,14 +3,15 @@ /** * @file * - * @ingroup RTEMSApplicationConfiguration + * @ingroup RTEMSApplConfig * - * @brief Evaluate Configuration Options + * @brief This header file evaluates the application configuration options + * defined by the application. * * This header file includes a couple of header files which evaluate the * configuration options specified by the application. The macros and defines - * used to configure the system are documented in the Configuring a System - * chapter of the Classic API User's Guide. + * used to configure the system are documented in @ref RTEMSApplConfig and the + * "Configuring a System" chapter of the "RTEMS Classic API User's Guide". */ /* @@ -43,14 +44,12 @@ #define __CONFIGURATION_TEMPLATE_h /** - * @defgroup RTEMSApplicationConfiguration Application Configuration + * @defgroup RTEMSImplApplConfig Application Configuration * * @ingroup RTEMSImpl * - * @brief Evaluation of Application Configuration Options - * - * This group contains header files which evaluate the configuration options - * specified by the application. + * @brief The application configuration defines system parameters according to + * configuration options (defines) provided by the application. * * @{ */ diff --git a/cpukit/include/rtems/confdefs/bdbuf.h b/cpukit/include/rtems/confdefs/bdbuf.h index bef1cb8072..79e991f6d9 100644 --- a/cpukit/include/rtems/confdefs/bdbuf.h +++ b/cpukit/include/rtems/confdefs/bdbuf.h @@ -3,9 +3,10 @@ /** * @file * - * @ingroup RTEMSApplicationConfiguration + * @ingroup RTEMSImplApplConfig * - * @brief Evaluate Block Device Cache Configuration Options + * @brief This header file evaluates configuration options related to the block + * device cache configuration. * * It defines * diff --git a/cpukit/include/rtems/confdefs/bsp.h b/cpukit/include/rtems/confdefs/bsp.h index a9a32348d6..03ad9bf55f 100644 --- a/cpukit/include/rtems/confdefs/bsp.h +++ b/cpukit/include/rtems/confdefs/bsp.h @@ -3,9 +3,10 @@ /** * @file * - * @ingroup RTEMSApplicationConfiguration + * @ingroup RTEMSImplApplConfig * - * @brief Evaluate BSP Related Configuration Options + * @brief This header file evaluates configuration options related to the BSP + * configuration. */ /* diff --git a/cpukit/include/rtems/confdefs/clock.h b/cpukit/include/rtems/confdefs/clock.h index 1c70ca0019..4e86ec5d02 100644 --- a/cpukit/include/rtems/confdefs/clock.h +++ b/cpukit/include/rtems/confdefs/clock.h @@ -3,9 +3,10 @@ /** * @file * - * @ingroup RTEMSApplicationConfiguration + * @ingroup RTEMSImplApplConfig * - * @brief Evaluate Clock Configuration Options + * @brief This header file evaluates configuration options related to the clock + * driver configuration. */ /* diff --git a/cpukit/include/rtems/confdefs/console.h b/cpukit/include/rtems/confdefs/console.h index 1e40811279..f4ee59feea 100644 --- a/cpukit/include/rtems/confdefs/console.h +++ b/cpukit/include/rtems/confdefs/console.h @@ -3,9 +3,10 @@ /** * @file * - * @ingroup RTEMSApplicationConfiguration + * @ingroup RTEMSImplApplConfig * - * @brief Evaluate Console Driver Configuration Options + * @brief This header file evaluates configuration options related to the + * console driver configuration. */ /* diff --git a/cpukit/include/rtems/confdefs/extensions.h b/cpukit/include/rtems/confdefs/extensions.h index 15472fa86f..83d690d50a 100644 --- a/cpukit/include/rtems/confdefs/extensions.h +++ b/cpukit/include/rtems/confdefs/extensions.h @@ -3,9 +3,10 @@ /** * @file * - * @ingroup RTEMSApplicationConfiguration + * @ingroup RTEMSImplApplConfig * - * @brief Evaluate User Extensions Configuration Options + * @brief This header file evaluates configuration options related to the user + * extensions configuration. */ /* diff --git a/cpukit/include/rtems/confdefs/inittask.h b/cpukit/include/rtems/confdefs/inittask.h index 3f76bee223..d5ba521bf9 100644 --- a/cpukit/include/rtems/confdefs/inittask.h +++ b/cpukit/include/rtems/confdefs/inittask.h @@ -3,9 +3,10 @@ /** * @file * - * @ingroup RTEMSApplicationConfiguration + * @ingroup RTEMSImplApplConfig * - * @brief Evaluate User Initialization Task Configuration Options + * @brief This header file evaluates configuration options related to the + * Classic API initialization task configuration. * * This header file defines _CONFIGURE_INIT_TASK_STACK_EXTRA for use by other * configuration header files. diff --git a/cpukit/include/rtems/confdefs/initthread.h b/cpukit/include/rtems/confdefs/initthread.h index 6c993603a6..2b3d957515 100644 --- a/cpukit/include/rtems/confdefs/initthread.h +++ b/cpukit/include/rtems/confdefs/initthread.h @@ -3,9 +3,10 @@ /** * @file * - * @ingroup RTEMSApplicationConfiguration + * @ingroup RTEMSImplApplConfig * - * @brief Evaluate POSIX Initialization Thread Configuration Options + * @brief This header file evaluates configuration options related to the POSIX + * initialization thread configuration. * * This header file defines _CONFIGURE_POSIX_INIT_THREAD_STACK_EXTRA for use by * other configuration header files. diff --git a/cpukit/include/rtems/confdefs/iodrivers.h b/cpukit/include/rtems/confdefs/iodrivers.h index 7586fb0eb1..e12640624d 100644 --- a/cpukit/include/rtems/confdefs/iodrivers.h +++ b/cpukit/include/rtems/confdefs/iodrivers.h @@ -3,9 +3,10 @@ /** * @file * - * @ingroup RTEMSApplicationConfiguration + * @ingroup RTEMSImplApplConfig * - * @brief Evaluate IO Driver Configuration Options + * @brief This header file evaluates configuration options related to the I/O + * driver configuration. */ /* diff --git a/cpukit/include/rtems/confdefs/libio.h b/cpukit/include/rtems/confdefs/libio.h index 8f43c490b1..16a4fb6962 100644 --- a/cpukit/include/rtems/confdefs/libio.h +++ b/cpukit/include/rtems/confdefs/libio.h @@ -3,9 +3,10 @@ /** * @file * - * @ingroup RTEMSApplicationConfiguration + * @ingroup RTEMSImplApplConfig * - * @brief Evaluate IO Library Configuration Options + * @brief This header file evaluates configuration options related to the I/O + * library configuration. */ /* diff --git a/cpukit/include/rtems/confdefs/libpci.h b/cpukit/include/rtems/confdefs/libpci.h index 05731f5686..fb30eacdfa 100644 --- a/cpukit/include/rtems/confdefs/libpci.h +++ b/cpukit/include/rtems/confdefs/libpci.h @@ -9,9 +9,10 @@ /** * @file * - * @ingroup RTEMSApplicationConfiguration + * @ingroup RTEMSImplApplConfig * - * @brief This header file evaluates PCI library configuration options. + * @brief This header file evaluates configuration options related to the PCI + * library configuration. */ #ifndef _RTEMS_CONFDEFS_LIBPCI_H diff --git a/cpukit/include/rtems/confdefs/malloc.h b/cpukit/include/rtems/confdefs/malloc.h index 4cd804023f..d864a98270 100644 --- a/cpukit/include/rtems/confdefs/malloc.h +++ b/cpukit/include/rtems/confdefs/malloc.h @@ -3,9 +3,10 @@ /** * @file * - * @ingroup RTEMSApplicationConfiguration + * @ingroup RTEMSImplApplConfig * - * @brief Evaluate C Program Heap Configuration Options + * @brief This header file evaluates configuration options related to the C + * Program Heap configuration. */ /* diff --git a/cpukit/include/rtems/confdefs/mpci.h b/cpukit/include/rtems/confdefs/mpci.h index 0a9be4a2ea..76bdf4af16 100644 --- a/cpukit/include/rtems/confdefs/mpci.h +++ b/cpukit/include/rtems/confdefs/mpci.h @@ -3,9 +3,10 @@ /** * @file * - * @ingroup RTEMSApplicationConfiguration + * @ingroup RTEMSImplApplConfig * - * @brief Evaluate MPCI Configuration Options + * @brief This header file evaluates configuration options related to the MPCI + * configuration. */ /* diff --git a/cpukit/include/rtems/confdefs/newlib.h b/cpukit/include/rtems/confdefs/newlib.h index c535e998f5..96bf850163 100644 --- a/cpukit/include/rtems/confdefs/newlib.h +++ b/cpukit/include/rtems/confdefs/newlib.h @@ -3,9 +3,10 @@ /** * @file * - * @ingroup RTEMSApplicationConfiguration + * @ingroup RTEMSImplApplConfig * - * @brief Evaluate Newlib Configuration Options + * @brief This header file evaluates configuration options related to the + * Newlib C Library configuration. * * This header file defines _CONFIGURE_ENABLE_NEWLIB_REENTRANCY for use by other * configuration header files. diff --git a/cpukit/include/rtems/confdefs/objectsclassic.h b/cpukit/include/rtems/confdefs/objectsclassic.h index ae5ea254fd..ff6f79a30b 100644 --- a/cpukit/include/rtems/confdefs/objectsclassic.h +++ b/cpukit/include/rtems/confdefs/objectsclassic.h @@ -3,9 +3,10 @@ /** * @file * - * @ingroup RTEMSApplicationConfiguration + * @ingroup RTEMSImplApplConfig * - * @brief Evaluate Classic API Objects Configuration Options + * @brief This header file evaluates configuration options related to the + * Classic API objects configuration. * * For the task objects configuration see <rtems/confdefs/threads.h>. */ diff --git a/cpukit/include/rtems/confdefs/objectsposix.h b/cpukit/include/rtems/confdefs/objectsposix.h index 8e8d1794ac..b4685c28f7 100644 --- a/cpukit/include/rtems/confdefs/objectsposix.h +++ b/cpukit/include/rtems/confdefs/objectsposix.h @@ -3,9 +3,10 @@ /** * @file * - * @ingroup RTEMSApplicationConfiguration + * @ingroup RTEMSImplApplConfig * - * @brief Evaluate POSIX API Objects Configuration Options + * @brief This header file evaluates configuration options related to the POSIX + * API objects configuration. * * For the POSIX thread objects configuration see <rtems/confdefs/threads.h>. */ diff --git a/cpukit/include/rtems/confdefs/obsolete.h b/cpukit/include/rtems/confdefs/obsolete.h index 00c6e26101..b8b041efb5 100644 --- a/cpukit/include/rtems/confdefs/obsolete.h +++ b/cpukit/include/rtems/confdefs/obsolete.h @@ -3,9 +3,10 @@ /** * @file * - * @ingroup RTEMSApplicationConfiguration + * @ingroup RTEMSImplApplConfig * - * @brief Evaluate Obsolete Configuration Options + * @brief This header file evaluates configuration options related to obsolete + * configuration options. */ /* diff --git a/cpukit/include/rtems/confdefs/percpu.h b/cpukit/include/rtems/confdefs/percpu.h index f3a9a4f3e7..badb616988 100644 --- a/cpukit/include/rtems/confdefs/percpu.h +++ b/cpukit/include/rtems/confdefs/percpu.h @@ -3,9 +3,10 @@ /** * @file * - * @ingroup RTEMSApplicationConfiguration + * @ingroup RTEMSImplApplConfig * - * @brief Evaluate Per-CPU Configuration Options + * @brief This header file evaluates configuration options related to the + * per-CPU configuration. * * Since the idle thread stack size (CONFIGURE_IDLE_TASK_STACK_SIZE) depends on * CONFIGURE_MINIMUM_TASK_STACK_SIZE, the POSIX-specific diff --git a/cpukit/include/rtems/confdefs/scheduler.h b/cpukit/include/rtems/confdefs/scheduler.h index 9305fc2d90..84ca810fd7 100644 --- a/cpukit/include/rtems/confdefs/scheduler.h +++ b/cpukit/include/rtems/confdefs/scheduler.h @@ -3,9 +3,10 @@ /** * @file * - * @ingroup RTEMSApplicationConfiguration + * @ingroup RTEMSImplApplConfig * - * @brief Evaluate Scheduler Configuration Options + * @brief This header file evaluates configuration options related to the + * scheduler configuration. */ /* diff --git a/cpukit/include/rtems/confdefs/threads.h b/cpukit/include/rtems/confdefs/threads.h index 8f72407695..97508068e2 100644 --- a/cpukit/include/rtems/confdefs/threads.h +++ b/cpukit/include/rtems/confdefs/threads.h @@ -3,9 +3,10 @@ /** * @file * - * @ingroup RTEMSApplicationConfiguration + * @ingroup RTEMSImplApplConfig * - * @brief Evaluate Thread Configuration Options + * @brief This header file evaluates configuration options related to the + * thread configuration. */ /* diff --git a/cpukit/include/rtems/confdefs/unlimited.h b/cpukit/include/rtems/confdefs/unlimited.h index 3f0c66b459..41e79af1ba 100644 --- a/cpukit/include/rtems/confdefs/unlimited.h +++ b/cpukit/include/rtems/confdefs/unlimited.h @@ -3,9 +3,10 @@ /** * @file * - * @ingroup RTEMSApplicationConfiguration + * @ingroup RTEMSImplApplConfig * - * @brief Evaluate Unlimited Objects Configuration Options + * @brief This header file evaluates configuration options related to the + * unlimited objects configuration. */ /* diff --git a/cpukit/include/rtems/confdefs/wkspace.h b/cpukit/include/rtems/confdefs/wkspace.h index a08823fa17..39014d7f1d 100644 --- a/cpukit/include/rtems/confdefs/wkspace.h +++ b/cpukit/include/rtems/confdefs/wkspace.h @@ -3,9 +3,10 @@ /** * @file * - * @ingroup RTEMSApplicationConfiguration + * @ingroup RTEMSImplApplConfig * - * @brief Evaluate Workspace Configuration Options + * @brief This header file evaluates configuration options related to the RTEMS + * Workspace configuration. */ /* diff --git a/cpukit/include/rtems/confdefs/wkspacesupport.h b/cpukit/include/rtems/confdefs/wkspacesupport.h index 3dfb3b0d79..4036a7ae7f 100644 --- a/cpukit/include/rtems/confdefs/wkspacesupport.h +++ b/cpukit/include/rtems/confdefs/wkspacesupport.h @@ -3,9 +3,10 @@ /** * @file * - * @ingroup RTEMSApplicationConfiguration + * @ingroup RTEMSImplApplConfig * - * @brief Configuration Options Workspace Support Macros + * @brief This header file provides support macros to evaluate configuration + * options related to the RTEMS Workspace configuration. */ /* diff --git a/cpukit/include/rtems/extensiondata.h b/cpukit/include/rtems/extensiondata.h index 63614329af..8872e2c569 100644 --- a/cpukit/include/rtems/extensiondata.h +++ b/cpukit/include/rtems/extensiondata.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSImplClassicUserExt * - * @brief Classic User Extensions Data Structures + * @brief This header file provides data structures used by the implementation + * and the @ref RTEMSImplApplConfig to define ::_Extension_Information. */ /* diff --git a/cpukit/include/rtems/rtems/asrdata.h b/cpukit/include/rtems/rtems/asrdata.h index 2ff1ac87c0..caf29a0863 100644 --- a/cpukit/include/rtems/rtems/asrdata.h +++ b/cpukit/include/rtems/rtems/asrdata.h @@ -3,7 +3,9 @@ * * @ingroup RTEMSImplClassicASR * - * @brief Classic ASR Data Structures + * @brief This header file provides data structures used by the implementation + * and the @ref RTEMSImplApplConfig to ultimately define + * ::Thread_Configured_control. */ /* COPYRIGHT (c) 1989-2013. diff --git a/cpukit/include/rtems/rtems/barrierdata.h b/cpukit/include/rtems/rtems/barrierdata.h index 256afddf30..b449186a59 100644 --- a/cpukit/include/rtems/rtems/barrierdata.h +++ b/cpukit/include/rtems/rtems/barrierdata.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSImplClassicBarrier * - * @brief Classic Barrier Manager Data Structures + * @brief This header file provides data structures used by the implementation + * and the @ref RTEMSImplApplConfig to define ::_Barrier_Information. */ diff --git a/cpukit/include/rtems/rtems/dpmemdata.h b/cpukit/include/rtems/rtems/dpmemdata.h index ce4cf2dbf6..5303b8623a 100644 --- a/cpukit/include/rtems/rtems/dpmemdata.h +++ b/cpukit/include/rtems/rtems/dpmemdata.h @@ -3,7 +3,9 @@ * * @ingroup RTEMSImplClassicDPMem * - * @brief Classic Dual Ported Memory Manager Data Structures + * @brief This header file provides data structures used by the implementation + * and the @ref RTEMSImplApplConfig to define + * ::_Dual_ported_memory_Information. */ /* COPYRIGHT (c) 1989-2008. diff --git a/cpukit/include/rtems/rtems/eventdata.h b/cpukit/include/rtems/rtems/eventdata.h index 650c3d544a..7078cc2248 100644 --- a/cpukit/include/rtems/rtems/eventdata.h +++ b/cpukit/include/rtems/rtems/eventdata.h @@ -3,8 +3,9 @@ * * @ingroup RTEMSImplClassicEvent * - * @brief This header file provides the API used by the Application - * Configuration to define the configured Thread Control Block (TCB). + * @brief This header file provides data structures used by the implementation + * and the @ref RTEMSImplApplConfig to ultimately define + * ::Thread_Configured_control. */ /* COPYRIGHT (c) 1989-2008. diff --git a/cpukit/include/rtems/rtems/messagedata.h b/cpukit/include/rtems/rtems/messagedata.h index 83c3fcae87..ed74abf981 100644 --- a/cpukit/include/rtems/rtems/messagedata.h +++ b/cpukit/include/rtems/rtems/messagedata.h @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicMessageQueue + * @ingroup RTEMSImplClassicMessage * - * @brief Classic Message Queue Manager API + * @brief This header file provides data structures used by the implementation + * and the @ref RTEMSImplApplConfig to define ::_Message_queue_Information. */ /* COPYRIGHT (c) 1989-2013. diff --git a/cpukit/include/rtems/rtems/partdata.h b/cpukit/include/rtems/rtems/partdata.h index 59daf5f002..73babd36f4 100644 --- a/cpukit/include/rtems/rtems/partdata.h +++ b/cpukit/include/rtems/rtems/partdata.h @@ -3,8 +3,8 @@ * * @ingroup RTEMSImplClassicPartition * - * @brief This header file provides the API used by the Application - * Configuration to define the Partition Manager information. + * @brief This header file provides data structures used by the implementation + * and the @ref RTEMSImplApplConfig to define ::_Partition_Information. */ /* COPYRIGHT (c) 1989-2008. diff --git a/cpukit/include/rtems/rtems/ratemondata.h b/cpukit/include/rtems/rtems/ratemondata.h index 3fd59e8986..f35fa7eb61 100644 --- a/cpukit/include/rtems/rtems/ratemondata.h +++ b/cpukit/include/rtems/rtems/ratemondata.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSImplClassicRateMonotonic * - * @brief Classic Rate Monotonic Scheduler Data Structures + * @brief This header file provides data structures used by the implementation + * and the @ref RTEMSImplApplConfig to define ::_Rate_monotonic_Information. */ /* COPYRIGHT (c) 1989-2009, 2016. diff --git a/cpukit/include/rtems/rtems/regiondata.h b/cpukit/include/rtems/rtems/regiondata.h index 71cd833377..5852f4cb45 100644 --- a/cpukit/include/rtems/rtems/regiondata.h +++ b/cpukit/include/rtems/rtems/regiondata.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSImplClassicRegion * - * @brief Classic Region Manager Data Structures + * @brief This header file provides data structures used by the implementation + * and the @ref RTEMSImplApplConfig to define ::_Region_Information. */ /* COPYRIGHT (c) 1989-2013. diff --git a/cpukit/include/rtems/rtems/semdata.h b/cpukit/include/rtems/rtems/semdata.h index e780ff40d7..2612f1a902 100644 --- a/cpukit/include/rtems/rtems/semdata.h +++ b/cpukit/include/rtems/rtems/semdata.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSImplClassicSemaphore * - * @brief Classic Semaphore Manager Data Structures + * @brief This header file provides data structures used by the implementation + * and the @ref RTEMSImplApplConfig to define ::_Semaphore_Information. */ /* diff --git a/cpukit/include/rtems/rtems/tasksdata.h b/cpukit/include/rtems/rtems/tasksdata.h index ff9fceb1d9..fb15453e65 100644 --- a/cpukit/include/rtems/rtems/tasksdata.h +++ b/cpukit/include/rtems/rtems/tasksdata.h @@ -3,7 +3,10 @@ * * @ingroup RTEMSImplClassicTask * - * @brief Classic Tasks Manager Data Structures + * @brief This header file provides data structures used by the implementation + * and the @ref RTEMSImplApplConfig to define the + * ::_RTEMS_tasks_User_task_table, the ::_RTEMS_tasks_User_task_config, + * ::_RTEMS_tasks_Information, and ultimately ::Thread_Configured_control. */ /* diff --git a/cpukit/include/rtems/rtems/timerdata.h b/cpukit/include/rtems/rtems/timerdata.h index 6edbad2ba8..2a7cc03cb1 100644 --- a/cpukit/include/rtems/rtems/timerdata.h +++ b/cpukit/include/rtems/rtems/timerdata.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSImplClassicTimer * - * @brief Classic Partition Manager Data Structures + * @brief This header file provides data structures used by the implementation + * and the @ref RTEMSImplApplConfig to define ::_Timer_Information. */ /* diff --git a/cpukit/include/rtems/score/objectdata.h b/cpukit/include/rtems/score/objectdata.h index 56a1b8eb13..952c150e1f 100644 --- a/cpukit/include/rtems/score/objectdata.h +++ b/cpukit/include/rtems/score/objectdata.h @@ -3,7 +3,10 @@ * * @ingroup RTEMSScoreObject * - * @brief Object Handler Data Structures + * @brief This header file provides data structures used by the implementation + * and the @ref RTEMSImplApplConfig to define instances of + * ::Objects_Information, ::_Objects_MP_Controls, and ultimately + * ::Thread_Configured_control. */ /* diff --git a/cpukit/include/rtems/score/threadidledata.h b/cpukit/include/rtems/score/threadidledata.h index 79ac020576..4f2a785ccd 100644 --- a/cpukit/include/rtems/score/threadidledata.h +++ b/cpukit/include/rtems/score/threadidledata.h @@ -3,7 +3,9 @@ * * @ingroup RTEMSScoreThread * - * @brief Constants for the idle threads. + * @brief This header file provides data structures used by the implementation + * and the @ref RTEMSImplApplConfig to define ::_Thread_Idle_stack_size and + * ::_Thread_Idle_body. */ /* diff --git a/cpukit/include/rtems/score/userextdata.h b/cpukit/include/rtems/score/userextdata.h index 04dead889d..446c7e01dd 100644 --- a/cpukit/include/rtems/score/userextdata.h +++ b/cpukit/include/rtems/score/userextdata.h @@ -3,7 +3,10 @@ * * @ingroup RTEMSScoreUserExt * - * @brief User Extension Handler Data Structures + * @brief This header file provides data structures used by the implementation + * and the @ref RTEMSImplApplConfig to define + * ::_User_extensions_Initial_count, ::_User_extensions_Initial_extensions, + * and ::_User_extensions_Initial_switch_controls. */ /* diff --git a/cpukit/include/rtems/score/wkspacedata.h b/cpukit/include/rtems/score/wkspacedata.h index fd6fd1c1cb..3de4b02bd2 100644 --- a/cpukit/include/rtems/score/wkspacedata.h +++ b/cpukit/include/rtems/score/wkspacedata.h @@ -5,8 +5,9 @@ * * @ingroup RTEMSScoreWorkspace * - * @brief Constants defined by the application configuration for the idle - * threads. + * @brief This header file provides data structures used by the implementation + * and the @ref RTEMSImplApplConfig to define ::_Workspace_Size, + * ::_Workspace_Is_unified, and ::_Workspace_Malloc_initializer. */ /* |