summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/rtems/clock.h
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2023-02-06 11:09:27 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2023-02-14 07:42:14 +0100
commit1f8b26a809d514c710469ae6c50fc483f41da9f1 (patch)
tree05be2ec1b06d879a2f2b4a1c65ca338c14d3b479 /cpukit/include/rtems/rtems/clock.h
parentdoxygen: Generalize appl config constraints (diff)
downloadrtems-1f8b26a809d514c710469ae6c50fc483f41da9f1.tar.bz2
doxygen: Use @anchor for appl config options
The application configuration options are documented in "cpukit/doxygen/appl-config.h". Since the application configuration option defines are also present in multiple test program sources, the "#OPTION" references cannot be mapped to a unique definition. Add an anchor for each option and reference it to avoid the issues with the multiple definitions. Update #3994.
Diffstat (limited to '')
-rw-r--r--cpukit/include/rtems/rtems/clock.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/cpukit/include/rtems/rtems/clock.h b/cpukit/include/rtems/rtems/clock.h
index 2f541d46a2..3dff28e3d9 100644
--- a/cpukit/include/rtems/rtems/clock.h
+++ b/cpukit/include/rtems/rtems/clock.h
@@ -116,8 +116,8 @@ struct bintime;
* before 2100-01-01:00:00.000000000Z. The latest valid time of day accepted
* by the POSIX clock_settime() is 2400-01-01T00:00:00.999999999Z.
*
- * The specified time is based on the configured clock tick rate, see the
- * #CONFIGURE_MICROSECONDS_PER_TICK application configuration option.
+ * The specified time is based on the configured clock tick rate, see the @ref
+ * CONFIGURE_MICROSECONDS_PER_TICK application configuration option.
*
* Setting the time forward will fire all CLOCK_REALTIME timers which are
* scheduled at a time point before or at the time set by the directive. This
@@ -853,8 +853,8 @@ rtems_status_code rtems_clock_get_seconds_since_epoch(
* application.
*
* @par Notes
- * The number of clock ticks per second is defined indirectly by the
- * #CONFIGURE_MICROSECONDS_PER_TICK configuration option.
+ * The number of clock ticks per second is defined indirectly by the @ref
+ * CONFIGURE_MICROSECONDS_PER_TICK configuration option.
*
* @par Constraints
* @parblock