diff options
| author | Ingo Molnar <mingo@elte.hu> | 2009-09-20 20:24:58 +0200 |
|---|---|---|
| committer | Ingo Molnar <mingo@elte.hu> | 2009-09-20 20:25:03 +0200 |
| commit | bfefb7a0c6e08736f2d5917c468467f134bf28bb (patch) | |
| tree | 7aa7084114dc083fe5b4d7b532901bdeb67188e7 /Documentation/kernel-doc-nano-HOWTO.txt | |
| parent | 8d0cc631f6dd0a9283ceb7d61d8b85ecbcd355ea (diff) | |
| parent | 78f28b7c555359c67c2a0d23f7436e915329421e (diff) | |
Merge branch 'linus' into x86/urgent
Merge reason: Bring in changes that the next patch will depend on.
Signed-off-by: Ingo Molnar <mingo@elte.hu>
Diffstat (limited to 'Documentation/kernel-doc-nano-HOWTO.txt')
| -rw-r--r-- | Documentation/kernel-doc-nano-HOWTO.txt | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/kernel-doc-nano-HOWTO.txt b/Documentation/kernel-doc-nano-HOWTO.txt index 4d04572b654..348b9e5e28f 100644 --- 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 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 |