sphinx.domains.cpp.CPPObject

class documentation

class CPPObject(ObjectDescription[ASTDeclaration]):

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​_enumerator​_to​_parent Undocumented
Method add​_target​_and​_index Undocumented
Method after​_content Undocumented
Method before​_content Undocumented
Method describe​_signature Undocumented
Method get​_index​_text Undocumented
Method handle​_signature Undocumented
Method parse​_definition Undocumented
Method run Undocumented
Class Variable doc​_field​_types Undocumented
Class Variable option​_spec Undocumented
Instance Variable old​Parent​Key Undocumented
Instance Variable old​Parent​Symbol Undocumented
Property display​_object​_type Undocumented
Property object​_type Undocumented
def _add_enumerator_to_parent(self, ast):

Undocumented

Parameters
ast:ASTDeclarationUndocumented
def add_target_and_index(self, ast, sig, signode):

Undocumented

Parameters
ast:ASTDeclarationUndocumented
sig:strUndocumented
signode:TextElementUndocumented
def after_content(self):

Undocumented

def before_content(self):

Undocumented

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

Undocumented

Parameters
signode:desc_signatureUndocumented
ast:ASTDeclarationUndocumented
options:DictUndocumented
def get_index_text(self, name):

Undocumented

Parameters
name:strUndocumented
Returns
strUndocumented
def handle_signature(self, sig, signode):

Undocumented

Parameters
sig:strUndocumented
signode:desc_signatureUndocumented
Returns
ASTDeclarationUndocumented
def parse_definition(self, parser):

Undocumented

Parameters
parser:DefinitionParserUndocumented
Returns
ASTDeclarationUndocumented
def run(self):

Undocumented

Returns
List[Node]Undocumented
doc_field_types: List[Field] =
overridden in sphinx.domains.cpp.CPPFunctionObject

Undocumented

option_spec: OptionSpec =

Undocumented

oldParentKey: LookupKey =

Undocumented

oldParentSymbol =

Undocumented

@property
display_object_type: str =
overridden in sphinx.domains.cpp.CPPClassObject

Undocumented

@property
object_type: str =
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