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.
This commit is contained in:
Sebastian Huber
2020-11-30 14:00:08 +01:00
parent 3db9c820e5
commit 70dbafbf5e
39 changed files with 118 additions and 73 deletions

View File

@@ -3,14 +3,15 @@
/** /**
* @file * @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 * This header file includes a couple of header files which evaluate the
* configuration options specified by the application. The macros and defines * configuration options specified by the application. The macros and defines
* used to configure the system are documented in the Configuring a System * used to configure the system are documented in @ref RTEMSApplConfig and the
* chapter of the Classic API User's Guide. * "Configuring a System" chapter of the "RTEMS Classic API User's Guide".
*/ */
/* /*
@@ -43,14 +44,12 @@
#define __CONFIGURATION_TEMPLATE_h #define __CONFIGURATION_TEMPLATE_h
/** /**
* @defgroup RTEMSApplicationConfiguration Application Configuration * @defgroup RTEMSImplApplConfig Application Configuration
* *
* @ingroup RTEMSImpl * @ingroup RTEMSImpl
* *
* @brief Evaluation of Application Configuration Options * @brief The application configuration defines system parameters according to
* * configuration options (defines) provided by the application.
* This group contains header files which evaluate the configuration options
* specified by the application.
* *
* @{ * @{
*/ */

View File

@@ -3,9 +3,10 @@
/** /**
* @file * @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 * It defines
* *

View File

@@ -3,9 +3,10 @@
/** /**
* @file * @file
* *
* @ingroup RTEMSApplicationConfiguration * @ingroup RTEMSImplApplConfig
* *
* @brief Evaluate BSP Related Configuration Options * @brief This header file evaluates configuration options related to the BSP
* configuration.
*/ */
/* /*

View File

@@ -3,9 +3,10 @@
/** /**
* @file * @file
* *
* @ingroup RTEMSApplicationConfiguration * @ingroup RTEMSImplApplConfig
* *
* @brief Evaluate Clock Configuration Options * @brief This header file evaluates configuration options related to the clock
* driver configuration.
*/ */
/* /*

View File

@@ -3,9 +3,10 @@
/** /**
* @file * @file
* *
* @ingroup RTEMSApplicationConfiguration * @ingroup RTEMSImplApplConfig
* *
* @brief Evaluate Console Driver Configuration Options * @brief This header file evaluates configuration options related to the
* console driver configuration.
*/ */
/* /*

View File

@@ -3,9 +3,10 @@
/** /**
* @file * @file
* *
* @ingroup RTEMSApplicationConfiguration * @ingroup RTEMSImplApplConfig
* *
* @brief Evaluate User Extensions Configuration Options * @brief This header file evaluates configuration options related to the user
* extensions configuration.
*/ */
/* /*

View File

@@ -3,9 +3,10 @@
/** /**
* @file * @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 * This header file defines _CONFIGURE_INIT_TASK_STACK_EXTRA for use by other
* configuration header files. * configuration header files.

View File

@@ -3,9 +3,10 @@
/** /**
* @file * @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 * This header file defines _CONFIGURE_POSIX_INIT_THREAD_STACK_EXTRA for use by
* other configuration header files. * other configuration header files.

View File

@@ -3,9 +3,10 @@
/** /**
* @file * @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.
*/ */
/* /*

View File

@@ -3,9 +3,10 @@
/** /**
* @file * @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.
*/ */
/* /*

View File

@@ -9,9 +9,10 @@
/** /**
* @file * @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 #ifndef _RTEMS_CONFDEFS_LIBPCI_H

View File

@@ -3,9 +3,10 @@
/** /**
* @file * @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.
*/ */
/* /*

View File

@@ -3,9 +3,10 @@
/** /**
* @file * @file
* *
* @ingroup RTEMSApplicationConfiguration * @ingroup RTEMSImplApplConfig
* *
* @brief Evaluate MPCI Configuration Options * @brief This header file evaluates configuration options related to the MPCI
* configuration.
*/ */
/* /*

View File

@@ -3,9 +3,10 @@
/** /**
* @file * @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 * This header file defines _CONFIGURE_ENABLE_NEWLIB_REENTRANCY for use by other
* configuration header files. * configuration header files.

View File

@@ -3,9 +3,10 @@
/** /**
* @file * @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>. * For the task objects configuration see <rtems/confdefs/threads.h>.
*/ */

View File

@@ -3,9 +3,10 @@
/** /**
* @file * @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>. * For the POSIX thread objects configuration see <rtems/confdefs/threads.h>.
*/ */

View File

