Author: Robert P. J. Day <[EMAIL PROTECTED]>
AuthorDate: Sat Feb 10 01:45:58 2007 -0800
Committer: Linus Torvalds <[EMAIL PROTECTED]>
CommitDate: Sun Feb 11 10:51:32 2007 -0800
[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: Robert P. J. Day <[EMAIL PROTECTED]>
Acked-by: Randy Dunlap <[EMAIL PROTECTED]>
Signed-off-by: Andrew Morton <[EMAIL PROTECTED]>
Signed-off-by: Linus Torvalds <[EMAIL PROTECTED]>
Documentation/kernel-doc-nano-HOWTO.txt | 37 +++++++++++++++++++++++++++---
1 files changed, 33 insertions(+), 4 deletions(-)
diff --git a/Documentation/kernel-doc-nano-HOWTO.txt
index 6ca507f..2075c06 100644
@@ -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
+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
+ 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.
To unsubscribe from this list: send the line "unsubscribe git-commits-head" in
the body of a message to [EMAIL PROTECTED]
More majordomo info at http://vger.kernel.org/majordomo-info.html