aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/kernel-doc-nano-HOWTO.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/kernel-doc-nano-HOWTO.txt')
-rw-r--r--Documentation/kernel-doc-nano-HOWTO.txt13
1 files changed, 10 insertions, 3 deletions
diff --git a/Documentation/kernel-doc-nano-HOWTO.txt b/Documentation/kernel-doc-nano-HOWTO.txt
index 3d8a97747f77..99b57abddf8a 100644
--- a/Documentation/kernel-doc-nano-HOWTO.txt
+++ b/Documentation/kernel-doc-nano-HOWTO.txt
@@ -64,6 +64,8 @@ Example kernel-doc function comment:
64 * comment lines. 64 * comment lines.
65 * 65 *
66 * The longer description can have multiple paragraphs. 66 * The longer description can have multiple paragraphs.
67 *
68 * Return: Describe the return value of foobar.
67 */ 69 */
68 70
69The short description following the subject can span multiple lines 71The short description following the subject can span multiple lines
@@ -78,6 +80,8 @@ If a function parameter is "..." (varargs), it should be listed in
78kernel-doc notation as: 80kernel-doc notation as:
79 * @...: description 81 * @...: description
80 82
83The return value, if any, should be described in a dedicated section
84named "Return".
81 85
82Example kernel-doc data structure comment. 86Example kernel-doc data structure comment.
83 87
@@ -222,6 +226,9 @@ only a "*").
222"section header:" names must be unique per function (or struct, 226"section header:" names must be unique per function (or struct,
223union, typedef, enum). 227union, typedef, enum).
224 228
229Use the section header "Return" for sections describing the return value
230of a function.
231
225Avoid putting a spurious blank line after the function name, or else the 232Avoid putting a spurious blank line after the function name, or else the
226description will be repeated! 233description will be repeated!
227 234
@@ -237,21 +244,21 @@ patterns, which are highlighted appropriately.
237NOTE 1: The multi-line descriptive text you provide does *not* recognize 244NOTE 1: The multi-line descriptive text you provide does *not* recognize
238line breaks, so if you try to format some text nicely, as in: 245line breaks, so if you try to format some text nicely, as in:
239 246
240 Return codes 247 Return:
241 0 - cool 248 0 - cool
242 1 - invalid arg 249 1 - invalid arg
243 2 - out of memory 250 2 - out of memory
244 251
245this will all run together and produce: 252this will all run together and produce:
246 253
247 Return codes 0 - cool 1 - invalid arg 2 - out of memory 254 Return: 0 - cool 1 - invalid arg 2 - out of memory
248 255
249NOTE 2: If the descriptive text you provide has lines that begin with 256NOTE 2: If the descriptive text you provide has lines that begin with
250some phrase followed by a colon, each of those phrases will be taken as 257some phrase followed by a colon, each of those phrases will be taken as
251a new section heading, which means you should similarly try to avoid text 258a new section heading, which means you should similarly try to avoid text
252like: 259like:
253 260
254 Return codes: 261 Return:
255 0: cool 262 0: cool
256 1: invalid arg 263 1: invalid arg
257 2: out of memory 264 2: out of memory