summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/confdefs
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-11-30 14:00:08 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-12-02 07:45:53 +0100
commit70dbafbf5ed26d0d434d6428d9f3de1be2ee502a (patch)
tree872ccc19606d492beddbdc2875a2ef79d8d8bcf0 /cpukit/include/rtems/confdefs
parentsapi: Canonicalize @defgroup and @file comments (diff)
downloadrtems-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')
-rw-r--r--cpukit/include/rtems/confdefs/bdbuf.h5
-rw-r--r--cpukit/include/rtems/confdefs/bsp.h5
-rw-r--r--cpukit/include/rtems/confdefs/clock.h5
-rw-r--r--cpukit/include/rtems/confdefs/console.h5
-rw-r--r--cpukit/include/rtems/confdefs/extensions.h5
-rw-r--r--cpukit/include/rtems/confdefs/inittask.h5
-rw-r--r--cpukit/include/rtems/confdefs/initthread.h5
-rw-r--r--cpukit/include/rtems/confdefs/iodrivers.h5
-rw-r--r--cpukit/include/rtems/confdefs/libio.h5
-rw-r--r--cpukit/include/rtems/confdefs/libpci.h5
-rw-r--r--cpukit/include/rtems/confdefs/malloc.h5
-rw-r--r--cpukit/include/rtems/confdefs/mpci.h5
-rw-r--r--cpukit/include/rtems/confdefs/newlib.h5
-rw-r--r--cpukit/include/rtems/confdefs/objectsclassic.h5
-rw-r--r--cpukit/include/rtems/confdefs/objectsposix.h5
-rw-r--r--cpukit/include/rtems/confdefs/obsolete.h5
-rw-r--r--cpukit/include/rtems/confdefs/percpu.h5
-rw-r--r--cpukit/include/rtems/confdefs/scheduler.h5
-rw-r--r--cpukit/include/rtems/confdefs/threads.h5
-rw-r--r--cpukit/include/rtems/confdefs/unlimited.h5
-rw-r--r--cpukit/include/rtems/confdefs/wkspace.h5
-rw-r--r--cpukit/include/rtems/confdefs/wkspacesupport.h5
22 files changed, 66 insertions, 44 deletions
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.
*/
/*