Techwizz/kernel-fxtec-pro1x
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

documentation: update kernel-doc-nano-HOWTO information

Browse source 
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>
This commit is contained in:
Randy Dunlap 2010-01-08 14:43:09 -08:00 committed by Linus Torvalds
parent 80884094e3
commit d2b34e20c1
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
Documentation/kernel-doc-nano-HOWTO.txt
View file

@ -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!