浏览代码

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 年之前
父节点
当前提交
d78dd070cc
共有 1 个文件被更改,包括 5 次插入0 次删除
  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
 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.
 
 /**