summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/timecounter.h
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-11-28 11:16:28 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-12-02 07:45:53 +0100
commit3db9c820e55aad1e784bf926e551a7de8dae0cdf (patch)
treefd01d124fb7622ad955d141bd1ff9ce35d8a1e71 /cpukit/include/rtems/timecounter.h
parentscore: Canonicalize Doxygen @file comments (diff)
downloadrtems-3db9c820e55aad1e784bf926e551a7de8dae0cdf.tar.bz2
sapi: 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/timecounter.h')
-rw-r--r--cpukit/include/rtems/timecounter.h9
1 files changed, 6 insertions, 3 deletions
diff --git a/cpukit/include/rtems/timecounter.h b/cpukit/include/rtems/timecounter.h
index 8ff18c2da3..d5025d8b1a 100644
--- a/cpukit/include/rtems/timecounter.h
+++ b/cpukit/include/rtems/timecounter.h
@@ -1,9 +1,9 @@
/**
* @file
*
- * @ingroup SAPITimecounter
+ * @ingroup RTEMSAPIClassicTimecounter
*
- * @brief Timecounter API
+ * @brief This header file provides the Timecounter Support API.
*/
/*
@@ -31,10 +31,13 @@ extern "C" {
#endif /* __cplusplus */
/**
- * @defgroup SAPITimecounter Timecounter Support
+ * @defgroup RTEMSAPIClassicTimecounter Timecounter Support
*
* @ingroup RTEMSAPIClassic
*
+ * @brief The timecounter support provides directives to implement clock device
+ * drivers.
+ *
* @{
*/