Index

Symbols

--force sphinx-c-apidoc command line option --header-ext sphinx-c-apidoc command line option --help sphinx-c-apidoc command line option --output-path sphinx-c-apidoc command line option --source-ext sphinx-c-apidoc command line option --templatedir sphinx-c-apidoc command line option

--tocfile sphinx-c-apidoc command line option -d sphinx-c-apidoc command line option -f sphinx-c-apidoc command line option -h sphinx-c-apidoc command line option -o sphinx-c-apidoc command line option -t sphinx-c-apidoc command line option

_

_children (sphinx_c_autodoc.loader.DocumentedObject attribute) _declaration (sphinx_c_autodoc.loader.DocumentedObject attribute)

_line_range (sphinx_c_autodoc.loader.DocumentedObject attribute) _soup (sphinx_c_autodoc.loader.DocumentedObject attribute)

A

a_struct_using_member_comments (C struct) a_struct_using_member_comments.first_member (C member) a_struct_using_member_comments.second_member (C member) a_typedef_type (C type) add_dll_entry_points() (in module sphinx_c_autodoc.clang.patches) add_new_methods() (in module sphinx_c_autodoc.clang.patches) add_source_listings() (in module sphinx_c_autodoc.viewcode) ALLOWED_ANONYMOUS (in module sphinx_c_autodoc.loader) analyzer (sphinx_c_autodoc.CStructDocumenter attribute) (sphinx_c_autodoc.CTypeDocumenter attribute) (sphinx_c_autodoc.CUnionDocumenter attribute) anon_example_3051923531 (C enum) anon_example_3051923531.AN_ANONYMOUSE_1 (C enumerator) anon_example_3051923531.AN_ANONYMOUSE_2 (C enumerator) args (sphinx_c_autodoc.CStructDocumenter attribute) (sphinx_c_autodoc.CTypeDocumenter attribute) (sphinx_c_autodoc.CUnionDocumenter attribute)

as_xml() (sphinx_c_autodoc.clang.comments.Comment method) ast (sphinx_c_autodoc.ViewCodeListing attribute), [1] autocdata (directive) autocenum (directive) :members: (directive option) autocenumerator (directive) autocfunction (directive) autocmacro (directive) autocmember (directive) autocmodule (directive) :members: (directive option) :private-members: (directive option) :undoc-members: (directive option) autocstruct (directive) :members: (directive option) autoctype (directive) autocunion (directive) :members: (directive option)

C

c:module (directive) can_document_member() (sphinx_c_autodoc.CDataDocumenter class method) (sphinx_c_autodoc.CModuleDocumenter class method) (sphinx_c_autodoc.CObjectDocumenter class method) CAutoDocString (class in sphinx_c_autodoc.napoleon) CDataDocumenter (class in sphinx_c_autodoc) CEnumDocumenter (class in sphinx_c_autodoc) CEnumeratorDocumenter (class in sphinx_c_autodoc) CFunctionDocumenter (class in sphinx_c_autodoc) children (sphinx_c_autodoc.loader.DocumentedObject property) (sphinx_c_autodoc.loader.DocumentedStructure property) CMacroDocumenter (class in sphinx_c_autodoc) CMemberDocumenter (class in sphinx_c_autodoc) CModule (class in sphinx_c_autodoc) CModuleDocumenter (class in sphinx_c_autodoc) CObjectDocumenter (class in sphinx_c_autodoc)

Comment (class in sphinx_c_autodoc.clang.comments) comment_node() (in module sphinx_c_autodoc.loader) comment_nodes() (in module sphinx_c_autodoc.loader) config (sphinx_c_autodoc.CStructDocumenter attribute) (sphinx_c_autodoc.CTypeDocumenter attribute) (sphinx_c_autodoc.CUnionDocumenter attribute) consolidate_members() (sphinx_c_autodoc.CTypeDocumenter method) CStructDocumenter (class in sphinx_c_autodoc) CTypeDocumenter (class in sphinx_c_autodoc) CUnionDocumenter (class in sphinx_c_autodoc) Cursor_cached_raw_comment() (in module sphinx_c_autodoc.clang.patches) Cursor_comment_extent() (in module sphinx_c_autodoc.clang.patches) Cursor_getParsedComment() (in module sphinx_c_autodoc.clang.patches) Cursor_is_macro_function_like() (in module sphinx_c_autodoc.clang.patches) Cursor_set_comment_extent() (in module sphinx_c_autodoc.clang.patches) Cursor_set_raw_comment() (in module sphinx_c_autodoc.clang.patches) Cursor_tu() (in module sphinx_c_autodoc.clang.patches)

