diff options
| author | Randy Dunlap <rdunlap@infradead.org> | 2026-09-11 11:42:13 -0700 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2026-09-15 13:02:10 -0600 |
| commit | 5fccf2b932d6bfbf5340d9087b533f6821d6d9bc (patch) | |
| tree | 142784014209309aceeefcccd950108d198fc208 | |
| parent | 213a1765719d462808cdf923f14f4982a1c68975 (diff) | |
| download | linux-next-5fccf2b932d6bfbf5340d9087b533f6821d6d9bc.tar.gz linux-next-5fccf2b932d6bfbf5340d9087b533f6821d6d9bc.zip | |
docs: kernel-doc: inform that '@' applies to other fields
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>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20260911184213.4143776-1-rdunlap@infradead.org>
| -rw-r--r-- | Documentation/doc-guide/kernel-doc.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst index 8f4042be2310..48f62e59c455 100644 --- a/Documentation/doc-guide/kernel-doc.rst +++ b/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.) |