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

Download as
Browse Code ยป

Commit f40b45a2e45b0f02aeedfcfbb28d8e2d4b8b86b1

Authored by Randy Dunlap
Committed by Linus Torvalds
1 parent 2e9c237243
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

kernel-doc: preferred ending marker and examples 

Fix kernel-doc-nano-HOWTO.txt to use */ as the ending marker in kernel-doc
examples and state that */ is the preferred ending marker.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Reported-by: Robert Love <robert.w.love@intel.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

Showing 1 changed file with 4 additions and 3 deletions Side-by-side Diff

Documentation/kernel-doc-nano-HOWTO.txt
Diff comments   View file @ f40b45a
... ... @@ -43,7 +43,8 @@
43 43 and any comment so marked must be in kernel-doc format. Do not use
44 44 "/**" to be begin a comment block unless the comment block contains
45 45 kernel-doc formatted comments. The closing comment marker for
46   -kernel-doc comments can be either "*/" or "**/".
  46 +kernel-doc comments can be either "*/" or "**/", but "*/" is
  47 +preferred in the Linux kernel tree.
47 48  
48 49 Kernel-doc comments should be placed just before the function
49 50 or data structure being described.
... ... @@ -63,7 +64,7 @@
63 64 * comment lines.
64 65 *
65 66 * The longer description can have multiple paragraphs.
66   - **/
  67 + */
67 68  
68 69 The first line, with the short description, must be on a single line.
69 70  
... ... @@ -85,7 +86,7 @@
85 86 * perhaps with more lines and words.
86 87 *
87 88 * Longer description of this structure.
88   - **/
  89 + */
89 90  
90 91 The kernel-doc function comments describe each parameter to the
91 92 function, in order, with the @name lines.