Linux Documentation
 help / color / mirror / Atom feed
* [PATCH] docs: kernel-doc: inform that '@' applies to other fields
@ 2026-09-11 18:42 Randy Dunlap
  0 siblings, 0 replies; only message in thread
From: Randy Dunlap @ 2026-09-11 18:42 UTC (permalink / raw)
  To: linux-kernel
  Cc: Randy Dunlap, Jonathan Corbet, Shuah Khan, Mauro Carvalho Chehab,
	linux-doc

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

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2026-09-11 18:42 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-09-11 18:42 [PATCH] docs: kernel-doc: inform that '@' applies to other fields Randy Dunlap

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox