From: Randy Dunlap <randy.dunlap@oracle.com>
Date: Tue, 6 Jan 2009 22:42:40 +0000 (-0800)
Subject: docs: document how to write @varargs in kernel-doc
X-Git-Tag: v3.12-rc1~16557
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=d78dd070ccda6384efeae142b116bc174f0cd9fa;p=kernel%2Fkernel-generic.git

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>
---

diff --git a/Documentation/kernel-doc-nano-HOWTO.txt b/Documentation/kernel-doc-nano-HOWTO.txt
index c6841ee..4115a4a 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.
 
 /**