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 is verified by the kernel build when it is
64 Function documentation
174 Structure, union, and enumeration documentation
206 area are not listed in the generated output documentation.
282 In-line member documentation comments  argument
319 Typedef documentation
344 Object-like macro documentation
459 For further details, please refer to the `Sphinx C Domain`_ documentation.
461 Overview documentation comments
465 kernel-doc documentation blocks that are free-form comments instead of being
472 The general format of an overview or high-level documentation comment is::
487 as an identifier for extracting the documentation comment. Thus, the title must
494 The documentation comments may be included in any of the reStructuredText
506   Include documentation for all functions in *source* that have been exported
523   Include documentation for all functions and types in *source* that have
533   Include documentation for each *function* and *type* in *source*.
534   If no *function* is specified, the documentation for all functions
546   Exclude documentation for each *function* and *type* in *source*.
557   Include documentation for the ``DOC:`` paragraph identified by *title* in
568 Without options, the kernel-doc directive includes all documentation comments
572 ``Documentation/sphinx/kerneldoc.py``. Internally, it uses the
573 ``scripts/kernel-doc`` script to extract the documentation comments from the
585     $(git grep -l '/\*\*' -- :^Documentation :^tools) \
592     $(git grep -l '/\*\*' -- . ':!Documentation' ':!tools') \
596     $(git grep -l '/\*\*' -- . ":(exclude)Documentation" ":(exclude)tools") \