* [PATCH 2/7] docs: document how to write @varargs in kernel-doc
@ 2008-10-30 5:34 Randy Dunlap
0 siblings, 0 replies; only message in thread
From: Randy Dunlap @ 2008-10-30 5:34 UTC (permalink / raw)
To: lkml; +Cc: akpm, Rusty Russell
From: Randy Dunlap <randy.dunlap@oracle.com>
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>
---
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.
/**
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2008-10-30 5:36 UTC | newest]
Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2008-10-30 5:34 [PATCH 2/7] docs: document how to write @varargs in kernel-doc Randy Dunlap
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox