sphinx.domains.cpp.CPPObject

class documentation

class CPPObject(ObjectDescription[ASTDeclaration]): (source)

Known subclasses: sphinx.domains.cpp.CPPClassObject, sphinx.domains.cpp.CPPConceptObject, sphinx.domains.cpp.CPPEnumeratorObject, sphinx.domains.cpp.CPPEnumObject, sphinx.domains.cpp.CPPFunctionObject, sphinx.domains.cpp.CPPMemberObject, sphinx.domains.cpp.CPPTypeObject, sphinx.domains.cpp.CPPUnionObject

View In Hierarchy

Description of a C++ language object.

Method	`add_target_and_index`	Add cross-reference IDs and entries to self.indexnode, if applicable.
Method	`after_content`	Called after parsing content. Used to reset information about the current directive context on the build environment.
Method	`before_content`	Called before parsing content. Used to set information about the current directive context on the build environment.
Method	`describe_signature`	Undocumented
Method	`get_index_text`	Undocumented
Method	`handle_signature`	Parse the signature sig into individual nodes and append them to signode. If ValueError is raised, parsing is aborted and the whole sig is put into a single desc_name node.
Method	`parse_definition`	Undocumented
Method	`run`	Main directive entry function, called by docutils upon encountering the directive.
Class Variable	`doc_field_types`	Undocumented
Class Variable	`option_spec`	Undocumented
Instance Variable	`oldParentKey`	Undocumented
Instance Variable	`oldParentSymbol`	Undocumented
Property	`display_object_type`	Undocumented
Property	`object_type`	Undocumented
Method	`_add_enumerator_to_parent`	Undocumented

Inherited from ObjectDescription:

Method	`get_field_type_map`	Undocumented
Method	`get_signatures`	Retrieve the signatures to document from the directive arguments. By default, signatures are given as arguments, one per line.
Method	`transform_content`	Called after creating the content through nested parsing, but before the ``object-description-transform`` event is emitted, and before the info-fields are transformed. Can be used to manipulate the content.
Class Variable	`final_argument_whitespace`	Undocumented
Class Variable	`has_content`	Undocumented
Class Variable	`optional_arguments`	Undocumented
Class Variable	`required_arguments`	Undocumented
Instance Variable	`domain`	Undocumented
Instance Variable	`indexnode`	Undocumented
Instance Variable	`names`	Undocumented
Instance Variable	`objtype`	Undocumented
Method	`_object_hierarchy_parts`	Returns a tuple of strings, one entry for each part of the object's hierarchy (e.g. ``('module', 'submodule', 'Class', 'method')``). The returned tuple is used to properly nest children within parents in the table of contents, and can also be used within the :py:meth:`_toc_entry_name` method.
Method	`_toc_entry_name`	Returns the text of the table of contents entry for the object.
Instance Variable	`_doc_field_type_map`	Undocumented

Inherited from SphinxDirective (via ObjectDescription):

Method	`get_location`	Get current location info for logging.
Method	`get_source_info`	Get source and line number.
Method	`set_source_info`	Set source and line number to the node.
Property	`config`	Reference to the :class:`.Config` object.
Property	`env`	Reference to the :class:`.BuildEnvironment` object.

def add_target_and_index(self, ast, sig, signode): (source) ¶

overrides sphinx.directives.ObjectDescription.add_target_and_index

Add cross-reference IDs and entries to self.indexnode, if applicable. *name* is whatever :meth:`handle_signature()` returned.

Parameters
ast:`ASTDeclaration`	Undocumented
sig:`str`	Undocumented
signode:`TextElement`	Undocumented

def after_content(self): (source) ¶

overrides sphinx.directives.ObjectDescription.after_content

Called after parsing content. Used to reset information about the current directive context on the build environment.

def before_content(self): (source) ¶

overrides sphinx.directives.ObjectDescription.before_content

Called before parsing content. Used to set information about the current directive context on the build environment.

def describe_signature(self, signode, ast, options): (source) ¶

Undocumented

Parameters
signode:`desc_signature`	Undocumented
ast:`ASTDeclaration`	Undocumented
options:`dict`	Undocumented

def get_index_text(self, name): (source) ¶

Undocumented

Parameters
name:`str`	Undocumented
Returns
`str`	Undocumented

def handle_signature(self, sig, signode): (source) ¶

overrides sphinx.directives.ObjectDescription.handle_signature

Parse the signature *sig* into individual nodes and append them to *signode*. If ValueError is raised, parsing is aborted and the whole *sig* is put into a single desc_name node. The return value should be a value that identifies the object. It is passed to :meth:`add_target_and_index()` unchanged, and otherwise only used to skip duplicates.

Parameters
sig:`str`	Undocumented
signode:`desc_signature`	Undocumented
Returns
`ASTDeclaration`	Undocumented

def parse_definition(self, parser): (source) ¶

Undocumented

Parameters
parser:`DefinitionParser`	Undocumented
Returns
`ASTDeclaration`	Undocumented

def run(self): (source) ¶

overrides sphinx.directives.ObjectDescription.run

Main directive entry function, called by docutils upon encountering the directive. This directive is meant to be quite easily subclassable, so it delegates to several additional methods. What it does: * find out if called as a domain-specific directive, set self.domain * create a `desc` node to fit all description inside * parse standard options, currently `noindex` * create an index node if needed as self.indexnode * parse all given signatures (as returned by self.get_signatures()) using self.handle_signature(), which should either return a name or raise ValueError * add index entries using self.add_target_and_index() * parse the content and handle doc fields in it

Returns
`list[Node]`	Undocumented

doc_field_types: list[Field] = (source) ¶

overrides sphinx.directives.ObjectDescription.doc_field_types

overridden in sphinx.domains.cpp.CPPFunctionObject

Undocumented

option_spec: OptionSpec = (source) ¶

overrides sphinx.directives.ObjectDescription.option_spec

Undocumented

oldParentKey: LookupKey = (source) ¶

Undocumented

oldParentSymbol = (source) ¶

Undocumented

@property
display_object_type: str = (source) ¶

overridden in sphinx.domains.cpp.CPPClassObject

Undocumented

@property
object_type: str = (source) ¶

overridden in sphinx.domains.cpp.CPPClassObject, sphinx.domains.cpp.CPPConceptObject, sphinx.domains.cpp.CPPEnumeratorObject, sphinx.domains.cpp.CPPEnumObject, sphinx.domains.cpp.CPPFunctionObject, sphinx.domains.cpp.CPPMemberObject, sphinx.domains.cpp.CPPTypeObject, sphinx.domains.cpp.CPPUnionObject

Undocumented

def _add_enumerator_to_parent(self, ast): (source) ¶

Undocumented

Parameters
ast:`ASTDeclaration`	Undocumented