Commit d2b34e20 authored by Randy Dunlap's avatar Randy Dunlap Committed by Linus Torvalds

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: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 80884094
...@@ -214,11 +214,13 @@ The format of the block comment is like this: ...@@ -214,11 +214,13 @@ The format of the block comment is like this:
* (section header: (section description)? )* * (section header: (section description)? )*
(*)?*/ (*)?*/
The short function description ***cannot be multiline***, but the other All "description" text can span multiple lines, although the
descriptions can be (and they can contain blank lines). If you continue function_name & its short description are traditionally on a single line.
that initial short description onto a second line, that second line will Description text may also contain blank lines (i.e., lines that contain
appear further down at the beginning of the description section, which is only a "*").
almost certainly not what you had in mind.
"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 Avoid putting a spurious blank line after the function name, or else the
description will be repeated! description will be repeated!
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment