diff options
author | Andreas Dachsberger <andreas.dachsberger@embedded-brains.de> | 2019-04-15 11:40:57 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2019-05-13 07:42:04 +0200 |
commit | 2adc5f10ff51dbd2a5a76764ef786d5f54228381 (patch) | |
tree | 8a0236dc473755776df7618945f00280446bf200 /cpukit/include/rtems/score/smplockseq.h | |
parent | doxygen: score: adjust doc in smplockmcs.h to doxygen guidelines (diff) | |
download | rtems-2adc5f10ff51dbd2a5a76764ef786d5f54228381.tar.bz2 |
doxygen: score: adjust doc in smplockseq.h to doxygen guidelines
Update #3706.
Diffstat (limited to 'cpukit/include/rtems/score/smplockseq.h')
-rw-r--r-- | cpukit/include/rtems/score/smplockseq.h | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/cpukit/include/rtems/score/smplockseq.h b/cpukit/include/rtems/score/smplockseq.h index f65595a10b..ab07a04351 100644 --- a/cpukit/include/rtems/score/smplockseq.h +++ b/cpukit/include/rtems/score/smplockseq.h @@ -66,7 +66,7 @@ typedef struct { * * Concurrent initialization leads to unpredictable results. * - * @param lock The SMP sequence lock control. + * @param[out] lock The SMP sequence lock control. */ static inline void _SMP_sequence_lock_Initialize( SMP_sequence_lock_Control *lock ) { @@ -92,7 +92,7 @@ static inline void _SMP_sequence_lock_Destroy( SMP_sequence_lock_Control *lock ) * current thread of execution is not interrupted indefinite since this would * starve readers. * - * @param lock The SMP sequence lock control. + * @param[out] lock The SMP sequence lock control. * * @return The current sequence number. */ @@ -116,7 +116,7 @@ static inline unsigned int _SMP_sequence_lock_Write_begin( /** * @brief Ends an SMP sequence lock write operation. * - * @param lock The SMP sequence lock control. + * @param[out] lock The SMP sequence lock control. * @param seq The sequence number returned by _SMP_sequence_lock_Write_begin(). */ static inline void _SMP_sequence_lock_Write_end( @@ -132,7 +132,7 @@ static inline void _SMP_sequence_lock_Write_end( * * This function will not disable interrupts. * - * @param lock The SMP sequence lock control. + * @param[out] lock The SMP sequence lock control. * * @return The current sequence number. */ @@ -147,12 +147,12 @@ static inline unsigned int _SMP_sequence_lock_Read_begin( * @brief Ends an SMP sequence lock read operation and indicates if a retry is * necessary. * - * @param lock The SMP sequence lock control. + * @param[in, out] lock The SMP sequence lock control. * @param seq The sequence number returned by _SMP_sequence_lock_Read_begin(). * * @retval true The read operation must be retried with a call to * _SMP_sequence_lock_Read_begin(). - * @retval false Otherwise. + * @retval false The read operation need not be retried. */ static inline bool _SMP_sequence_lock_Read_retry( SMP_sequence_lock_Control *lock, @@ -165,7 +165,7 @@ static inline bool _SMP_sequence_lock_Read_retry( return seq != seq2 || seq % 2 != 0; } -/**@}*/ +/** @} */ #ifdef __cplusplus } |