V4L/DVB (10210): Fix a bug on v4lgrab.c
[linux-2.6.git] / Documentation / kernel-doc-nano-HOWTO.txt
1 kernel-doc nano-HOWTO
2 =====================
3
4 How to format kernel-doc comments
5 ---------------------------------
6
7 In order to provide embedded, 'C' friendly, easy to maintain,
8 but consistent and extractable documentation of the functions and
9 data structures in the Linux kernel, the Linux kernel has adopted
10 a consistent style for documenting functions and their parameters,
11 and structures and their members.
12
13 The format for this documentation is called the kernel-doc format.
14 It is documented in this Documentation/kernel-doc-nano-HOWTO.txt file.
15
16 This style embeds the documentation within the source files, using
17 a few simple conventions.  The scripts/kernel-doc perl script, some
18 SGML templates in Documentation/DocBook, and other tools understand
19 these conventions, and are used to extract this embedded documentation
20 into various documents.
21
22 In order to provide good documentation of kernel functions and data
23 structures, please use the following conventions to format your
24 kernel-doc comments in Linux kernel source.
25
26 We definitely need kernel-doc formatted documentation for functions
27 that are exported to loadable modules using EXPORT_SYMBOL.
28
29 We also look to provide kernel-doc formatted documentation for
30 functions externally visible to other kernel files (not marked
31 "static").
32
33 We also recommend providing kernel-doc formatted documentation
34 for private (file "static") routines, for consistency of kernel
35 source code layout.  But this is lower priority and at the
36 discretion of the MAINTAINER of that kernel source file.
37
38 Data structures visible in kernel include files should also be
39 documented using kernel-doc formatted comments.
40
41 The opening comment mark "/**" is reserved for kernel-doc comments.
42 Only comments so marked will be considered by the kernel-doc scripts,
43 and any comment so marked must be in kernel-doc format.  Do not use
44 "/**" to be begin a comment block unless the comment block contains
45 kernel-doc formatted comments.  The closing comment marker for
46 kernel-doc comments can be either "*/" or "**/".
47
48 Kernel-doc comments should be placed just before the function
49 or data structure being described.
50
51 Example kernel-doc function comment:
52
53 /**
54  * foobar() - short function description of foobar
55  * @arg1:       Describe the first argument to foobar.
56  * @arg2:       Describe the second argument to foobar.
57  *              One can provide multiple line descriptions
58  *              for arguments.
59  *
60  * A longer description, with more discussion of the function foobar()
61  * that might be useful to those using or modifying it.  Begins with
62  * empty comment line, and may include additional embedded empty
63  * comment lines.
64  *
65  * The longer description can have multiple paragraphs.
66  **/
67
68 The first line, with the short description, must be on a single line.
69
70 The @argument descriptions must begin on the very next line following
71 this opening short function description line, with no intervening
72 empty comment lines.
73
74 If a function parameter is "..." (varargs), it should be listed in
75 kernel-doc notation as:
76  * @...: description
77
78
79 Example kernel-doc data structure comment.
80
81 /**
82  * struct blah - the basic blah structure
83  * @mem1:       describe the first member of struct blah
84  * @mem2:       describe the second member of struct blah,
85  *              perhaps with more lines and words.
86  *
87  * Longer description of this structure.
88  **/
89
90 The kernel-doc function comments describe each parameter to the
91 function, in order, with the @name lines.
92
93 The kernel-doc data structure comments describe each structure member
94 in the data structure, with the @name lines.
95
96 The longer description formatting is "reflowed", losing your line
97 breaks.  So presenting carefully formatted lists within these
98 descriptions won't work so well; derived documentation will lose
99 the formatting.
100
101 See the section below "How to add extractable documentation to your
102 source files" for more details and notes on how to format kernel-doc
103 comments.
104
105 Components of the kernel-doc system
106 -----------------------------------
107
108 Many places in the source tree have extractable documentation in the
109 form of block comments above functions.  The components of this system
110 are:
111
112 - scripts/kernel-doc
113
114   This is a perl script that hunts for the block comments and can mark
115   them up directly into DocBook, man, text, and HTML. (No, not
116   texinfo.)
117
118 - Documentation/DocBook/*.tmpl
119
120   These are SGML template files, which are normal SGML files with
121   special place-holders for where the extracted documentation should
122   go.
123
124 - scripts/basic/docproc.c
125
126   This is a program for converting SGML template files into SGML
127   files. When a file is referenced it is searched for symbols
128   exported (EXPORT_SYMBOL), to be able to distinguish between internal
129   and external functions.
130   It invokes kernel-doc, giving it the list of functions that
131   are to be documented.
132   Additionally it is used to scan the SGML template files to locate
133   all the files referenced herein. This is used to generate dependency
134   information as used by make.
135
136 - Makefile
137
138   The targets 'sgmldocs', 'psdocs', 'pdfdocs', and 'htmldocs' are used
139   to build DocBook files, PostScript files, PDF files, and html files
140   in Documentation/DocBook.
141
142 - Documentation/DocBook/Makefile
143
144   This is where C files are associated with SGML templates.
145
146
147 How to extract the documentation
148 --------------------------------
149
150 If you just want to read the ready-made books on the various
151 subsystems (see Documentation/DocBook/*.tmpl), just type 'make
152 psdocs', or 'make pdfdocs', or 'make htmldocs', depending on your
153 preference.  If you would rather read a different format, you can type
154 'make sgmldocs' and then use DocBook tools to convert
155 Documentation/DocBook/*.sgml to a format of your choice (for example,
156 'db2html ...' if 'make htmldocs' was not defined).
157
158 If you want to see man pages instead, you can do this:
159
160 $ cd linux
161 $ scripts/kernel-doc -man $(find -name '*.c') | split-man.pl /tmp/man
162 $ scripts/kernel-doc -man $(find -name '*.h') | split-man.pl /tmp/man
163
164 Here is split-man.pl:
165
166 -->
167 #!/usr/bin/perl
168
169 if ($#ARGV < 0) {
170    die "where do I put the results?\n";
171 }
172
173 mkdir $ARGV[0],0777;
174 $state = 0;
175 while (<STDIN>) {
176     if (/^\.TH \"[^\"]*\" 9 \"([^\"]*)\"/) {
177         if ($state == 1) { close OUT }
178         $state = 1;
179         $fn = "$ARGV[0]/$1.9";
180         print STDERR "Creating $fn\n";
181         open OUT, ">$fn" or die "can't open $fn: $!\n";
182         print OUT $_;
183     } elsif ($state != 0) {
184         print OUT $_;
185     }
186 }
187
188 close OUT;
189 <--
190
191 If you just want to view the documentation for one function in one
192 file, you can do this:
193
194 $ scripts/kernel-doc -man -function fn file | nroff -man | less
195
196 or this:
197
198 $ scripts/kernel-doc -text -function fn file
199
200
201 How to add extractable documentation to your source files
202 ---------------------------------------------------------
203
204 The format of the block comment is like this:
205
206 /**
207  * function_name(:)? (- short description)?
208 (* @parameterx(space)*: (description of parameter x)?)*
209 (* a blank line)?
210  * (Description:)? (Description of function)?
211  * (section header: (section description)? )*
212 (*)?*/
213
214 The short function description ***cannot be multiline***, but the other
215 descriptions can be (and they can contain blank lines).  If you continue
216 that initial short description onto a second line, that second line will
217 appear further down at the beginning of the description section, which is
218 almost certainly not what you had in mind.
219
220 Avoid putting a spurious blank line after the function name, or else the
221 description will be repeated!
222
223 All descriptive text is further processed, scanning for the following special
224 patterns, which are highlighted appropriately.
225
226 'funcname()' - function
227 '$ENVVAR' - environment variable
228 '&struct_name' - name of a structure (up to two words including 'struct')
229 '@parameter' - name of a parameter
230 '%CONST' - name of a constant.
231
232 NOTE 1:  The multi-line descriptive text you provide does *not* recognize
233 line breaks, so if you try to format some text nicely, as in:
234
235   Return codes
236     0 - cool
237     1 - invalid arg
238     2 - out of memory
239
240 this will all run together and produce:
241
242   Return codes 0 - cool 1 - invalid arg 2 - out of memory
243
244 NOTE 2:  If the descriptive text you provide has lines that begin with
245 some phrase followed by a colon, each of those phrases will be taken as
246 a new section heading, which means you should similarly try to avoid text
247 like:
248
249   Return codes:
250     0: cool
251     1: invalid arg
252     2: out of memory
253
254 every line of which would start a new section.  Again, probably not
255 what you were after.
256
257 Take a look around the source tree for examples.
258
259
260 kernel-doc for structs, unions, enums, and typedefs
261 ---------------------------------------------------
262
263 Beside functions you can also write documentation for structs, unions,
264 enums and typedefs. Instead of the function name you must write the name
265 of the declaration;  the struct/union/enum/typedef must always precede
266 the name. Nesting of declarations is not supported.
267 Use the argument mechanism to document members or constants.
268
269 Inside a struct description, you can use the "private:" and "public:"
270 comment tags.  Structure fields that are inside a "private:" area
271 are not listed in the generated output documentation.
272
273 Example:
274
275 /**
276  * struct my_struct - short description
277  * @a: first member
278  * @b: second member
279  *
280  * Longer description
281  */
282 struct my_struct {
283     int a;
284     int b;
285 /* private: */
286     int c;
287 };
288
289
290 Including documentation blocks in source files
291 ----------------------------------------------
292
293 To facilitate having source code and comments close together, you can
294 include kernel-doc documentation blocks that are free-form comments
295 instead of being kernel-doc for functions, structures, unions,
296 enums, or typedefs.  This could be used for something like a
297 theory of operation for a driver or library code, for example.
298
299 This is done by using a DOC: section keyword with a section title.  E.g.:
300
301 /**
302  * DOC: Theory of Operation
303  *
304  * The whizbang foobar is a dilly of a gizmo.  It can do whatever you
305  * want it to do, at any time.  It reads your mind.  Here's how it works.
306  *
307  * foo bar splat
308  *
309  * The only drawback to this gizmo is that is can sometimes damage
310  * hardware, software, or its subject(s).
311  */
312
313 DOC: sections are used in SGML templates files as indicated below.
314
315
316 How to make new SGML template files
317 -----------------------------------
318
319 SGML template files (*.tmpl) are like normal SGML files, except that
320 they can contain escape sequences where extracted documentation should
321 be inserted.
322
323 !E<filename> is replaced by the documentation, in <filename>, for
324 functions that are exported using EXPORT_SYMBOL: the function list is
325 collected from files listed in Documentation/DocBook/Makefile.
326
327 !I<filename> is replaced by the documentation for functions that are
328 _not_ exported using EXPORT_SYMBOL.
329
330 !D<filename> is used to name additional files to search for functions
331 exported using EXPORT_SYMBOL.
332
333 !F<filename> <function [functions...]> is replaced by the
334 documentation, in <filename>, for the functions listed.
335
336 !P<filename> <section title> is replaced by the contents of the DOC:
337 section titled <section title> from <filename>.
338 Spaces are allowed in <section title>; do not quote the <section title>.
339
340 Tim.
341 */ <twaugh@redhat.com>