Search notes:
scripts/kernel-doc
scripts/kernel-doc
is a
Perl script that reads C language source or header FILEs, extracts embedded
kernel-doc comments and prints formatted documentation to
stdout .
Usage:
kernel-doc [-h] [-v] [-Werror] [-Wall] [-Wreturn] [-Wshort-description] [-Wcontents-before-sections]
[ -man |
-rst [-sphinx-version VERSION] [-enable-lineno] |
-none
]
[
-export |
-internal |
[-function NAME] ... |
[-nosymbol NAME] ...
]
[-no-doc-sections]
[-export-file FILE] ...
FILE ...
kernel-doc -h
simply prints the source code of itself.
See also
scripts/kernel-doc
is used by
scripts/find-unused-docs.sh
to check if a file contains kernel-doc but is not referenced in an
*.rst
file.
As of 2024-08, kernel-doc
is one of the two C-code parsers shipped with the kernel (the other being genksyms
).