Lines Matching full:documentation

4 The Linux kernel source files may contain structured documentation
6 and design of the code. It is easier to keep documentation up-to-date
26 It is good practice to also provide kernel-doc formatted documentation
29 documentation for private (file ``static``) routines, for consistency of
43 that somebody changing the code will also change the documentation. The
49 documentation comments. For example::
53 The documentation format is verified by the kernel build when it is
58 Function documentation
168 Structure, union, and enumeration documentation
200 area are not listed in the generated output documentation.
276 In-line member documentation comments  argument
313 Typedef documentation
407 For further details, please refer to the `Sphinx C Domain`_ documentation.
409 Overview documentation comments
413 kernel-doc documentation blocks that are free-form comments instead of being
420 The general format of an overview or high-level documentation comment is::
435 as an identifier for extracting the documentation comment. Thus, the title must
441 The documentation comments may be included in any of the reStructuredText
453   Include documentation for all functions in *source* that have been exported
470   Include documentation for all functions and types in *source* that have
480   Include documentation for the ``DOC:`` paragraph identified by *title* in
492   Include documentation for each *function* in *source*.
493   If no *function* is specified, the documentation for all functions
504 Without options, the kernel-doc directive includes all documentation comments
508 ``Documentation/sphinx/kerneldoc.py``. Internally, it uses the
509 ``scripts/kernel-doc`` script to extract the documentation comments from the
521     $(git grep -l '/\*\*' -- :^Documentation :^tools) \
528     $(git grep -l '/\*\*' -- . ':!Documentation' ':!tools') \
532     $(git grep -l '/\*\*' -- . ":(exclude)Documentation" ":(exclude)tools") \