tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

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

authored by

Randy Dunlap and committed by
Jonathan Corbet 9e6c5870 72471fc7

+1
+1
Documentation/doc-guide/kernel-doc.rst
··· 533 533 Include documentation for each *function* and *type* in *source*. 534 534 If no *function* is specified, the documentation for all functions 535 535 and types in the *source* will be included. 536 + *type* can be a struct, union, enum, or typedef identifier. 536 537 537 538 Examples:: 538 539