From: Jerome Forissier <jerome.forissier@linaro.org>
Date: Tue, 29 Apr 2025 09:57:34 +0000 (+0200)
Subject: uthread: doc: fix inline documentation
X-Git-Tag: v2025.07-rc2~46^2~6
X-Git-Url: http://git.openpandora.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a4af308e4acdcf0840226fc4f631e3aa0326699a;p=pandora-u-boot.git

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>
---

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;