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
408 For further details, please refer to the `Sphinx C Domain`_ documentation.
410 Overview documentation comments
414 kernel-doc documentation blocks that are free-form comments instead of being
421 The general format of an overview or high-level documentation comment is::
436 as an identifier for extracting the documentation comment. Thus, the title must
442 The documentation comments may be included in any of the reStructuredText
454 Include documentation for all functions in *source* that have been exported
471 Include documentation for all functions and types in *source* that have
481 Include documentation for each *function* and *type* in *source*.
482 If no *function* is specified, the documentation for all functions
494 Exclude documentation for each *function* and *type* in *source*.
505 Include documentation for the ``DOC:`` paragraph identified by *title* in
516 Without options, the kernel-doc directive includes all documentation comments
520 ``Documentation/sphinx/kerneldoc.py``. Internally, it uses the
521 ``scripts/kernel-doc`` script to extract the documentation comments from the
533 $(git grep -l '/\*\*' -- :^Documentation :^tools) \
540 $(git grep -l '/\*\*' -- . ':!Documentation' ':!tools') \
544 $(git grep -l '/\*\*' -- . ":(exclude)Documentation" ":(exclude)tools") \