Skip to content

Commit 9e6c587

Browse files
rddunlapJonathan Corbet
authored andcommitted
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 <[email protected]> Cc: Jonathan Corbet <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
1 parent 72471fc commit 9e6c587

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

Documentation/doc-guide/kernel-doc.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -533,6 +533,7 @@ identifiers: *[ function/type ...]*
533533
Include documentation for each *function* and *type* in *source*.
534534
If no *function* is specified, the documentation for all functions
535535
and types in the *source* will be included.
536+
*type* can be a struct, union, enum, or typedef identifier.
536537

537538
Examples::
538539

0 commit comments

Comments
 (0)