Forráskód Böngészése

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>
Randy Dunlap 16 éve
szülő
commit
d78dd070cc
1 módosított fájl, 5 hozzáadás és 0 törlés
  1. 5 0
      Documentation/kernel-doc-nano-HOWTO.txt

+ 5 - 0
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
 this opening short function description line, with no intervening
 empty comment lines.
 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.
 Example kernel-doc data structure comment.
 
 
 /**
 /**