Index

A

add_filters() (linuxdoc.kernel_doc.ParseOptions method) add_kernel_figure_to_std_domain() (in module linuxdoc.kfigure)

apply() (linuxdoc.manKernelDoc.Section2Manpage method) autodoc_file() (in module linuxdoc.autodoc)

B

BITFIELD (linuxdoc.kernel_doc.ReSTTranslator attribute) build_node() (linuxdoc.kfigure.KernelRender method)

buildTableNode() (linuxdoc.rstFlatTable.ListTableBuilder method) buildTableRowNode() (linuxdoc.rstFlatTable.ListTableBuilder method)

C

c_span() (in module linuxdoc.rstFlatTable) check_return_section() (linuxdoc.kernel_doc.Parser method) check_sections() (linuxdoc.kernel_doc.Parser method) close() (linuxdoc.kernel_doc.Parser method) cmd_kernel_autodoc() (in module linuxdoc.deprecated) cmd_kernel_doc() (in module linuxdoc.deprecated)

cmd_kernel_grepdoc() (in module linuxdoc.deprecated) cmd_kernel_lintdoc() (in module linuxdoc.deprecated) colSpan (class in linuxdoc.rstFlatTable) comment() (linuxdoc.kernel_doc.TranslatorAPI class method) Container (class in linuxdoc.kernel_doc) convert_image() (in module linuxdoc.kfigure) create_parameterlist() (linuxdoc.kernel_doc.Parser method)

D

debug() (linuxdoc.kernel_doc.Parser method) (linuxdoc.kernel_doc.SimpleLog method) (linuxdoc.rstKernelDoc.KernelDocParser method) DEFAULT_EXP_IDS (in module linuxdoc.kernel_doc) DEFAULT_EXP_METHOD (in module linuxdoc.kernel_doc) DOC_TYPES (linuxdoc.kernel_doc.Parser attribute) dot2format() (in module linuxdoc.kfigure) dump_DOC() (linuxdoc.kernel_doc.Parser method) dump_enum() (linuxdoc.kernel_doc.Parser method) dump_epilog() (linuxdoc.kernel_doc.Parser method)

dump_function() (linuxdoc.kernel_doc.Parser method) dump_preamble() (linuxdoc.kernel_doc.Parser method) dump_prefix() (linuxdoc.kernel_doc.Parser method) dump_section() (linuxdoc.kernel_doc.Parser method) dump_struct() (linuxdoc.kernel_doc.Parser method) dump_suffix() (linuxdoc.kernel_doc.Parser method) dump_typedef() (linuxdoc.kernel_doc.Parser method) dump_union() (linuxdoc.kernel_doc.Parser method) dumpCtx() (linuxdoc.kernel_doc.ParserContext method) dumpOptions() (linuxdoc.kernel_doc.ParseOptions method)

E

eof() (linuxdoc.kernel_doc.ListTranslator method) (linuxdoc.kernel_doc.NullTranslator method) (linuxdoc.kernel_doc.TranslatorAPI method) ERR() (in module linuxdoc.autodoc) (in module linuxdoc.grepdoc) (in module linuxdoc.lint) errMsg() (linuxdoc.rstKernelDoc.KernelDoc method) error() (linuxdoc.kernel_doc.Parser method) (linuxdoc.kernel_doc.SimpleLog method) (linuxdoc.rstKernelDoc.KernelDocParser method) example.ADD (C macro) example.callback (C function) example.foo (C enum) example.genpool_algo_t (C function) example.iosys_map_wr_field (C macro) example.lineevent_state (C struct)

example.my_enum (C enum) example.my_long_struct (C struct) example.my_struct (C struct) example.my_typedef (C type) example.my_union (C union) example.nfp_flower_priv (C struct) example.rarely_enum (C enum) example.rarely_struct (C struct) example.rst_mode (C function) example.something (C struct) example.sys_tgkill (C function) example.trace_block_dirty_buffer (C function) example.trace_block_touch_buffer (C function) example.user_function (C function) example.user_sum (C function) example.v4l2_check_dv_timings_fnc (C function) example.vintage (C function)

F

FATAL() (in module linuxdoc.autodoc) (in module linuxdoc.lint) FaultyOption feed() (linuxdoc.kernel_doc.Parser method) file2literal() (in module linuxdoc.kfigure) filter_opt() (linuxdoc.kernel_doc.ParseOptions method) final_argument_whitespace (linuxdoc.kfigure.KernelRender attribute) (linuxdoc.rstKernelDoc.KernelDoc attribute)

finish() (linuxdoc.manKernelDoc.KernelDocManBuilder method) FlatTable (class in linuxdoc.rstFlatTable) flush() (linuxdoc.rstKernelDoc.WriterList method) foo.user_function (C function) format (linuxdoc.manKernelDoc.KernelDocManBuilder attribute) format_block() (linuxdoc.kernel_doc.ReSTTranslator method) FUNC_PTR (linuxdoc.kernel_doc.ReSTTranslator attribute)

G

gather_context() (linuxdoc.kernel_doc.Parser class method) gather_filenames() (in module linuxdoc.autodoc) get() (linuxdoc.rstKernelDoc.ParserCache method) get_cli() (in module linuxdoc.autodoc) (in module linuxdoc.grepdoc) (in module linuxdoc.lint) (in module linuxdoc.rest)

get_epilog() (linuxdoc.kernel_doc.TranslatorAPI method) get_exported_symbols_re() (linuxdoc.kernel_doc.ParseOptions method) get_id() (linuxdoc.rstKernelDoc.ParserCache method) get_partial_document() (linuxdoc.manKernelDoc.KernelDocManBuilder method) get_preamble() (linuxdoc.kernel_doc.TranslatorAPI method) get_type() (linuxdoc.kernel_doc.ListTranslator method) getNodes() (linuxdoc.rstKernelDoc.KernelDoc method) getParserOptions() (linuxdoc.rstKernelDoc.KernelDoc method)

H

has_content (linuxdoc.kfigure.KernelRender attribute) HEADER_TAGS (linuxdoc.kernel_doc.ReSTTranslator attribute) highlight() (linuxdoc.kernel_doc.ReSTTranslator method) (linuxdoc.kernel_doc.TranslatorAPI method)

HIGHLIGHT_MAP (linuxdoc.kernel_doc.NullTranslator attribute) (linuxdoc.kernel_doc.ReSTTranslator attribute) (linuxdoc.kernel_doc.TranslatorAPI attribute) highlight_parser() (in module linuxdoc.kernel_doc)

I

INDENT (linuxdoc.kernel_doc.ReSTTranslator attribute) info() (linuxdoc.kernel_doc.Parser method) (linuxdoc.kernel_doc.SimpleLog method) (linuxdoc.rstKernelDoc.KernelDocParser method) init() (linuxdoc.manKernelDoc.KernelDocManBuilder method)

insert_index_files() (in module linuxdoc.autodoc) is_manpage() (linuxdoc.manKernelDoc.KernelDocManBuilder method) isNewer() (in module linuxdoc.kfigure) isolate_sections() (linuxdoc.manKernelDoc.Section2Manpage method) isolate_synopsis() (linuxdoc.manKernelDoc.Section2Manpage method)

K

kernel_doc_man (class in linuxdoc.manKernelDoc) kernel_figure (class in linuxdoc.kfigure) kernel_image (class in linuxdoc.kfigure) kernel_render (class in linuxdoc.kfigure) KernelDoc (class in linuxdoc.rstKernelDoc) KernelDocMan (class in linuxdoc.manKernelDoc)

KernelDocManBuilder (class in linuxdoc.manKernelDoc) KernelDocParser (class in linuxdoc.rstKernelDoc) KernelFigure (class in linuxdoc.kfigure) KernelImage (class in linuxdoc.kfigure) KernelInclude (class in linuxdoc.kernel_include) KernelRender (class in linuxdoc.kfigure)

L

LINE_COMMENT (linuxdoc.kernel_doc.NullTranslator attribute) (linuxdoc.kernel_doc.ReSTTranslator attribute) (linuxdoc.kernel_doc.TranslatorAPI attribute) lintdoc_file() (in module linuxdoc.lint) linuxdoc module linuxdoc.autodoc module linuxdoc.cdomain module linuxdoc.compat module linuxdoc.deprecated module linuxdoc.grepdoc module linuxdoc.kernel_doc module

linuxdoc.kernel_include module linuxdoc.kfigure module linuxdoc.lint module linuxdoc.manKernelDoc module linuxdoc.rest module linuxdoc.rstFlatTable module linuxdoc.rstKernelDoc module ListTableBuilder (class in linuxdoc.rstFlatTable) ListTranslator (class in linuxdoc.kernel_doc) LOG_FORMAT (linuxdoc.kernel_doc.Parser attribute) (linuxdoc.kernel_doc.SimpleLog attribute)

M

main() (in module linuxdoc.autodoc) (in module linuxdoc.grepdoc) (in module linuxdoc.lint) (in module linuxdoc.rest) manTitleOrder (linuxdoc.manKernelDoc.Section2Manpage attribute) manTitles (linuxdoc.manKernelDoc.Section2Manpage attribute) map_row() (in module linuxdoc.kernel_doc) MASK_REST_INLINES (linuxdoc.kernel_doc.ReSTTranslator attribute) match() (linuxdoc.kernel_doc.RE method) mkdir() (in module linuxdoc.kfigure) module linuxdoc linuxdoc.autodoc linuxdoc.cdomain linuxdoc.compat linuxdoc.deprecated linuxdoc.grepdoc linuxdoc.kernel_doc linuxdoc.kernel_include linuxdoc.kfigure linuxdoc.lint linuxdoc.manKernelDoc linuxdoc.rest linuxdoc.rstFlatTable linuxdoc.rstKernelDoc

MSG() (in module linuxdoc.autodoc) (in module linuxdoc.lint)

N

name (linuxdoc.manKernelDoc.KernelDocManBuilder attribute) new() (linuxdoc.kernel_doc.ParserContext method)

normalize_id() (in module linuxdoc.kernel_doc) normalize_ws() (in module linuxdoc.kernel_doc) NullTranslator (class in linuxdoc.kernel_doc)

O

openTextFile() (in module linuxdoc.kernel_doc) option_spec (linuxdoc.kfigure.KernelRender attribute) (linuxdoc.rstFlatTable.FlatTable attribute) (linuxdoc.rstKernelDoc.KernelDoc attribute) optional_arguments (linuxdoc.kfigure.KernelRender attribute) (linuxdoc.manKernelDoc.KernelDocMan attribute) (linuxdoc.rstKernelDoc.KernelDoc attribute) output_decl() (linuxdoc.kernel_doc.Parser method) output_DOC() (linuxdoc.kernel_doc.ListTranslator method) (linuxdoc.kernel_doc.NullTranslator method) (linuxdoc.kernel_doc.ReSTTranslator method) (linuxdoc.kernel_doc.TranslatorAPI method) output_enum_decl() (linuxdoc.kernel_doc.ListTranslator method) (linuxdoc.kernel_doc.NullTranslator method) (linuxdoc.kernel_doc.ReSTTranslator method) (linuxdoc.kernel_doc.TranslatorAPI method) output_epilog() (linuxdoc.kernel_doc.ListTranslator method) (linuxdoc.kernel_doc.NullTranslator method) (linuxdoc.kernel_doc.ReSTTranslator method) (linuxdoc.kernel_doc.TranslatorAPI method) output_function_decl() (linuxdoc.kernel_doc.ListTranslator method) (linuxdoc.kernel_doc.NullTranslator method) (linuxdoc.kernel_doc.ReSTTranslator method) (linuxdoc.kernel_doc.TranslatorAPI method)

