[PATCH 83/98] doxygen: score: adjust doc in timecounter.h to doxygen guidelines

Sebastian Huber sebastian.huber at embedded-brains.de
Tue May 7 05:40:28 UTC 2019


From: Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>

---
 cpukit/include/rtems/score/timecounter.h | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

diff --git a/cpukit/include/rtems/score/timecounter.h b/cpukit/include/rtems/score/timecounter.h
index a719ab0fa8..78f5dfa53b 100644
--- a/cpukit/include/rtems/score/timecounter.h
+++ b/cpukit/include/rtems/score/timecounter.h
@@ -38,6 +38,8 @@ extern "C" {
  *
  * @ingroup RTEMSScore
  *
+ * @brief Timecounter Handler.
+ *
  * @{
  */
 
@@ -175,7 +177,7 @@ void _Timecounter_Getboottimebin( struct bintime *bt );
  * tc_get_timecount, tc_counter_mask, tc_frequency and tc_quality.  All other
  * fields must be zero initialized.
  *
- * @param[in] tc The timecounter.
+ * @param tc The timecounter.
  */
 void _Timecounter_Install( struct timecounter *tc );
 
@@ -192,7 +194,7 @@ ISR_LOCK_DECLARE( extern, _Timecounter_Lock )
 /**
  * @brief Acquires the timecounter lock.
  *
- * @param[in] lock_context The lock context.
+ * @param lock_context The lock context.
  *
  * See _Timecounter_Tick_simple().
  */
@@ -205,10 +207,10 @@ ISR_LOCK_DECLARE( extern, _Timecounter_Lock )
  * This is a special purpose tick function for simple timecounter to support
  * legacy clock drivers.
  *
- * @param[in] delta The time in timecounter ticks elapsed since the last call
+ * @param delta The time in timecounter ticks elapsed since the last call
  * to _Timecounter_Tick_simple().
- * @param[in] offset The current value of the timecounter.
- * @param[in] lock_context The lock context of the corresponding
+ * @param offset The current value of the timecounter.
+ * @param] lock_context The lock context of the corresponding
  * _Timecounter_Acquire().
  */
 void _Timecounter_Tick_simple(
-- 
2.16.4



More information about the devel mailing list