D

declaration (sphinx_c_autodoc.loader.DocumentedObject property) directivetype (sphinx_c_autodoc.CDataDocumenter attribute) (sphinx_c_autodoc.CEnumDocumenter attribute) (sphinx_c_autodoc.CEnumeratorDocumenter attribute) (sphinx_c_autodoc.CFunctionDocumenter attribute) (sphinx_c_autodoc.CMacroDocumenter attribute) (sphinx_c_autodoc.CMemberDocumenter attribute) (sphinx_c_autodoc.CModuleDocumenter attribute) (sphinx_c_autodoc.CObjectDocumenter attribute) (sphinx_c_autodoc.CStructDocumenter attribute) (sphinx_c_autodoc.CTypeDocumenter attribute) (sphinx_c_autodoc.CUnionDocumenter attribute) doc (sphinx_c_autodoc.loader.DocumentedObject attribute) doc_links (sphinx_c_autodoc.ViewCodeListing attribute), [1] docname (sphinx_c_autodoc.viewcode.DocumentationReference attribute), [1]

doctree_read() (in module sphinx_c_autodoc.viewcode) DOCUMENTATION_COMMENT_START (in module sphinx_c_autodoc.loader) DocumentationReference (class in sphinx_c_autodoc.viewcode) DocumentedEnum (class in sphinx_c_autodoc.loader) DocumentedEnumerator (class in sphinx_c_autodoc.loader) DocumentedFile (class in sphinx_c_autodoc.loader) DocumentedFunction (class in sphinx_c_autodoc.loader) DocumentedMacro (class in sphinx_c_autodoc.loader) DocumentedMember (class in sphinx_c_autodoc.loader) DocumentedObject (class in sphinx_c_autodoc.loader) DocumentedStructure (class in sphinx_c_autodoc.loader) DocumentedType (class in sphinx_c_autodoc.loader) DocumentedUnion (class in sphinx_c_autodoc.loader) DocumentedVariable (class in sphinx_c_autodoc.loader) domain (sphinx_c_autodoc.CObjectDocumenter attribute)

E

env (sphinx_c_autodoc.CStructDocumenter attribute) (sphinx_c_autodoc.CTypeDocumenter attribute) (sphinx_c_autodoc.CUnionDocumenter attribute)

extent (sphinx_c_autodoc.loader.PsuedoToken attribute)

F

filter_members() (sphinx_c_autodoc.CObjectDocumenter method) (sphinx_c_autodoc.CStructDocumenter method) format_args() (sphinx_c_autodoc.CObjectDocumenter method) (sphinx_c_autodoc.loader.DocumentedFunction method) (sphinx_c_autodoc.loader.DocumentedMacro method) (sphinx_c_autodoc.loader.DocumentedObject method) format_name() (sphinx_c_autodoc.CObjectDocumenter method) (sphinx_c_autodoc.CTypeDocumenter method) (sphinx_c_autodoc.loader.DocumentedEnumerator method) (sphinx_c_autodoc.loader.DocumentedFunction method) (sphinx_c_autodoc.loader.DocumentedMacro method) (sphinx_c_autodoc.loader.DocumentedObject method) (sphinx_c_autodoc.loader.DocumentedVariable method)

fullname (sphinx_c_autodoc.CStructDocumenter attribute) (sphinx_c_autodoc.CTypeDocumenter attribute) (sphinx_c_autodoc.CUnionDocumenter attribute) (sphinx_c_autodoc.viewcode.DocumentationReference attribute), [1]

G

generate() (sphinx_c_autodoc.CTypeDocumenter method) get_compilation_args() (in module sphinx_c_autodoc.loader) get_compilation_database() (sphinx_c_autodoc.CObjectDocumenter method) get_default_sections() (sphinx_c_autodoc.napoleon.CAutoDocString method) get_doc() (sphinx_c_autodoc.CObjectDocumenter method) (sphinx_c_autodoc.loader.DocumentedFunction method) (sphinx_c_autodoc.loader.DocumentedObject method) get_file_comment() (in module sphinx_c_autodoc.loader) get_nested_node() (in module sphinx_c_autodoc.loader) get_object_members() (sphinx_c_autodoc.CObjectDocumenter method)

