sphinx.domains.cpp.ASTDeclaration

class documentation

class ASTDeclaration(ASTBase): (source)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method clone Undocumented
Method describe_signature Undocumented
Method get_id Undocumented
Method get_newest_id Undocumented
Instance Variable declaration Undocumented
Instance Variable directiveType Undocumented
Instance Variable enumeratorScopedSymbol Undocumented
Instance Variable objectType Undocumented
Instance Variable semicolon Undocumented
Instance Variable symbol Undocumented
Instance Variable templatePrefix Undocumented
Instance Variable trailingRequiresClause Undocumented
Instance Variable visibility Undocumented
Property function_params Undocumented
Property name Undocumented
Method _stringify Undocumented

Inherited from ASTBaseBase (via ASTBase):

Method __eq__ Undocumented
Method __repr__ Undocumented
Method __str__ Undocumented
Method get_display_string Undocumented
Class Variable __hash__ Undocumented
def __init__(self, objectType, directiveType=None, visibility=None, templatePrefix=None, declaration=None, trailingRequiresClause=None, semicolon=False): (source)

Undocumented

Parameters
objectType:strUndocumented
directiveType:str|NoneUndocumented
visibility:str|NoneUndocumented
templatePrefix:ASTTemplateDeclarationPrefix|NoneUndocumented
declaration:AnyUndocumented
trailingRequiresClause:ASTRequiresClause|NoneUndocumented
semicolon:boolUndocumented
def clone(self): (source)
overrides sphinx.util.cfamily.ASTBaseBase.clone

Undocumented

Returns
ASTDeclarationUndocumented
def describe_signature(self, signode, mode, env, options): (source)

Undocumented

Parameters
signode:desc_signatureUndocumented
mode:strUndocumented
env:BuildEnvironmentUndocumented
options:dictUndocumented
def get_id(self, version, prefixed=True): (source)

Undocumented

Parameters
version:intUndocumented
prefixed:boolUndocumented
Returns
strUndocumented
def get_newest_id(self): (source)

Undocumented

Returns
strUndocumented
declaration = (source)

Undocumented

directiveType = (source)

Undocumented

enumeratorScopedSymbol: Symbol = (source)

Undocumented

objectType = (source)

Undocumented

semicolon = (source)

Undocumented

symbol: Symbol = (source)

Undocumented

templatePrefix = (source)

Undocumented

trailingRequiresClause = (source)

Undocumented

visibility = (source)

Undocumented

@property
function_params: list[ASTFunctionParameter] = (source)

Undocumented

@property
name: ASTNestedName = (source)

Undocumented

def _stringify(self, transform): (source)
overrides sphinx.util.cfamily.ASTBaseBase._stringify

Undocumented

Parameters
transform:StringifyTransformUndocumented
Returns
strUndocumented