[rtems commit] doxygen: Harmonize header file references

Sebastian Huber sebh at rtems.org
Tue Feb 14 14:00:27 UTC 2023


Module:    rtems
Branch:    master
Commit:    fa77ad14948d45114ad2ae8db79c99ac3b672b0e
Changeset: http://git.rtems.org/rtems/commit/?id=fa77ad14948d45114ad2ae8db79c99ac3b672b0e

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Tue Feb 14 15:06:07 2023 +0100

doxygen: Harmonize header file references

---

 cpukit/doxygen/appl-config.h       | 12 ++++++------
 cpukit/include/rtems/rtems/tasks.h |  6 +++---
 2 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/cpukit/doxygen/appl-config.h b/cpukit/doxygen/appl-config.h
index e13ebb8ba5..c4e8b7b61b 100644
--- a/cpukit/doxygen/appl-config.h
+++ b/cpukit/doxygen/appl-config.h
@@ -3533,9 +3533,9 @@
  * @anchor CONFIGURE_IDLE_TASK_STORAGE_SIZE
  *
  * If this configuration option is specified, then the task storage areas for
- * the IDLE tasks are statically allocated by <rtems/confdefs.h>.  The value of
- * this configuration option defines the size in bytes of the task storage area
- * of each IDLE task in the system.
+ * the IDLE tasks are statically allocated by ``<rtems/confdefs.h>``.  The
+ * value of this configuration option defines the size in bytes of the task
+ * storage area of each IDLE task in the system.
  *
  * @par Default Value
  * This configuration option has no default value.  If it is not specified,
@@ -3565,9 +3565,9 @@
  * system initialization.
  *
  * The value of this configuration option is passed to
- * RTEMS_TASK_STORAGE_SIZE() by <rtems/confdefs.h> to determine the actual size
- * of the statically allocated area to take architecture-specific overheads
- * into account.
+ * RTEMS_TASK_STORAGE_SIZE() by ``<rtems/confdefs.h>`` to determine the actual
+ * size of the statically allocated area to take architecture-specific
+ * overheads into account.
  *
  * The
  *
diff --git a/cpukit/include/rtems/rtems/tasks.h b/cpukit/include/rtems/rtems/tasks.h
index f28b464ec6..3214dad3f8 100644
--- a/cpukit/include/rtems/rtems/tasks.h
+++ b/cpukit/include/rtems/rtems/tasks.h
@@ -735,9 +735,9 @@ rtems_status_code rtems_task_create(
  * memory allocators.  This can simplify the application architecture as well
  * as any analysis that may be required.
  *
- * The stack space estimate done by <rtems/confdefs.h> assumes that all tasks
- * are created by rtems_task_create().  The estimate can be adjusted to take
- * user-provided task storage areas into account through the @ref
+ * The stack space estimate done by ``<rtems/confdefs.h>`` assumes that all
+ * tasks are created by rtems_task_create().  The estimate can be adjusted to
+ * take user-provided task storage areas into account through the @ref
  * CONFIGURE_MINIMUM_TASKS_WITH_USER_PROVIDED_STORAGE application configuration
  * option.
  *



More information about the vc mailing list