get_paragraph() (sphinx_c_autodoc.loader.DocumentedObject static method) get_parsed_declaration() (sphinx_c_autodoc.loader.DocumentedFunction method) (sphinx_c_autodoc.loader.DocumentedMacro method) (sphinx_c_autodoc.loader.DocumentedMember method) (sphinx_c_autodoc.loader.DocumentedObject method) (sphinx_c_autodoc.loader.DocumentedStructure method) (sphinx_c_autodoc.loader.DocumentedType method) (sphinx_c_autodoc.loader.DocumentedVariable method) get_soup_declaration() (sphinx_c_autodoc.loader.DocumentedObject method) get_soup_doc() (sphinx_c_autodoc.loader.DocumentedFunction method)

H

has_content (sphinx_c_autodoc.CModule attribute)

I

import_object() (sphinx_c_autodoc.CObjectDocumenter method) inline_struct_variable (C struct) inline_struct_variable.a (C member) inline_struct_variable.b (C member)

is_public() (sphinx_c_autodoc.loader.DocumentedFunction method) (sphinx_c_autodoc.loader.DocumentedMember method) (sphinx_c_autodoc.loader.DocumentedObject method) (sphinx_c_autodoc.loader.DocumentedVariable method)

L

line_range() (sphinx_c_autodoc.loader.DocumentedObject method)

load() (in module sphinx_c_autodoc.loader)

M

:members: (directive option) autocenum (directive) autocmodule (directive) autocstruct (directive) autocunion (directive) members_documented_with_napoleon (C struct) members_documented_with_napoleon.one (C member) members_documented_with_napoleon.three (C member) members_documented_with_napoleon.two (C struct) members_documented_with_napoleon.two.nested_one (C member) members_documented_with_napoleon.two.nested_two (C member) missing_reference() (in module sphinx_c_autodoc.viewcode) modname (sphinx_c_autodoc.CStructDocumenter attribute) (sphinx_c_autodoc.CTypeDocumenter attribute) (sphinx_c_autodoc.CUnionDocumenter attribute)

module sphinx_c_autodoc sphinx_c_autodoc.clang sphinx_c_autodoc.clang.comments sphinx_c_autodoc.clang.patches sphinx_c_autodoc.domains sphinx_c_autodoc.domains.c sphinx_c_autodoc.loader sphinx_c_autodoc.napoleon sphinx_c_autodoc.viewcode module (sphinx_c_autodoc.CStructDocumenter attribute) (sphinx_c_autodoc.CTypeDocumenter attribute) (sphinx_c_autodoc.CUnionDocumenter attribute) (sphinx_c_autodoc.viewcode.DocumentationReference attribute), [1] MY_COOL_MACRO (C macro) my_func (C function)

N

:noindex: (directive option) name (sphinx_c_autodoc.loader.DocumentedObject attribute)

napoleon_documented_function (C function) node (sphinx_c_autodoc.clang.comments.Comment attribute) (sphinx_c_autodoc.loader.DocumentedObject attribute)

O

object (sphinx_c_autodoc.CStructDocumenter attribute) (sphinx_c_autodoc.CTypeDocumenter attribute) (sphinx_c_autodoc.CUnionDocumenter attribute) object_from_cursor() (in module sphinx_c_autodoc.loader) object_name (sphinx_c_autodoc.CStructDocumenter attribute) (sphinx_c_autodoc.CTypeDocumenter attribute) (sphinx_c_autodoc.CUnionDocumenter attribute) object_type (sphinx_c_autodoc.CModule attribute) objpath (sphinx_c_autodoc.CStructDocumenter attribute) (sphinx_c_autodoc.CTypeDocumenter attribute) (sphinx_c_autodoc.CUnionDocumenter attribute)

