docs: document how to write @varargs in kernel-doc
PATCH 2/7 docs: document how to write @varargs in kernel-doc
From: Randy Dunlap <[email protected]>
Add documentation on how to use kernel-doc for function parameters that are "..." (varargs).
Signed-off-by Randy Dunlap <[email protected]>
cc Rusty Russell <[email protected]>
--- Documentation/kernel-doc-nano-HOWTO.txt | 5 +++++ 1 file changed, 5 insertions(+)
Documentation/kernel-doc-nano-HOWTO.txt +5 -0
@@ -71,6 +71,11 @@ The @argument descriptions must begin on this opening short function description line, with no intervening empty comment lines. +If a function parameter is "..." (varargs), it should be listed in +kernel-doc notation as: + * @...: description + + Example kernel-doc data structure comment. /**