linuxdoc.autodoc module

autodoc

Implementation of the kernel-autodoc command.

copyright

Copyright (C) 2018 Markus Heiser

license

GPL Version 2, June 1991 see Linux/COPYING for details.

The kernel-autodoc command extracts documentation from Linux kernel’s source code comments, see --help:

$ kernel-autodoc --help
linuxdoc.autodoc.ERR(msg)
linuxdoc.autodoc.FATAL(msg)
linuxdoc.autodoc.MSG(msg)
linuxdoc.autodoc.autodoc_file(fname)[source]

generate documentation from fname

linuxdoc.autodoc.gather_filenames(cmd)[source]

yield .c & .h filenames

linuxdoc.autodoc.insert_index_files(root_folder)[source]

From root_folder traverse over subfolders and generate all index.rst files

linuxdoc.autodoc.main()[source]

Parse kernel-doc comments from source code (main)