summaryrefslogtreecommitdiffstats
path: root/cpukit/include/sys
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2023-07-25 10:38:51 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2023-07-26 07:18:29 +0200
commitec1e500f4f149632404d1dddbb5d29de91bfb035 (patch)
tree934946f64e710d7adf1d660c93e6596295da7e5a /cpukit/include/sys
parentposix: Add files to Doxygen group (diff)
downloadrtems-ec1e500f4f149632404d1dddbb5d29de91bfb035.tar.bz2
timecounter: Add files to Doxygen group
Update #3707.
Diffstat (limited to 'cpukit/include/sys')
-rw-r--r--cpukit/include/sys/_ffcounter.h9
-rw-r--r--cpukit/include/sys/timeffc.h9
-rw-r--r--cpukit/include/sys/timepps.h9
-rw-r--r--cpukit/include/sys/timetc.h9
-rw-r--r--cpukit/include/sys/timex.h9
5 files changed, 45 insertions, 0 deletions
diff --git a/cpukit/include/sys/_ffcounter.h b/cpukit/include/sys/_ffcounter.h
index d83c48cd44..802c7d3224 100644
--- a/cpukit/include/sys/_ffcounter.h
+++ b/cpukit/include/sys/_ffcounter.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSScoreTimecounter
+ *
+ * @brief This header file provides interfaces of the feed-forward clock
+ * counter.
+ */
+
/*-
* Copyright (c) 2011 The University of Melbourne
* All rights reserved.
diff --git a/cpukit/include/sys/timeffc.h b/cpukit/include/sys/timeffc.h
index c04de97f1d..13abd37a2b 100644
--- a/cpukit/include/sys/timeffc.h
+++ b/cpukit/include/sys/timeffc.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSScoreTimecounter
+ *
+ * @brief This header file provides interfaces of the feed-back and
+ * feed-forward clock implementations.
+ */
+
/*-
* Copyright (c) 2011 The University of Melbourne
* All rights reserved.
diff --git a/cpukit/include/sys/timepps.h b/cpukit/include/sys/timepps.h
index 030c734477..502d93833e 100644
--- a/cpukit/include/sys/timepps.h
+++ b/cpukit/include/sys/timepps.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSScoreTimecounter
+ *
+ * @brief This header file provides interfaces of the Pulse Per Second (PPS)
+ * support.
+ */
+
/*-
* ----------------------------------------------------------------------------
* "THE BEER-WARE LICENSE" (Revision 42):
diff --git a/cpukit/include/sys/timetc.h b/cpukit/include/sys/timetc.h
index 1ef58b378d..8f2537692c 100644
--- a/cpukit/include/sys/timetc.h
+++ b/cpukit/include/sys/timetc.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSScoreTimecounter
+ *
+ * @brief This header file provides interfaces of the timecounter
+ * implementation.
+ */
+
/*-
* ----------------------------------------------------------------------------
* "THE BEER-WARE LICENSE" (Revision 42):
diff --git a/cpukit/include/sys/timex.h b/cpukit/include/sys/timex.h
index 8e763bb30f..36b1fcdb5a 100644
--- a/cpukit/include/sys/timex.h
+++ b/cpukit/include/sys/timex.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSScoreTimecounter
+ *
+ * @brief This header file provides interfaces of the Network Time Protocol
+ * (NTP) support.
+ */
+
/*-
***********************************************************************
* *