c-user: Generate clock manager documentation

The documentation is a consolidation of the comments in Doxygen markup
and the documentation sources in Sphinx markup.  The documentation was
transfered to interface specification items.  The documentation source
files were generated from the items by a script.

Update #3993.

1 files changed, 68 insertions, 16 deletions

diff --git a/c-user/clock/introduction.rst b/c-user/clock/introduction.rst
index e952d7d..ad4b14c 100644
--- a/c-user/clock/introduction.rst
+++ b/c-user/clock/introduction.rst
@@ -1,36 +1,88 @@
 .. SPDX-License-Identifier: CC-BY-SA-4.0
 
+.. Copyright (C) 2014, 2021 embedded brains GmbH (http://www.embedded-brains.de)
 .. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 
+.. This file is part of the RTEMS quality process and was automatically
+.. generated.  If you find something that needs to be fixed or
+.. worded better please post a report or patch to an RTEMS mailing list
+.. or raise a bug report:
+..
+.. https://www.rtems.org/bugs.html
+..
+.. For information on updating and regenerating please refer to the How-To
+.. section in the Software Requirements Engineering chapter of the
+.. RTEMS Software Engineering manual.  The manual is provided as a part of
+.. a release.  For development sources please refer to the online
+.. documentation at:
+..
+.. https://docs.rtems.org
+
+.. Generated from spec:/rtems/clock/if/group
+
+.. _ClockManagerIntroduction:
+
 Introduction
 ============
 
-The clock manager provides support for time of day
-and other time related capabilities.  The directives provided by
-the clock manager are:
+.. The following list was generated from:
+.. spec:/rtems/clock/if/set
+.. spec:/rtems/clock/if/get-tod
+.. spec:/rtems/clock/if/get-tod-timeval
+.. spec:/rtems/clock/if/get-seconds-since-epoch
+.. spec:/rtems/clock/if/get-ticks-per-second
+.. spec:/rtems/clock/if/get-ticks-since-boot
+.. spec:/rtems/clock/if/get-uptime
+.. spec:/rtems/clock/if/get-uptime-timeval
+.. spec:/rtems/clock/if/get-uptime-seconds
+.. spec:/rtems/clock/if/get-uptime-nanoseconds
+.. spec:/rtems/clock/if/tick-later
+.. spec:/rtems/clock/if/tick-later-usec
+.. spec:/rtems/clock/if/tick-before
+
+The Clock Manager provides support for time of day and other time related
+capabilities. The directives provided by the Clock Manager are:
 
-- :ref:`rtems_clock_set`
+* :ref:`InterfaceRtemsClockSet` - Sets the :term:`CLOCK_REALTIME` to the time
+  of day.
 
-- :ref:`rtems_clock_get_tod`
+* :ref:`InterfaceRtemsClockGetTod` - Gets the time of day associated with the
+  current :term:`CLOCK_REALTIME`.
 
-- :ref:`rtems_clock_get_tod_timeval`
+* :ref:`InterfaceRtemsClockGetTodTimeval` - Gets the seconds and microseconds
+  elapsed since the :term:`Unix epoch` and the current :term:`CLOCK_REALTIME`.
 
-- :ref:`rtems_clock_get_seconds_since_epoch`
+* :ref:`InterfaceRtemsClockGetSecondsSinceEpoch` - Gets the seconds elapsed
+  since the :term:`RTEMS epoch` and the current :term:`CLOCK_REALTIME`.
 
-- :ref:`rtems_clock_get_ticks_per_second`
+* :ref:`InterfaceRtemsClockGetTicksPerSecond` - Gets the number of :term:`clock
+  ticks <clock tick>` per second configured for the application.
 
-- :ref:`rtems_clock_get_ticks_since_boot`
+* :ref:`InterfaceRtemsClockGetTicksSinceBoot` - Gets the number of :term:`clock
+  ticks <clock tick>` since some time point during the system initialization or
+  the last overflow of the clock tick counter.
 
-- :ref:`rtems_clock_tick_later`
+* :ref:`InterfaceRtemsClockGetUptime` - Gets the seconds and nanoseconds
+  elapsed since some time point during the system initialization using
+  :term:`CLOCK_MONOTONIC`.
 
-- :ref:`rtems_clock_tick_later_usec`
+* :ref:`InterfaceRtemsClockGetUptimeTimeval` - Gets the seconds and
+  microseconds elapsed since some time point during the system initialization
+  using :term:`CLOCK_MONOTONIC`.
 
-- :ref:`rtems_clock_tick_before`
+* :ref:`InterfaceRtemsClockGetUptimeSeconds` - Gets the seconds elapsed since
+  some time point during the system initialization using
+  :term:`CLOCK_MONOTONIC`.
 
-- :ref:`rtems_clock_get_uptime`
+* :ref:`InterfaceRtemsClockGetUptimeNanoseconds` - Gets the nanoseconds elapsed
+  since some time point during the system initialization using
+  :term:`CLOCK_MONOTONIC`.
 
-- :ref:`rtems_clock_get_uptime_timeval`
+* :ref:`InterfaceRtemsClockTickLater` - Gets a :term:`clock tick` value which
+  is at least delta clock ticks in the future.
 
-- :ref:`rtems_clock_get_uptime_seconds`
+* :ref:`InterfaceRtemsClockTickLaterUsec` - Gets a :term:`clock tick` value
+  which is at least delta microseconds in the future.
 
-- :ref:`rtems_clock_get_uptime_nanoseconds`
+* :ref:`InterfaceRtemsClockTickBefore` - Indicates if the current :term:`clock
+  tick` counter is before the ticks.