michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: sys: atomic: improve bitset accessor doc

Browse source 
Removes an ambivalence in return value description.

Signed-off-by: Florian Grandel <fgrandel@code-for-humans.de>
This commit is contained in:
Florian Grandel 2023-09-04 09:35:57 +02:00 • committed by Carles Cufí
commit c9c6676bdd
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
include/zephyr/sys/atomic.h
View file

@ -147,7 +147,7 @@ static inline bool atomic_test_bit(const atomic_t *target, int bit)
* @param target Address of atomic variable or array.
* @param bit Bit number (starting from 0).
*
* @return true if the bit was set, false if it wasn't.
* @return false if the bit was already cleared, true if it wasn't.
*/
static inline bool atomic_test_and_clear_bit(atomic_t *target, int bit)
{
@ -171,7 +171,7 @@ static inline bool atomic_test_and_clear_bit(atomic_t *target, int bit)
* @param target Address of atomic variable or array.
* @param bit Bit number (starting from 0).
*
* @return true if the bit was set, false if it wasn't.
* @return true if the bit was already set, false if it wasn't.
*/
static inline bool atomic_test_and_set_bit(atomic_t *target, int bit)
{