Commit 262086cf authored by Robert P. J. Day's avatar Robert P. J. Day Committed by Linus Torvalds

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

Explain a couple of the most common errors in kernel-doc usage.
Signed-off-by: default avatarRobert P. J. Day <rpjday@mindspring.com>
Acked-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 78137e3b
......@@ -107,10 +107,14 @@ 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). Avoid putting a
spurious blank line after the function name, or else the description will
be repeated!
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.
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
patterns, which are highlighted appropriately.
......@@ -121,6 +125,31 @@ patterns, which are highlighted appropriately.
'@parameter' - name of a parameter
'%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.
......
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