objtype (sphinx_c_autodoc.CDataDocumenter attribute) (sphinx_c_autodoc.CEnumDocumenter attribute) (sphinx_c_autodoc.CEnumeratorDocumenter attribute) (sphinx_c_autodoc.CFunctionDocumenter attribute) (sphinx_c_autodoc.CMacroDocumenter attribute) (sphinx_c_autodoc.CMemberDocumenter attribute) (sphinx_c_autodoc.CModuleDocumenter attribute) (sphinx_c_autodoc.CStructDocumenter attribute) (sphinx_c_autodoc.CTypeDocumenter attribute) (sphinx_c_autodoc.CUnionDocumenter attribute) option_spec (sphinx_c_autodoc.CObjectDocumenter attribute) override_methods() (in module sphinx_c_autodoc.clang.patches)

P

:private-members: (directive option) autocmodule (directive) parent (sphinx_c_autodoc.CStructDocumenter attribute) (sphinx_c_autodoc.CTypeDocumenter attribute) (sphinx_c_autodoc.CUnionDocumenter attribute) parse_comment() (in module sphinx_c_autodoc.loader)

parse_name() (sphinx_c_autodoc.CObjectDocumenter method) patch_c_domain() (in module sphinx_c_autodoc.domains.c) patch_clang() (in module sphinx_c_autodoc.clang.patches) priority (sphinx_c_autodoc.CObjectDocumenter attribute) process_autodoc_docstring() (in module sphinx_c_autodoc.napoleon) PsuedoToken (class in sphinx_c_autodoc.loader)

R

raw_listing (sphinx_c_autodoc.ViewCodeListing attribute), [1] required_arguments (sphinx_c_autodoc.CModule attribute) resolve_name() (sphinx_c_autodoc.CObjectDocumenter method)

retann (sphinx_c_autodoc.CStructDocumenter attribute) (sphinx_c_autodoc.CTypeDocumenter attribute) (sphinx_c_autodoc.CUnionDocumenter attribute) run() (sphinx_c_autodoc.CModule method)

S

setup() (in module sphinx_c_autodoc) (in module sphinx_c_autodoc.napoleon) (in module sphinx_c_autodoc.viewcode) some_enum (C enum) some_enum.THE_FIRST_ENUM (C enumerator) some_enum.THE_LAST_ENUM (C enumerator) some_enum.THE_SECOND_ENUM (C enumerator) some_enum.THE_THIRD_ENUM (C enumerator) some_flag_variable (C var) soup (sphinx_c_autodoc.loader.DocumentedObject property) (sphinx_c_autodoc.loader.DocumentedStructure property) source_path sphinx-c-apidoc command line option SourceLocation_isFromMainFile() (in module sphinx_c_autodoc.clang.patches) spelling (sphinx_c_autodoc.loader.PsuedoToken attribute) sphinx-c-apidoc command line option --force --header-ext --help --output-path --source-ext --templatedir --tocfile -d -f -h -o -t source_path

sphinx_c_autodoc module sphinx_c_autodoc.clang module sphinx_c_autodoc.clang.comments module sphinx_c_autodoc.clang.patches module sphinx_c_autodoc.domains module sphinx_c_autodoc.domains.c module sphinx_c_autodoc.loader module sphinx_c_autodoc.napoleon module sphinx_c_autodoc.viewcode module

T

TOO_SIMPLE (C macro) TRAILING_COMMENT_START (in module sphinx_c_autodoc.loader) tu (sphinx_c_autodoc.clang.comments.Comment attribute) type (sphinx_c_autodoc.loader.DocumentedObject property) type_ (sphinx_c_autodoc.loader.DocumentedEnum attribute) (sphinx_c_autodoc.loader.DocumentedEnumerator attribute) (sphinx_c_autodoc.loader.DocumentedFile attribute) (sphinx_c_autodoc.loader.DocumentedFunction attribute) (sphinx_c_autodoc.loader.DocumentedMacro attribute) (sphinx_c_autodoc.loader.DocumentedMember attribute) (sphinx_c_autodoc.loader.DocumentedObject attribute), [1] (sphinx_c_autodoc.loader.DocumentedStructure attribute) (sphinx_c_autodoc.loader.DocumentedType attribute) (sphinx_c_autodoc.loader.DocumentedUnion attribute) (sphinx_c_autodoc.loader.DocumentedVariable attribute)

U

:undoc-members: (directive option) autocmodule (directive)

UNDOCUMENTED_NODES (in module sphinx_c_autodoc.loader)

V

ViewCodeListing (class in sphinx_c_autodoc)