github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-09-22 04:34:03 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

Documentation: kernel-doc: enumerate identifier *type*s

Browse Source 
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
This commit is contained in:
Randy Dunlap 2024-11-19 12:32:01 -08:00 committed by Jonathan Corbet
parent 72471fc769
commit 9e6c5870bb
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Documentation/doc-guide/kernel-doc.rst
View File

@ -533,6 +533,7 @@ identifiers: *[ function/type ...]*
Include documentation for each *function* and *type* in *source*. Include documentation for each *function* and *type* in *source*.
If no *function* is specified, the documentation for all functions If no *function* is specified, the documentation for all functions
and types in the *source* will be included. and types in the *source* will be included.
*type* can be a struct, union, enum, or typedef identifier.
Examples:: Examples::