Eric Lee / linux-smarc-t335x-v3.2

Download as
Browse Code ยป

Commit d78dd070ccda6384efeae142b116bc174f0cd9fa

Authored by Randy Dunlap
Committed by Linus Torvalds
1 parent bd4207c901
Exists in master and in 4 other branches v3.2_AM335xPSP_04.06.00.11, v3.2_NEWT335xPSP_04.06.00.11, v3.2_SBC_SMARTMEN, v3.2_SMARCT335xPSP_04.06.00.11

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>

Showing 1 changed file with 5 additions and 0 deletions Side-by-side Diff

Documentation/kernel-doc-nano-HOWTO.txt
Diff comments   View file @ d78dd07
... ... @@ -71,6 +71,11 @@
71 71 this opening short function description line, with no intervening
72 72 empty comment lines.
73 73  
  74 +If a function parameter is "..." (varargs), it should be listed in
  75 +kernel-doc notation as:
  76 + * @...: description
  77 +
  78 +
74 79 Example kernel-doc data structure comment.
75 80  
76 81 /**