Documentation/doc-guide/kernel-doc.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
The '@' sign applies to struct members, union members, and enum
values as well as function parameters. Document that.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <skhan@linuxfoundation.org>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: linux-doc@vger.kernel.org
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.)
``%CONST``
Name of a constant. (No cross-referencing, just formatting.)
Randy Dunlap <rdunlap@infradead.org> 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@infradead.org> > --- > Cc: Jonathan Corbet <corbet@lwn.net> > Cc: Shuah Khan <skhan@linuxfoundation.org> > Cc: Mauro Carvalho Chehab <mchehab@kernel.org> > Cc: linux-doc@vger.kernel.org > > 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
© 2016 - 2026 Red Hat, Inc.