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/include/rtems/confdefs.h | |
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/include/rtems/confdefs.h')
-rw-r--r-- | cpukit/include/rtems/confdefs.h | 17 |
1 files changed, 8 insertions, 9 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. * * @{ */ |