Commit d78dd070 authored by Randy Dunlap's avatar Randy Dunlap Committed by Linus Torvalds

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: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Cc: Rusty Russell <rusty@rustcorp.com.au>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent bd4207c9
...@@ -71,6 +71,11 @@ The @argument descriptions must begin on the very next line following ...@@ -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.
/** /**
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment