On Fri, 5 Jan 2007 10:03:53 -0500 (EST) Robert P. J. Day wrote:
>
> Explain a couple of the most common errors in kernel-doc usage.
>
> Signed-off-by: Robert P. J. Day <[email protected]>
Acked-by: Randy Dunlap <[email protected]>
It seems that you have been looking at my kdoc todo list....
> ---
>
> seems useful to emphasize these issues since they occur occasionally
> in the source.
>
> diff --git a/Documentation/kernel-doc-nano-HOWTO.txt b/Documentation/kernel-doc-nano-HOWTO.txt
> index 284e7e1..ba50129 100644
> --- a/Documentation/kernel-doc-nano-HOWTO.txt
> +++ b/Documentation/kernel-doc-nano-HOWTO.txt
> @@ -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.
>
>
> -
---
~Randy
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
[Index of Archives]
[Kernel Newbies]
[Netfilter]
[Bugtraq]
[Photo]
[Stuff]
[Gimp]
[Yosemite News]
[MIPS Linux]
[ARM Linux]
[Linux Security]
[Linux RAID]
[Video 4 Linux]
[Linux for the blind]
[Linux Resources]
