Messages in this thread Patch in this message | | | Date | Wed, 29 Oct 2008 22:34:48 -0700 | From | Randy Dunlap <> | Subject | [PATCH 2/7] docs: document how to write @varargs in kernel-doc |
| |
From: Randy Dunlap <randy.dunlap@oracle.com>
Add documentation on how to use kernel-doc for function parameters that are "..." (varargs).
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com> cc: Rusty Russell <rusty@rustcorp.com.au> --- Documentation/kernel-doc-nano-HOWTO.txt | 5 +++++ 1 file changed, 5 insertions(+)
--- lin2628-rc2.orig/Documentation/kernel-doc-nano-HOWTO.txt +++ lin2628-rc2/Documentation/kernel-doc-nano-HOWTO.txt @@ -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. /**
| |