On Tue, 29 Apr 2025 at 12:58, Jerome Forissier
<jerome.foriss...@linaro.org> wrote:
>
> 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.foriss...@linaro.org>
> Reported-by: Tom Rini <tr...@konsulko.com>
> ---
>
> include/uthread.h | 9 +++++++--
> 1 file 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;
> --
> 2.43.0
>
> base-commit: b249e08ec9b71f9d0b4eb48e3e63f63e8366b7e6
> branch: uthread-doc-fix
Acked-by: Ilias Apalodimas <ilias.apalodi...@linaro.org>
