diff options
| author | Randy Dunlap <randy.dunlap@oracle.com> | 2009-01-06 23:42:40 +0100 |
|---|---|---|
| committer | Linus Torvalds <torvalds@linux-foundation.org> | 2009-01-07 00:59:28 +0100 |
| commit | d78dd070ccda6384efeae142b116bc174f0cd9fa (patch) | |
| tree | 2d1afdbc80291b690db6108f964db34255b7b22e /Documentation/kernel-doc-nano-HOWTO.txt | |
| parent | kmod: fix varargs kernel-doc (diff) | |
| download | linux-d78dd070ccda6384efeae142b116bc174f0cd9fa.tar.xz linux-d78dd070ccda6384efeae142b116bc174f0cd9fa.zip | |
docs: document how to write @varargs in kernel-doc
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>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'Documentation/kernel-doc-nano-HOWTO.txt')
| -rw-r--r-- | Documentation/kernel-doc-nano-HOWTO.txt | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/kernel-doc-nano-HOWTO.txt b/Documentation/kernel-doc-nano-HOWTO.txt index c6841eee9598..4115a4a80eb6 100644 --- a/Documentation/kernel-doc-nano-HOWTO.txt +++ b/Documentation/kernel-doc-nano-HOWTO.txt @@ -71,6 +71,11 @@ The @argument descriptions must begin on the very next line following 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. /** |