docs: document how to write @varargs in kernel-doc
[linux-2.6.git] / Documentation / kernel-doc-nano-HOWTO.txt
index c6841eee9598ddd82932db9e4e4a451f9f33ad9d..4115a4a80eb6cbfed92dc577f673a7b64f03c053 100644 (file)
@@ -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.
 
 /**