output_preamble() (linuxdoc.kernel_doc.ListTranslator method) (linuxdoc.kernel_doc.NullTranslator method) (linuxdoc.kernel_doc.ReSTTranslator method) (linuxdoc.kernel_doc.TranslatorAPI method) output_prefix() (linuxdoc.kernel_doc.ListTranslator method) (linuxdoc.kernel_doc.NullTranslator method) (linuxdoc.kernel_doc.ReSTTranslator method) (linuxdoc.kernel_doc.TranslatorAPI method) output_struct_decl() (linuxdoc.kernel_doc.ListTranslator method) (linuxdoc.kernel_doc.NullTranslator method) (linuxdoc.kernel_doc.ReSTTranslator method) (linuxdoc.kernel_doc.TranslatorAPI method) output_suffix() (linuxdoc.kernel_doc.ListTranslator method) (linuxdoc.kernel_doc.NullTranslator method) (linuxdoc.kernel_doc.ReSTTranslator method) (linuxdoc.kernel_doc.TranslatorAPI method) output_typedef_decl() (linuxdoc.kernel_doc.ListTranslator method) (linuxdoc.kernel_doc.NullTranslator method) (linuxdoc.kernel_doc.ReSTTranslator method) (linuxdoc.kernel_doc.TranslatorAPI method) output_union_decl() (linuxdoc.kernel_doc.ListTranslator method) (linuxdoc.kernel_doc.NullTranslator method) (linuxdoc.kernel_doc.TranslatorAPI method)

P

parse() (linuxdoc.kernel_doc.Parser method) parse_dump_storage() (linuxdoc.kernel_doc.Parser method) PARSE_OPTION_RE (linuxdoc.kernel_doc.ParseOptions attribute) PARSE_OPTIONS (linuxdoc.kernel_doc.ParseOptions attribute) parseCellItem() (linuxdoc.rstFlatTable.ListTableBuilder method) parseFlatTableNode() (linuxdoc.rstFlatTable.ListTableBuilder method) ParseOptions (class in linuxdoc.kernel_doc) Parser (class in linuxdoc.kernel_doc) PARSER_CACHE (in module linuxdoc.rstKernelDoc) ParserBuggy ParserCache (class in linuxdoc.rstKernelDoc)

ParserContext (class in linuxdoc.kernel_doc) parseRowItem() (linuxdoc.rstFlatTable.ListTableBuilder method) parseSource() (linuxdoc.rstKernelDoc.KernelDoc method) pass_handle() (in module linuxdoc.kfigure) pprint() (linuxdoc.rstFlatTable.ListTableBuilder method) prepare_struct_union() (linuxdoc.kernel_doc.Parser method) prepare_writing() (linuxdoc.manKernelDoc.KernelDocManBuilder method) PRINT() (in module linuxdoc.grepdoc) process_state3_function() (linuxdoc.kernel_doc.Parser method) process_state3_type() (linuxdoc.kernel_doc.Parser method) push_parameter() (linuxdoc.kernel_doc.Parser method)

R

r_span() (in module linuxdoc.rstFlatTable) raiseError() (linuxdoc.rstFlatTable.ListTableBuilder method) RE (class in linuxdoc.kernel_doc) readFile() (in module linuxdoc.kernel_doc) required_arguments (linuxdoc.kfigure.KernelRender attribute) (linuxdoc.manKernelDoc.KernelDocMan attribute) (linuxdoc.rstKernelDoc.KernelDoc attribute) reset_state() (linuxdoc.kernel_doc.Parser method) ReSTTranslator (class in linuxdoc.kernel_doc)

roundOffTableDefinition() (linuxdoc.rstFlatTable.ListTableBuilder method) rowSpan (class in linuxdoc.rstFlatTable) rst_mode (C function) run() (linuxdoc.kernel_include.KernelInclude method) (linuxdoc.kfigure.KernelFigure method) (linuxdoc.kfigure.KernelImage method) (linuxdoc.kfigure.KernelRender method) (linuxdoc.manKernelDoc.KernelDocMan method) (linuxdoc.rstFlatTable.FlatTable method) (linuxdoc.rstKernelDoc.KernelDoc method)

S

