leandrof/linux
1
0
Fork 0
forked from Minki/linux
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[PATCH] Discuss a couple common errors in kernel-doc usage.

Browse Source 
Explain a couple of the most common errors in kernel-doc usage.

Signed-off-by: Robert P. J. Day <rpjday@mindspring.com>
Acked-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:
Robert P. J. Day 2007-02-10 01:45:58 -08:00 committed by Linus Torvalds
parent 78137e3b34
commit 262086cf5b
1 changed files with 33 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
Documentation/kernel-doc-nano-HOWTO.txt
View File

@ -107,10 +107,14 @@ 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 The short function description ***cannot be multiline***, but the other
descriptions can be (and they can contain blank lines). Avoid putting a descriptions can be (and they can contain blank lines). If you continue
spurious blank line after the function name, or else the description will that initial short description onto a second line, that second line will
be repeated! appear further down at the beginning of the description section, which is
almost certainly not what you had in mind.
Avoid putting a spurious blank line after the function name, or else the
description will be repeated!
All descriptive text is further processed, scanning for the following special All descriptive text is further processed, scanning for the following special
patterns, which are highlighted appropriately. patterns, which are highlighted appropriately.
@ -121,6 +125,31 @@ patterns, which are highlighted appropriately.
'@parameter' - name of a parameter '@parameter' - name of a parameter
'%CONST' - name of a constant. '%CONST' - name of a constant.
NOTE 1: The multi-line descriptive text you provide does *not* recognize
line breaks, so if you try to format some text nicely, as in:
Return codes
0 - cool
1 - invalid arg
2 - out of memory
this will all run together and produce:
Return codes 0 - cool 1 - invalid arg 2 - out of memory
NOTE 2: If the descriptive text you provide has lines that begin with
some phrase followed by a colon, each of those phrases will be taken as
a new section heading, which means you should similarly try to avoid text
like:
Return codes:
0: cool
1: invalid arg
2: out of memory
every line of which would start a new section. Again, probably not
what you were after.
Take a look around the source tree for examples. Take a look around the source tree for examples.