Re: [PATCH] docs: kernel-doc: inform that '@' applies to other fields

[Jonathan Corbet]

Randy Dunlap <rdunlap@xxxxxxxxxxxxx> writes:

> The '@' sign applies to struct members, union members, and enum
> values as well as function parameters. Document that.
>
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> ---
> Cc: Jonathan Corbet <corbet@xxxxxxx>
> Cc: Shuah Khan <skhan@xxxxxxxxxxxxxxxxxxx>
> Cc: Mauro Carvalho Chehab <mchehab@xxxxxxxxxx>
> Cc: linux-doc@xxxxxxxxxxxxxxx
>
>  Documentation/doc-guide/kernel-doc.rst |    3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> --- linux-next-20260911.orig/Documentation/doc-guide/kernel-doc.rst
> +++ linux-next-20260911/Documentation/doc-guide/kernel-doc.rst
> @@ -422,7 +422,8 @@ Domain`_ references.
>    Function reference.
>  
>  ``@parameter``
> -  Name of a function parameter. (No cross-referencing, just formatting.)
> +  Name of a function parameter, struct member, union member, or
> +  enum value. (No cross-referencing, just formatting.)

Applied, thanks.

jon