Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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>
authored by
Randy Dunlap
and committed by
Linus Torvalds
f40b45a2
2e9c2372
+4
-3
+4
-3
Documentation/kernel-doc-nano-HOWTO.txt
+4
-3
Documentation/kernel-doc-nano-HOWTO.txt
···
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.
···
64
63
* comment lines.
65
64
*
66
65
* The longer description can have multiple paragraphs.
67
-
**/
66
+
*/
68
67
69
68
The first line, with the short description, must be on a single line.
70
69
···
86
85
* perhaps with more lines and words.
87
86
*
88
87
* Longer description of this structure.
89
-
**/
88
+
*/
90
89
91
90
The kernel-doc function comments describe each parameter to the
92
91
function, in order, with the @name lines.