diff options
| author | Randy Dunlap <rdunlap@infradead.org> | 2024-11-19 21:32:01 +0100 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2024-11-22 18:37:40 +0100 |
| commit | 9e6c5870bb44950d7a636db1af1948d71244e616 (patch) | |
| tree | 5a4584e14057122279e98b55b38c5810654596d2 /Documentation/doc-guide/kernel-doc.rst | |
| parent | Documentation: pwrseq: Fix trivial misspellings (diff) | |
| download | linux-9e6c5870bb44950d7a636db1af1948d71244e616.tar.xz linux-9e6c5870bb44950d7a636db1af1948d71244e616.zip | |
Documentation: kernel-doc: enumerate identifier *type*s
Explain that a kernel-doc :identifiers: line can refer to a struct,
union, enum, or typedef as well as functions.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241119203201.110953-1-rdunlap@infradead.org
Diffstat (limited to '')
| -rw-r--r-- | Documentation/doc-guide/kernel-doc.rst | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst index e6ffd59bb8f0..af9697e60165 100644 --- a/Documentation/doc-guide/kernel-doc.rst +++ b/Documentation/doc-guide/kernel-doc.rst @@ -533,6 +533,7 @@ identifiers: *[ function/type ...]* Include documentation for each *function* and *type* in *source*. If no *function* is specified, the documentation for all functions and types in the *source* will be included. + *type* can be a struct, union, enum, or typedef identifier. Examples:: |