sphinx.domains.c.CObject

class documentation

class CObject(ObjectDescription[ASTDeclaration]):

Known subclasses: sphinx.domains.c.CEnumeratorObject, sphinx.domains.c.CEnumObject, sphinx.domains.c.CFunctionObject, sphinx.domains.c.CMacroObject, sphinx.domains.c.CMemberObject, sphinx.domains.c.CStructObject, sphinx.domains.c.CTypeObject, sphinx.domains.c.CUnionObject

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	`make_old_id`	Generate old styled node_id for C objects.
Method	`parse_definition`	Undocumented
Method	`parse_pre_v3_type_definition`	Undocumented
Method	`run`	Undocumented
Class Variable	`option_spec`	Undocumented
Instance Variable	`object_type`	Undocumented
Instance Variable	`oldParentKey`	Undocumented
Instance Variable	`oldParentSymbol`	Undocumented
Property	`display_object_type`	Undocumented

def _add_enumerator_to_parent(self, ast):

Undocumented

Parameters
ast:`ASTDeclaration`	Undocumented

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

Undocumented

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

def after_content(self):

Undocumented

def before_content(self):

Undocumented

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

Undocumented

Parameters
signode:`TextElement`	Undocumented
ast:`ASTDeclaration`	Undocumented
options:`Dict`	Undocumented

def get_index_text(self, name):

Undocumented

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

def handle_signature(self, sig, signode):

Undocumented

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

def make_old_id(self, name):

Generate old styled node_id for C objects.

Note

Old Styled node_id was used until Sphinx-3.0. This will be removed in Sphinx-5.0.

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

def parse_definition(self, parser):

Undocumented

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

def parse_pre_v3_type_definition(self, parser):

Undocumented

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

def run(self):

Undocumented

Returns
`List[Node]`	Undocumented

option_spec: OptionSpec =

Undocumented

@property
object_type =

overridden in sphinx.domains.c.CEnumeratorObject, sphinx.domains.c.CEnumObject, sphinx.domains.c.CFunctionObject, sphinx.domains.c.CMacroObject, sphinx.domains.c.CMemberObject, sphinx.domains.c.CStructObject, sphinx.domains.c.CTypeObject, sphinx.domains.c.CUnionObject

Undocumented

oldParentKey: LookupKey =

Undocumented

oldParentSymbol =

Undocumented

@property
display_object_type: str =

overridden in sphinx.domains.c.CMemberObject

Undocumented