aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRandy Dunlap <randy.dunlap@oracle.com>2009-01-06 17:42:40 -0500
committerLinus Torvalds <torvalds@linux-foundation.org>2009-01-06 18:59:28 -0500
commitd78dd070ccda6384efeae142b116bc174f0cd9fa (patch)
tree2d1afdbc80291b690db6108f964db34255b7b22e
parentbd4207c9016749f0a212faf7f7f49e5317d96d9b (diff)
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>
-rw-r--r--Documentation/kernel-doc-nano-HOWTO.txt5
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
71this opening short function description line, with no intervening 71this opening short function description line, with no intervening
72empty comment lines. 72empty comment lines.
73 73
74If a function parameter is "..." (varargs), it should be listed in
75kernel-doc notation as:
76 * @...: description
77
78
74Example kernel-doc data structure comment. 79Example kernel-doc data structure comment.
75 80
76/** 81/**