colin/u-boot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

uthread: doc: fix inline documentation

Browse Source 
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>
This commit is contained in:
Jerome Forissier
2025-04-29 11:57:34 +02:00
committed by Heinrich Schuchardt
parent aa96cda0a5
commit a4af308e4a
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
include/uthread.h
View File

@@ -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 { enum uthread_mutex_state {
UTHREAD_MUTEX_UNLOCKED = 0, 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 { struct uthread_mutex {
enum uthread_mutex_state state; enum uthread_mutex_state state;