diff options
author | Randy Dunlap <randy.dunlap@oracle.com> | 2010-01-08 23:43:09 +0100 |
---|---|---|
committer | Linus Torvalds <torvalds@linux-foundation.org> | 2010-01-11 18:34:07 +0100 |
commit | d2b34e20c1f431604e0dde910c3ff271c84ed706 (patch) | |
tree | c190675e494345da4ddf82e222092a3ca95c7050 /Documentation/kernel-doc-nano-HOWTO.txt | |
parent | gpio: adp5588-gpio: new driver for ADP5588 GPIO expanders (diff) | |
download | linux-d2b34e20c1f431604e0dde910c3ff271c84ed706.tar.xz linux-d2b34e20c1f431604e0dde910c3ff271c84ed706.zip |
documentation: update kernel-doc-nano-HOWTO information
Remove comments about function short descriptions not allowed to be on
multiple lines (that was fixed/changed recently).
Add comments that function "section header:" names need to be unique per
function/struct/union/typedef/enum.
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'Documentation/kernel-doc-nano-HOWTO.txt')
-rw-r--r-- | Documentation/kernel-doc-nano-HOWTO.txt | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/Documentation/kernel-doc-nano-HOWTO.txt b/Documentation/kernel-doc-nano-HOWTO.txt index 348b9e5e28fc..27a52b35d55b 100644 --- a/Documentation/kernel-doc-nano-HOWTO.txt +++ b/Documentation/kernel-doc-nano-HOWTO.txt @@ -214,11 +214,13 @@ The format of the block comment is like this: * (section header: (section description)? )* (*)?*/ -The short function description ***cannot be multiline***, but the other -descriptions can be (and they can contain blank lines). If you continue -that initial short description onto a second line, that second line will -appear further down at the beginning of the description section, which is -almost certainly not what you had in mind. +All "description" text can span multiple lines, although the +function_name & its short description are traditionally on a single line. +Description text may also contain blank lines (i.e., lines that contain +only a "*"). + +"section header:" names must be unique per function (or struct, +union, typedef, enum). Avoid putting a spurious blank line after the function name, or else the description will be repeated! |