[PATCH 2/7] docs: document how to write @varargs in kernel-doc

From: Randy Dunlap
Date: Thu Oct 30 2008 - 01:36:23 EST


From: Randy Dunlap <randy.dunlap@xxxxxxxxxx>

Add documentation on how to use kernel-doc for function parameters
that are "..." (varargs).

Signed-off-by: Randy Dunlap <randy.dunlap@xxxxxxxxxx>
cc: Rusty Russell <rusty@xxxxxxxxxxxxxxx>
---
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.

/**
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/