Documentation/doc-guide/kernel-doc.rst

7 The Linux kernel source files may contain structured documentation
9 and design of the code. It is easier to keep documentation up-to-date
18    Documentation/rust/general-information.rst instead.
32 It is good practice to also provide kernel-doc formatted documentation
35 documentation for private (file ``static``) routines, for consistency of
49 that somebody changing the code will also change the documentation. The
55 documentation comments. For example::
59 The documentation format of ``.c`` files is also verified by the kernel build
67 Function documentation
177 Structure, union, and enumeration documentation
210 area are not listed in the generated output documentation.
286 In-line member documentation comments  argument
323 Typedef documentation
348 Variables documentation
360 Object-like macro documentation
479 For further details, please refer to the `Sphinx C Domain`_ documentation.
485 Overview documentation comments
489 kernel-doc documentation blocks that are free-form comments instead of being
496 The general format of an overview or high-level documentation comment is::
511 as an identifier for extracting the documentation comment. Thus, the title must
518 The documentation comments may be included in any of the reStructuredText
530   Include documentation for all functions in *source* that have been exported
547   Include documentation for all functions and types in *source* that have
557   Include documentation for each *function* and *type* in *source*.
558   If no *function* is specified, the documentation for all functions
572   Exclude documentation for each *function* and *type* in *source*.
583   Include documentation for the ``DOC:`` paragraph identified by *title* in
594 Without options, the kernel-doc directive includes all documentation comments
598 ``Documentation/sphinx/kerneldoc.py``. Internally, it uses the
599 ``tools/docs/kernel-doc`` script to extract the documentation comments from
616 (by default: ``Documentation/output``).
626    the files explicitly inside a ``Documentation/{subdir}/.../*.rst`` file.