search() (linuxdoc.kernel_doc.RE method) sec2man_get_first_child() (linuxdoc.manKernelDoc.Section2Manpage class method) sect_title() (linuxdoc.kernel_doc.Parser method) Section2Manpage (class in linuxdoc.manKernelDoc) section_constants (linuxdoc.kernel_doc.Parser attribute) section_context (linuxdoc.kernel_doc.Parser attribute) section_def (linuxdoc.kernel_doc.Parser attribute) section_default (linuxdoc.kernel_doc.Parser attribute) section_descr (linuxdoc.kernel_doc.Parser attribute) section_intro (linuxdoc.kernel_doc.Parser attribute) section_members (linuxdoc.kernel_doc.Parser attribute) section_return (linuxdoc.kernel_doc.Parser attribute) set() (linuxdoc.rstKernelDoc.ParserCache method) set_defaults() (linuxdoc.kernel_doc.ParseOptions method) setOptions() (linuxdoc.kernel_doc.Parser method) (linuxdoc.kernel_doc.TranslatorAPI method) setParser() (linuxdoc.kernel_doc.TranslatorAPI method) setTranslator() (linuxdoc.kernel_doc.Parser method) setup() (in module linuxdoc.cdomain) (in module linuxdoc.kernel_include) (in module linuxdoc.kfigure) (in module linuxdoc.manKernelDoc) (in module linuxdoc.rstFlatTable) (in module linuxdoc.rstKernelDoc)

setupTools() (in module linuxdoc.kfigure) SimpleLog (class in linuxdoc.kernel_doc) skip_kernel_doc_man() (in module linuxdoc.manKernelDoc) special_sections (linuxdoc.kernel_doc.Parser attribute) sphinx_has_c_namespace() (in module linuxdoc.compat) sphinx_has_c_types() (in module linuxdoc.compat) state_0() (linuxdoc.kernel_doc.Parser method) state_1() (linuxdoc.kernel_doc.Parser method) state_2() (linuxdoc.kernel_doc.Parser method) state_3() (linuxdoc.kernel_doc.Parser method) state_4() (linuxdoc.kernel_doc.Parser method) state_5() (linuxdoc.kernel_doc.Parser method) strip_man_info() (linuxdoc.manKernelDoc.Section2Manpage method) supported_image_types (linuxdoc.manKernelDoc.KernelDocManBuilder attribute) svg2pdf() (in module linuxdoc.kfigure) sys_tgkill (C function) syscall_munge() (linuxdoc.kernel_doc.Parser method)

T

test.fnattrs.user_sum (C function) test.user_function (C function) test_internals_A.bar (C function) test_internals_A.internal_function (C function)

test_internals_B.foo (C function) test_internals_B.internal_function (C function) tracepoint_munge() (linuxdoc.kernel_doc.Parser method) TranslatorAPI (class in linuxdoc.kernel_doc)

U

undescribed (linuxdoc.kernel_doc.Parser attribute)

V

visit_kernel_figure() (in module linuxdoc.kfigure)

visit_kernel_image() (in module linuxdoc.kfigure) visit_kernel_render() (in module linuxdoc.kfigure)

W

warn() (linuxdoc.kernel_doc.Parser method) (linuxdoc.kernel_doc.SimpleLog method) (linuxdoc.rstKernelDoc.KernelDocParser method) which() (in module linuxdoc.kfigure) write() (linuxdoc.kernel_doc.TranslatorAPI method) (linuxdoc.manKernelDoc.KernelDocManBuilder method) (linuxdoc.rstKernelDoc.WriterList method)

write_anchor() (linuxdoc.kernel_doc.ReSTTranslator method) write_comment() (linuxdoc.kernel_doc.TranslatorAPI method) write_definition() (linuxdoc.kernel_doc.ReSTTranslator method) write_doc() (linuxdoc.manKernelDoc.KernelDocManBuilder method) write_func_param() (linuxdoc.kernel_doc.ReSTTranslator method) write_header() (linuxdoc.kernel_doc.ReSTTranslator method) write_section() (linuxdoc.kernel_doc.ReSTTranslator method) WriterList (class in linuxdoc.rstKernelDoc)