diff options
| author | Jerome Forissier <jerome.forissier@linaro.org> | 2025-04-29 11:57:34 +0200 |
|---|---|---|
| committer | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2025-05-01 09:19:07 +0200 |
| commit | a4af308e4acdcf0840226fc4f631e3aa0326699a (patch) | |
| tree | 456cac257826ed56f8391e08e907e1502087f401 | |
| parent | aa96cda0a58f4d181b81a897b0b9fea3d9729478 (diff) | |
uthread: doc: fix inline documentation
Fix Sphinx warnings:
$ make htmldocs
[...]
./include/uthread.h:56: warning: cannot understand function prototype: 'enum uthread_mutex_state '
./include/uthread.h:64: warning: cannot understand function prototype: 'struct uthread_mutex '
./include/uthread.h:56: warning: cannot understand function prototype: 'enum uthread_mutex_state '
./include/uthread.h:64: warning: cannot understand function prototype: 'struct uthread_mutex '
Signed-off-by: Jerome Forissier <jerome.forissier@linaro.org>
Reported-by: Tom Rini <trini@konsulko.com>
Tested-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Acked-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
| -rw-r--r-- | include/uthread.h | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/include/uthread.h b/include/uthread.h index 89fa552a6f6..11a19aa9488 100644 --- a/include/uthread.h +++ b/include/uthread.h @@ -51,7 +51,10 @@ struct uthread { }; /** - * Internal state of a struct uthread_mutex + * enum uthread_mutex_state - internal state of a struct uthread_mutex + * + * @UTHREAD_MUTEX_UNLOCKED: mutex has no owner + * @UTHREAD_MUTEX_LOCKED: mutex has one owner */ enum uthread_mutex_state { UTHREAD_MUTEX_UNLOCKED = 0, @@ -59,7 +62,9 @@ enum uthread_mutex_state { }; /** - * Uthread mutex + * struct uthread_mutex - a mutex object + * + * @state: the internal state of the mutex */ struct uthread_mutex { enum uthread_mutex_state state; |