[PATCH 71/98] doxygen: score: adjust doc in smplockticket.h to doxygen guidelines
Sebastian Huber
sebastian.huber at embedded-brains.de
Tue May 7 05:40:16 UTC 2019
From: Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
---
cpukit/include/rtems/score/smplockticket.h | 23 ++++++++++++++++++-----
1 file changed, 18 insertions(+), 5 deletions(-)
diff --git a/cpukit/include/rtems/score/smplockticket.h b/cpukit/include/rtems/score/smplockticket.h
index e8d0fb7ef9..7d0cc368ee 100644
--- a/cpukit/include/rtems/score/smplockticket.h
+++ b/cpukit/include/rtems/score/smplockticket.h
@@ -52,11 +52,11 @@ typedef struct {
}
/**
- * @brief Initializes an SMP ticket lock.
+ * @brief Initializes the SMP ticket lock.
*
* Concurrent initialization leads to unpredictable results.
*
- * @param[in] lock The SMP ticket lock control.
+ * @param[in, out] lock The SMP ticket lock control.
*/
static inline void _SMP_ticket_lock_Initialize(
SMP_ticket_lock_Control *lock
@@ -67,17 +67,24 @@ static inline void _SMP_ticket_lock_Initialize(
}
/**
- * @brief Destroys an SMP ticket lock.
+ * @brief Destroys the SMP ticket lock.
*
* Concurrent destruction leads to unpredictable results.
*
- * @param[in] lock The SMP ticket lock control.
+ * @param lock The SMP ticket lock control.
*/
static inline void _SMP_ticket_lock_Destroy( SMP_ticket_lock_Control *lock )
{
(void) lock;
}
+/**
+ * @brief Acquires the SMP ticket lock.
+ *
+ * @param[in, out] lock The lock to acquire.
+ * @param stats The SMP lock statistics.
+ * @param[out] stats_context The context for the statistics.
+ */
static inline void _SMP_ticket_lock_Do_acquire(
SMP_ticket_lock_Control *lock
#if defined(RTEMS_PROFILING)
@@ -143,6 +150,12 @@ static inline void _SMP_ticket_lock_Do_acquire(
_SMP_ticket_lock_Do_acquire( lock )
#endif
+/**
+ * @brief Releases the SMP ticket lock.
+ *
+ * @param[in, out] lock The SMP ticket lock to release.
+ * @param[out] stats_context The SMP lock statistics context.
+ */
static inline void _SMP_ticket_lock_Do_release(
SMP_ticket_lock_Control *lock
#if defined(RTEMS_PROFILING)
@@ -176,7 +189,7 @@ static inline void _SMP_ticket_lock_Do_release(
_SMP_ticket_lock_Do_release( lock )
#endif
-/**@}*/
+/** @} */
#ifdef __cplusplus
}
--
2.16.4
More information about the devel
mailing list