diff options
| author | Andreas Dachsberger <andreas.dachsberger@embedded-brains.de> | 2019-04-15 12:07:51 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2019-05-13 07:42:04 +0200 |
| commit | 366dbf6a852faaa6ba5d66fa6909a36ec372c0f4 (patch) | |
| tree | fe4f664a31f5f3f99ffb1140ef00747da6832f24 /cpukit | |
| parent | doxygen: score: adjust doc in smplockstats.h to doxygen guidelines (diff) | |
| download | rtems-366dbf6a852faaa6ba5d66fa6909a36ec372c0f4.tar.bz2 | |
doxygen: score: adjust doc in smplockticket.h to doxygen guidelines
Update #3706.
Diffstat (limited to 'cpukit')
| -rw-r--r-- | cpukit/include/rtems/score/smplockticket.h | 23 |
1 files 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 } |