Commit 9e6c5870 authored by Randy Dunlap's avatar Randy Dunlap Committed by Jonathan Corbet
Browse files

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: default avatarRandy Dunlap <rdunlap@infradead.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241119203201.110953-1-rdunlap@infradead.org
parent 72471fc7

Documentation/doc-guide/kernel-doc.rst

+1 −0
Original line number Diff line number Diff line
@@ -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::