Lines Matching refs:doc

1 kernel-doc nano-HOWTO
4 How to format kernel-doc comments
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.
17 a few simple conventions.  The scripts/kernel-doc perl script, some
24 kernel-doc comments in Linux kernel source.
26 We definitely need kernel-doc formatted documentation for functions
29 We also look to provide kernel-doc formatted documentation for
33 We also recommend providing kernel-doc formatted documentation
39 documented using kernel-doc formatted comments.
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
45 kernel-doc formatted comments.  The closing comment marker for
46 kernel-doc comments can be either "*/" or "**/", but "*/" is
49 Kernel-doc comments should be placed just before the function
52 Example kernel-doc function comment:
80 kernel-doc notation as:
86 Example kernel-doc data structure comment.
97 The kernel-doc function comments describe each parameter to the
100 The kernel-doc data structure comments describe each structure member
109 source files" for more details and notes on how to format kernel-doc
112 Components of the kernel-doc system
119 - scripts/kernel-doc
137   It invokes kernel-doc, giving it the list of functions that
169 $ scripts/kernel-doc -man $(find -name '*.c') | split-man.pl /tmp/man
170 $ scripts/kernel-doc -man $(find -name '*.h') | split-man.pl /tmp/man
202 $ scripts/kernel-doc -man -function fn file | nroff -man | less
206 $ scripts/kernel-doc -text -function fn file
273 kernel-doc for structs, unions, enums, and typedefs
310 include kernel-doc documentation blocks that are free-form comments
311 instead of being kernel-doc for functions, structures, unions,