git://ftp.safe.ca
/
safe
/
jmp
/
linux-2.6
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Merge branch 'for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/tytso/ext4
[safe/jmp/linux-2.6]
/
Documentation
/
kernel-doc-nano-HOWTO.txt
diff --git
a/Documentation/kernel-doc-nano-HOWTO.txt
b/Documentation/kernel-doc-nano-HOWTO.txt
index
4d04572
..
348b9e5
100644
(file)
--- a/
Documentation/kernel-doc-nano-HOWTO.txt
+++ b/
Documentation/kernel-doc-nano-HOWTO.txt
@@
-66,7
+66,9
@@
Example kernel-doc function comment:
* The longer description can have multiple paragraphs.
*/
* The longer description can have multiple paragraphs.
*/
-The first line, with the short description, must be on a single line.
+The short description following the subject can span multiple lines
+and ends with an @argument description, an empty line or the end of
+the comment block.
The @argument descriptions must begin on the very next line following
this opening short function description line, with no intervening
The @argument descriptions must begin on the very next line following
this opening short function description line, with no intervening