linuxdoc.rstKernelDoc module¶
rstKernelDoc¶
Implementation of the kernel-doc
reST-directive.
The kernel-doc
(KernelDoc
) directive includes contend from
linux kernel source code comments.
-
class
linuxdoc.rstKernelDoc.
KernelDoc
(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶ Bases:
docutils.parsers.rst.Directive
KernelDoc (
kernel-doc
) directive-
final_argument_whitespace
= True¶ May the final argument contain whitespace?
-
option_spec
= {'debug': <function flag>, 'doc': <function unchanged_required>, 'encoding': <function encoding>, 'exp-ids': <function unchanged_required>, 'exp-method': <function unchanged_required>, 'export': <function unchanged>, 'functions': <function unchanged_required>, 'internal': <function unchanged>, 'known-attrs': <function unchanged_required>, 'language': <function unchanged_required>, 'linenos': <function flag>, 'man-sect': <function nonnegative_int>, 'module': <function unchanged_required>, 'no-header': <function flag>, 'snippets': <function unchanged_required>, 'symbols': <function unchanged_required>}¶ Mapping of option names to validator functions.
-
optional_arguments
= 0¶ Number of optional arguments after the required arguments.
-
required_arguments
= 1¶ Number of required directive arguments.
-
-
class
linuxdoc.rstKernelDoc.
KernelDocParser
(app, *args, **kwargs)[source]¶ Bases:
linuxdoc.kernel_doc.Parser