Changeset 70dbafb in rtems


Ignore:
Timestamp:
11/30/20 13:00:08 (3 years ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
master
Children:
226b90b4
Parents:
3db9c820
git-author:
Sebastian Huber <sebastian.huber@…> (11/30/20 13:00:08)
git-committer:
Sebastian Huber <sebastian.huber@…> (12/02/20 06:45:53)
Message:

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.

Location:
cpukit/include/rtems
Files:
39 edited

Legend:

Unmodified
Added
Removed
  • cpukit/include/rtems/confdefs.h

    r3db9c820 r70dbafb  
    44 * @file
    55 *
    6  * @ingroup RTEMSApplicationConfiguration
     6 * @ingroup RTEMSApplConfig
    77 *
    8  * @brief Evaluate Configuration Options
     8 * @brief This header file evaluates the application configuration options
     9 *   defined by the application.
    910 *
    1011 * This header file includes a couple of header files which evaluate the
    1112 * configuration options specified by the application.  The macros and defines
    12  * used to configure the system are documented in the Configuring a System
    13  * chapter of the Classic API User's Guide.
     13 * used to configure the system are documented in @ref RTEMSApplConfig and the
     14 * "Configuring a System" chapter of the "RTEMS Classic API User's Guide".
    1415 */
    1516
     
    4445
    4546/**
    46  * @defgroup RTEMSApplicationConfiguration Application Configuration
     47 * @defgroup RTEMSImplApplConfig Application Configuration
    4748 *
    4849 * @ingroup RTEMSImpl
    4950 *
    50  * @brief Evaluation of Application Configuration Options
    51  *
    52  * This group contains header files which evaluate the configuration options
    53  * specified by the application.
     51 * @brief The application configuration defines system parameters according to
     52 *   configuration options (defines) provided by the application.
    5453 *
    5554 * @{
  • cpukit/include/rtems/confdefs/bdbuf.h

    r3db9c820 r70dbafb  
    44 * @file
    55 *
    6  * @ingroup RTEMSApplicationConfiguration
     6 * @ingroup RTEMSImplApplConfig
    77 *
    8  * @brief Evaluate Block Device Cache Configuration Options
     8 * @brief This header file evaluates configuration options related to the block
     9 *   device cache configuration.
    910 *
    1011 * It defines
  • cpukit/include/rtems/confdefs/bsp.h

    r3db9c820 r70dbafb  
    44 * @file
    55 *
    6  * @ingroup RTEMSApplicationConfiguration
     6 * @ingroup RTEMSImplApplConfig
    77 *
    8  * @brief Evaluate BSP Related Configuration Options
     8 * @brief This header file evaluates configuration options related to the BSP
     9 *   configuration.
    910 */
    1011
  • cpukit/include/rtems/confdefs/clock.h

    r3db9c820 r70dbafb  
    44 * @file
    55 *
    6  * @ingroup RTEMSApplicationConfiguration
     6 * @ingroup RTEMSImplApplConfig
    77 *
    8  * @brief Evaluate Clock Configuration Options
     8 * @brief This header file evaluates configuration options related to the clock
     9 *   driver configuration.
    910 */
    1011
  • cpukit/include/rtems/confdefs/console.h

    r3db9c820 r70dbafb  
    44 * @file
    55 *
    6  * @ingroup RTEMSApplicationConfiguration
     6 * @ingroup RTEMSImplApplConfig
    77 *
    8  * @brief Evaluate Console Driver Configuration Options
     8 * @brief This header file evaluates configuration options related to the
     9 *   console driver configuration.
    910 */
    1011
  • cpukit/include/rtems/confdefs/extensions.h

    r3db9c820 r70dbafb  
    44 * @file
    55 *
    6  * @ingroup RTEMSApplicationConfiguration
     6 * @ingroup RTEMSImplApplConfig
    77 *
    8  * @brief Evaluate User Extensions Configuration Options
     8 * @brief This header file evaluates configuration options related to the user
     9 *   extensions configuration.
    910 */
    1011
  • cpukit/include/rtems/confdefs/inittask.h

    r3db9c820 r70dbafb  
    44 * @file
    55 *
    6  * @ingroup RTEMSApplicationConfiguration
     6 * @ingroup RTEMSImplApplConfig
    77 *
    8  * @brief Evaluate User Initialization Task Configuration Options
     8 * @brief This header file evaluates configuration options related to the
     9 *   Classic API initialization task configuration.
    910 *
    1011 * This header file defines _CONFIGURE_INIT_TASK_STACK_EXTRA for use by other
  • cpukit/include/rtems/confdefs/initthread.h

    r3db9c820 r70dbafb  
    44 * @file
    55 *
    6  * @ingroup RTEMSApplicationConfiguration
     6 * @ingroup RTEMSImplApplConfig
    77 *
    8  * @brief Evaluate POSIX Initialization Thread Configuration Options
     8 * @brief This header file evaluates configuration options related to the POSIX
     9 *   initialization thread configuration.
    910 *
    1011 * This header file defines _CONFIGURE_POSIX_INIT_THREAD_STACK_EXTRA for use by
  • cpukit/include/rtems/confdefs/iodrivers.h

    r3db9c820 r70dbafb  
    44 * @file
    55 *
    6  * @ingroup RTEMSApplicationConfiguration
     6 * @ingroup RTEMSImplApplConfig
    77 *
    8  * @brief Evaluate IO Driver Configuration Options
     8 * @brief This header file evaluates configuration options related to the I/O
     9 *   driver configuration.
    910 */
    1011
  • cpukit/include/rtems/confdefs/libio.h

    r3db9c820 r70dbafb  
    44 * @file
    55 *
    6  * @ingroup RTEMSApplicationConfiguration
     6 * @ingroup RTEMSImplApplConfig
    77 *
    8  * @brief Evaluate IO Library Configuration Options
     8 * @brief This header file evaluates configuration options related to the I/O
     9 *   library configuration.
    910 */
    1011
  • cpukit/include/rtems/confdefs/libpci.h

    r3db9c820 r70dbafb  
    1010 * @file
    1111 *
    12  * @ingroup RTEMSApplicationConfiguration
     12 * @ingroup RTEMSImplApplConfig
    1313 *
    14  * @brief This header file evaluates PCI library configuration options.
     14 * @brief This header file evaluates configuration options related to the PCI
     15 *   library configuration.
    1516 */
    1617
  • cpukit/include/rtems/confdefs/malloc.h

    r3db9c820 r70dbafb  
    44 * @file
    55 *
    6  * @ingroup RTEMSApplicationConfiguration
     6 * @ingroup RTEMSImplApplConfig
    77 *
    8  * @brief Evaluate C Program Heap Configuration Options
     8 * @brief This header file evaluates configuration options related to the C
     9 *   Program Heap configuration.
    910 */
    1011
  • cpukit/include/rtems/confdefs/mpci.h

    r3db9c820 r70dbafb  
    44 * @file
    55 *
    6  * @ingroup RTEMSApplicationConfiguration
     6 * @ingroup RTEMSImplApplConfig
    77 *
    8  * @brief Evaluate MPCI Configuration Options
     8 * @brief This header file evaluates configuration options related to the MPCI
     9 *   configuration.
    910 */
    1011
  • cpukit/include/rtems/confdefs/newlib.h

    r3db9c820 r70dbafb  
    44 * @file
    55 *
    6  * @ingroup RTEMSApplicationConfiguration
     6 * @ingroup RTEMSImplApplConfig
    77 *
    8  * @brief Evaluate Newlib Configuration Options
     8 * @brief This header file evaluates configuration options related to the
     9 *   Newlib C Library configuration.
    910 *
    1011 * This header file defines _CONFIGURE_ENABLE_NEWLIB_REENTRANCY for use by other
  • cpukit/include/rtems/confdefs/objectsclassic.h

    r3db9c820 r70dbafb  
    44 * @file
    55 *
    6  * @ingroup RTEMSApplicationConfiguration
     6 * @ingroup RTEMSImplApplConfig
    77 *
    8  * @brief Evaluate Classic API Objects Configuration Options
     8 * @brief This header file evaluates configuration options related to the
     9 *   Classic API objects configuration.
    910 *
    1011 * For the task objects configuration see <rtems/confdefs/threads.h>.
  • cpukit/include/rtems/confdefs/objectsposix.h

    r3db9c820 r70dbafb  
    44 * @file
    55 *
    6  * @ingroup RTEMSApplicationConfiguration
     6 * @ingroup RTEMSImplApplConfig
    77 *
    8  * @brief Evaluate POSIX API Objects Configuration Options
     8 * @brief This header file evaluates configuration options related to the POSIX
     9 *   API objects configuration.
    910 *
    1011 * For the POSIX thread objects configuration see <rtems/confdefs/threads.h>.
  • cpukit/include/rtems/confdefs/obsolete.h

    r3db9c820 r70dbafb  
    44 * @file
    55 *
    6  * @ingroup RTEMSApplicationConfiguration
    7  *
    8  * @brief Evaluate Obsolete Configuration Options
     6 * @ingroup RTEMSImplApplConfig
     7 *
     8 * @brief This header file evaluates configuration options related to obsolete
     9 *   configuration options.
    910 */
    1011
  • cpukit/include/rtems/confdefs/percpu.h

    r3db9c820 r70dbafb  
    44 * @file
    55 *
    6  * @ingroup RTEMSApplicationConfiguration
     6 * @ingroup RTEMSImplApplConfig
    77 *
    8  * @brief Evaluate Per-CPU Configuration Options
     8 * @brief This header file evaluates configuration options related to the
     9 *   per-CPU configuration.
    910 *
    1011 * Since the idle thread stack size (CONFIGURE_IDLE_TASK_STACK_SIZE) depends on
  • cpukit/include/rtems/confdefs/scheduler.h

    r3db9c820 r70dbafb  
    44 * @file
    55 *
    6  * @ingroup RTEMSApplicationConfiguration
     6 * @ingroup RTEMSImplApplConfig
    77 *
    8  * @brief Evaluate Scheduler Configuration Options
     8 * @brief This header file evaluates configuration options related to the
     9 *   scheduler configuration.
    910 */
    1011
  • cpukit/include/rtems/confdefs/threads.h

    r3db9c820 r70dbafb  
    44 * @file
    55 *
    6  * @ingroup RTEMSApplicationConfiguration
    7  *
    8  * @brief Evaluate Thread Configuration Options
     6 * @ingroup RTEMSImplApplConfig
     7 *
     8 * @brief This header file evaluates configuration options related to the
     9 *   thread configuration.
    910 */
    1011
  • cpukit/include/rtems/confdefs/unlimited.h

    r3db9c820 r70dbafb  
    44 * @file
    55 *
    6  * @ingroup RTEMSApplicationConfiguration
     6 * @ingroup RTEMSImplApplConfig
    77 *
    8  * @brief Evaluate Unlimited Objects Configuration Options
     8 * @brief This header file evaluates configuration options related to the
     9 *   unlimited objects configuration.
    910 */
    1011
  • cpukit/include/rtems/confdefs/wkspace.h

    r3db9c820 r70dbafb  
    44 * @file
    55 *
    6  * @ingroup RTEMSApplicationConfiguration
    7  *
    8  * @brief Evaluate Workspace Configuration Options
     6 * @ingroup RTEMSImplApplConfig
     7 *
     8 * @brief This header file evaluates configuration options related to the RTEMS
     9 *   Workspace configuration.
    910 */
    1011
  • cpukit/include/rtems/confdefs/wkspacesupport.h

    r3db9c820 r70dbafb  
    44 * @file
    55 *
    6  * @ingroup RTEMSApplicationConfiguration
     6 * @ingroup RTEMSImplApplConfig
    77 *
    8  * @brief Configuration Options Workspace Support Macros
     8 * @brief This header file provides support macros to evaluate configuration
     9 *   options related to the RTEMS Workspace configuration.
    910 */
    1011
  • cpukit/include/rtems/extensiondata.h

    r3db9c820 r70dbafb  
    44 * @ingroup RTEMSImplClassicUserExt
    55 *
    6  * @brief Classic User Extensions Data Structures
     6 * @brief This header file provides data structures used by the implementation
     7 *   and the @ref RTEMSImplApplConfig to define ::_Extension_Information.
    78 */
    89
  • cpukit/include/rtems/rtems/asrdata.h

    r3db9c820 r70dbafb  
    44 * @ingroup RTEMSImplClassicASR
    55 *
    6  * @brief Classic ASR Data Structures
     6 * @brief This header file provides data structures used by the implementation
     7 *   and the @ref RTEMSImplApplConfig to ultimately define
     8 *   ::Thread_Configured_control.
    79 */
    810
  • cpukit/include/rtems/rtems/barrierdata.h

    r3db9c820 r70dbafb  
    44 * @ingroup RTEMSImplClassicBarrier
    55 *
    6  * @brief Classic Barrier Manager Data Structures
     6 * @brief This header file provides data structures used by the implementation
     7 *   and the @ref RTEMSImplApplConfig to define ::_Barrier_Information.
    78 */
    89
  • cpukit/include/rtems/rtems/dpmemdata.h

    r3db9c820 r70dbafb  
    44 * @ingroup RTEMSImplClassicDPMem
    55 *
    6  * @brief Classic Dual Ported Memory Manager Data Structures
     6 * @brief This header file provides data structures used by the implementation
     7 *   and the @ref RTEMSImplApplConfig to define
     8 *   ::_Dual_ported_memory_Information.
    79 */
    810
  • cpukit/include/rtems/rtems/eventdata.h

    r3db9c820 r70dbafb  
    44 * @ingroup RTEMSImplClassicEvent
    55 *
    6  * @brief This header file provides the API used by the Application
    7  *   Configuration to define the configured Thread Control Block (TCB).
     6 * @brief This header file provides data structures used by the implementation
     7 *   and the @ref RTEMSImplApplConfig to ultimately define
     8 *   ::Thread_Configured_control.
    89 */
    910
  • cpukit/include/rtems/rtems/messagedata.h

    r3db9c820 r70dbafb  
    22 * @file
    33 *
    4  * @ingroup ClassicMessageQueue
     4 * @ingroup RTEMSImplClassicMessage
    55 *
    6  * @brief Classic Message Queue Manager API
     6 * @brief This header file provides data structures used by the implementation
     7 *   and the @ref RTEMSImplApplConfig to define ::_Message_queue_Information.
    78 */
    89
  • cpukit/include/rtems/rtems/partdata.h

    r3db9c820 r70dbafb  
    44 * @ingroup RTEMSImplClassicPartition
    55 *
    6  * @brief This header file provides the API used by the Application
    7  *   Configuration to define the Partition Manager information.
     6 * @brief This header file provides data structures used by the implementation
     7 *   and the @ref RTEMSImplApplConfig to define ::_Partition_Information.
    88 */
    99
  • cpukit/include/rtems/rtems/ratemondata.h

    r3db9c820 r70dbafb  
    44 * @ingroup RTEMSImplClassicRateMonotonic
    55 *
    6  * @brief Classic Rate Monotonic Scheduler Data Structures
     6 * @brief This header file provides data structures used by the implementation
     7 *   and the @ref RTEMSImplApplConfig to define ::_Rate_monotonic_Information.
    78 */
    89
  • cpukit/include/rtems/rtems/regiondata.h

    r3db9c820 r70dbafb  
    44 * @ingroup RTEMSImplClassicRegion
    55 *
    6  * @brief Classic Region Manager Data Structures
     6 * @brief This header file provides data structures used by the implementation
     7 *   and the @ref RTEMSImplApplConfig to define ::_Region_Information.
    78 */
    89
  • cpukit/include/rtems/rtems/semdata.h

    r3db9c820 r70dbafb  
    44 * @ingroup RTEMSImplClassicSemaphore
    55 *
    6  * @brief Classic Semaphore Manager Data Structures
     6 * @brief This header file provides data structures used by the implementation
     7 *   and the @ref RTEMSImplApplConfig to define ::_Semaphore_Information.
    78 */
    89
  • cpukit/include/rtems/rtems/tasksdata.h

    r3db9c820 r70dbafb  
    44 * @ingroup RTEMSImplClassicTask
    55 *
    6  * @brief Classic Tasks Manager Data Structures
     6 * @brief This header file provides data structures used by the implementation
     7 *   and the @ref RTEMSImplApplConfig to define the
     8 *   ::_RTEMS_tasks_User_task_table, the ::_RTEMS_tasks_User_task_config,
     9 *   ::_RTEMS_tasks_Information, and ultimately ::Thread_Configured_control.
    710 */
    811
  • cpukit/include/rtems/rtems/timerdata.h

    r3db9c820 r70dbafb  
    44 * @ingroup RTEMSImplClassicTimer
    55 *
    6  * @brief Classic Partition Manager Data Structures
     6 * @brief This header file provides data structures used by the implementation
     7 *   and the @ref RTEMSImplApplConfig to define ::_Timer_Information.
    78 */
    89
  • cpukit/include/rtems/score/objectdata.h

    r3db9c820 r70dbafb  
    44 * @ingroup RTEMSScoreObject
    55 *
    6  * @brief Object Handler Data Structures
     6 * @brief This header file provides data structures used by the implementation
     7 *   and the @ref RTEMSImplApplConfig to define instances of
     8 *   ::Objects_Information, ::_Objects_MP_Controls, and ultimately
     9 *   ::Thread_Configured_control.
    710 */
    811
  • cpukit/include/rtems/score/threadidledata.h

    r3db9c820 r70dbafb  
    44 * @ingroup RTEMSScoreThread
    55 *
    6  * @brief Constants for the idle threads.
     6 * @brief This header file provides data structures used by the implementation
     7 *   and the @ref RTEMSImplApplConfig to define ::_Thread_Idle_stack_size and
     8 *   ::_Thread_Idle_body.
    79 */
    810
  • cpukit/include/rtems/score/userextdata.h

    r3db9c820 r70dbafb  
    44 * @ingroup RTEMSScoreUserExt
    55 *
    6  * @brief User Extension Handler Data Structures
     6 * @brief This header file provides data structures used by the implementation
     7 *   and the @ref RTEMSImplApplConfig to define
     8 *   ::_User_extensions_Initial_count, ::_User_extensions_Initial_extensions,
     9 *   and ::_User_extensions_Initial_switch_controls.
    710 */
    811
  • cpukit/include/rtems/score/wkspacedata.h

    r3db9c820 r70dbafb  
    66 * @ingroup RTEMSScoreWorkspace
    77 *
    8  * @brief Constants defined by the application configuration for the idle
    9  * threads.
     8 * @brief This header file provides data structures used by the implementation
     9 *   and the @ref RTEMSImplApplConfig to define ::_Workspace_Size,
     10 *   ::_Workspace_Is_unified, and ::_Workspace_Malloc_initializer.
    1011 */
    1112
Note: See TracChangeset for help on using the changeset viewer.