From: Randy Dunlap Date: Tue, 19 Nov 2024 20:32:01 +0000 (-0800) Subject: Documentation: kernel-doc: enumerate identifier *type*s X-Git-Tag: v6.13-rc1~72^2~4 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=9e6c5870bb44950d7a636db1af1948d71244e616;p=thirdparty%2Fkernel%2Flinux.git 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 Cc: Jonathan Corbet Signed-off-by: Jonathan Corbet Link: https://lore.kernel.org/r/20241119203201.110953-1-rdunlap@infradead.org --- diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst index e6ffd59bb8f0f..af9697e60165d 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::