Changeset 6136e28b in rtems for bsps/shared/dev/clock/clockimpl.h

Timestamp:

01/23/23 14:26:10 (8 months ago)

Author:

Sebastian Huber <sebastian.huber@…>

Branches:

master

Children:

0340fd9

Parents:

10ee41a8

git-author:

Sebastian Huber <sebastian.huber@…> (01/23/23 14:26:10)

git-committer:

Sebastian Huber <sebastian.huber@…> (01/24/23 08:56:53)

Message:

clockdrv: Add clock driver implementation group

Use standard wording in Clock Driver related files.

Update #3706.

File:

• bsps/shared/dev/clock/clockimpl.h (modified) (2 diffs)

bsps/shared/dev/clock/clockimpl.h

@@ -4 +4 @@
  * @file
  *
- * @ingroup bsp_clock
- *
- * @brief Clock Tick Device Driver Shell
+ * @ingroup RTEMSDriverClockImpl
+ *
+ * @brief This header file contains the shared Clock Driver implementation.
+ *
+ * This header file shall only be included by a particular Clock Driver
+ * implementation source file.
  */
 
@@ -45 +48 @@
 #include <rtems/score/watchdogimpl.h>
 
+/**
+ * @defgroup RTEMSDriverClockImpl Clock Driver Implementation
+ *
+ * @ingroup RTEMSDriverClock
+ *
+ * @brief This group contains the Clock Driver implementation.
+ */
+
 #ifdef Clock_driver_nanoseconds_since_last_tick
 #error "Update driver to use the timecounter instead of nanoseconds extension"
 #endif
 
-/**
- * @defgroup bsp_clock Clock Support
- *
- * @ingroup RTEMSBSPsShared
- *
- * @brief Clock support 
- *
- */
 #if CLOCK_DRIVER_USE_FAST_IDLE && CLOCK_DRIVER_ISRS_PER_TICK
 #error "Fast Idle PLUS n ISRs per tick is not supported"