riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

core/mutex: fix documentation

Browse Source
This commit is contained in:
Marian Buschsieweke 2020-12-08 23:04:16 +01:00
parent 1feacd1b88
commit 472d6d0abc
No known key found for this signature in database
GPG Key ID: 61F64C6599B1539F
1 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
core/include/mutex.h
View File

@ -298,7 +298,7 @@ void mutex_unlock_and_sleep(mutex_t *mutex);
* Canonical use:
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.c}
* static void timeout_cb(void *_arg) {
* static void timeout_cb(void *arg) {
* mutex_cancel(arg);
* }
*
@ -306,15 +306,13 @@ void mutex_unlock_and_sleep(mutex_t *mutex);
* uint32_t timeout)
* {
* mutex_cancel_t mc = mutex_cancel_init(mutex);
* ztimer_t t;
* t.callback = timeout_cb;
* t.arg = &mc;
* ztimer_t t = { .callback = timeout_cb, .arg = &mc };
* ztimer_set(clock, &t, timeout);
* if (0 == mutex_lock_cancelable(mutex)) {
* ztimer_remove(clock, &t);
* return 0;
* if (mutex_lock_cancelable(&mc)) {
* return -ECANCELED;
* }
* return -ECANCELED;
* ztimer_remove(clock, &t);
* return 0;
* }
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*