@@ -3,9 +3,10 @@
/** /**
* @file * @file
* *
* @ingroup RTEMSApplicationConfiguration * @ingroup RTEMSImplApplConfig
* *
* @brief Evaluate Obsolete Configuration Options * @brief This header file evaluates configuration options related to obsolete
* configuration options.
*/ */
/* /*

View File

@@ -3,9 +3,10 @@
/** /**
* @file * @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 * Since the idle thread stack size (CONFIGURE_IDLE_TASK_STACK_SIZE) depends on
* CONFIGURE_MINIMUM_TASK_STACK_SIZE, the POSIX-specific * CONFIGURE_MINIMUM_TASK_STACK_SIZE, the POSIX-specific

View File

@@ -3,9 +3,10 @@
/** /**
* @file * @file
* *
* @ingroup RTEMSApplicationConfiguration * @ingroup RTEMSImplApplConfig
* *
* @brief Evaluate Scheduler Configuration Options * @brief This header file evaluates configuration options related to the
* scheduler configuration.
*/ */
/* /*

View File

@@ -3,9 +3,10 @@
/** /**
* @file * @file
* *
* @ingroup RTEMSApplicationConfiguration * @ingroup RTEMSImplApplConfig
* *
* @brief Evaluate Thread Configuration Options * @brief This header file evaluates configuration options related to the
* thread configuration.
*/ */
/* /*

View File

@@ -3,9 +3,10 @@
/** /**
* @file * @file
* *
* @ingroup RTEMSApplicationConfiguration * @ingroup RTEMSImplApplConfig
* *
* @brief Evaluate Unlimited Objects Configuration Options * @brief This header file evaluates configuration options related to the
* unlimited objects configuration.
*/ */
/* /*

View File

@@ -3,9 +3,10 @@
/** /**
* @file * @file
* *
* @ingroup RTEMSApplicationConfiguration * @ingroup RTEMSImplApplConfig
* *
* @brief Evaluate Workspace Configuration Options * @brief This header file evaluates configuration options related to the RTEMS
* Workspace configuration.
*/ */
/* /*

View File

@@ -3,9 +3,10 @@
/** /**
* @file * @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.
*/ */
/* /*

View File

@@ -3,7 +3,8 @@
* *
* @ingroup RTEMSImplClassicUserExt * @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.
*/ */
/* /*

View File

@@ -3,7 +3,9 @@
* *
* @ingroup RTEMSImplClassicASR * @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. /* COPYRIGHT (c) 1989-2013.

View File

@@ -3,7 +3,8 @@
* *
* @ingroup RTEMSImplClassicBarrier * @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.
*/ */

View File

@@ -3,7 +3,9 @@
* *
* @ingroup RTEMSImplClassicDPMem * @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. /* COPYRIGHT (c) 1989-2008.

View File

@@ -3,8 +3,9 @@
* *
* @ingroup RTEMSImplClassicEvent * @ingroup RTEMSImplClassicEvent
* *
* @brief This header file provides the API used by the Application * @brief This header file provides data structures used by the implementation
* Configuration to define the configured Thread Control Block (TCB). * and the @ref RTEMSImplApplConfig to ultimately define
* ::Thread_Configured_control.
*/ */
/* COPYRIGHT (c) 1989-2008. /* COPYRIGHT (c) 1989-2008.

View File

@@ -1,9 +1,10 @@
/** /**
* @file * @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. /* COPYRIGHT (c) 1989-2013.

View File

@@ -3,8 +3,8 @@
* *
* @ingroup RTEMSImplClassicPartition * @ingroup RTEMSImplClassicPartition
* *
* @brief This header file provides the API used by the Application * @brief This header file provides data structures used by the implementation
* Configuration to define the Partition Manager information. * and the @ref RTEMSImplApplConfig to define ::_Partition_Information.
*/ */
/* COPYRIGHT (c) 1989-2008. /* COPYRIGHT (c) 1989-2008.

View File

@@ -3,7 +3,8 @@
* *
* @ingroup RTEMSImplClassicRateMonotonic * @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. /* COPYRIGHT (c) 1989-2009, 2016.

View File

@@ -3,7 +3,8 @@
* *
* @ingroup RTEMSImplClassicRegion * @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. /* COPYRIGHT (c) 1989-2013.

View File

@@ -3,7 +3,8 @@
* *
* @ingroup RTEMSImplClassicSemaphore * @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.
*/ */
/* /*

View File

@@ -3,7 +3,10 @@
* *
* @ingroup RTEMSImplClassicTask * @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.
*/ */
/* /*

View File

@@ -3,7 +3,8 @@
* *
* @ingroup RTEMSImplClassicTimer * @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.
*/ */
/* /*

View File

@@ -3,7 +3,10 @@
* *
* @ingroup RTEMSScoreObject * @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.
*/ */
/* /*

View File

@@ -3,7 +3,9 @@
* *
* @ingroup RTEMSScoreThread * @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.
*/ */
/* /*

View File

@@ -3,7 +3,10 @@
* *
* @ingroup RTEMSScoreUserExt * @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.
*/ */
/* /*

View File

@@ -5,8 +5,9 @@
* *
* @ingroup RTEMSScoreWorkspace * @ingroup RTEMSScoreWorkspace
* *
* @brief Constants defined by the application configuration for the idle * @brief This header file provides data structures used by the implementation
* threads. * and the @ref RTEMSImplApplConfig to define ::_Workspace_Size,
* ::_Workspace_Is_unified, and ::_Workspace_Malloc_initializer.
*/ */
/* /*