griffe_typedoc ¤

Bases: Reflection

A property accessor with getter and setter signatures.

Attributes:

• children (list[Reflection]) –

  Child reflections.

• comment (Comment | None) –

  Documentation comment associated with the reflection.

• final_target (Reflection) –

  Final reflection reached by following reference targets.

• flags (dict) –

  Reflection flags recorded by TypeDoc.

• get_signature (GetSignature | None) –

  Getter signature of the accessor.

• groups (list[Group]) –

  Named groups of child reflections.

• id (int) –

  Unique reflection ID within the project.

• implementation_of (Type | None) –

  Reference to the declaration that this reflection implements.

• inherited_from (Type | None) –

  Reference to the declaration that this reflection inherits.

• kind (ReflectionKind) –

  Kind of the reflection.

• name (str) –

  Name of the reflection.

• overwrites (Type | None) –

  Reference to the declaration that this reflection overrides.

• parent (Reflection | None) –

  Parent reflection, or None for a root reflection.

• path (str) –

  Slash-separated symbol path, with index modules omitted.

• resolved_groups (list[Group]) –

  Groups with child IDs replaced by their reflections.

• resolved_target (Reflection) –

  Referenced reflection resolved through the symbol map.

• root (Reflection) –

  The root ancestor of the reflection tree.

• root_module (Reflection) –

  The highest ancestor below the project, or this reflection if it has no parent.

• set_signature (SetSignature | None) –

  Setter signature of the accessor.

• source_contents (str) –

  Source lines joined together, with trailing whitespace and an opening brace removed.

• sources (list[Source]) –

  Source locations of the reflection.

• symbol_map (dict[int, Reflection]) –

  Reflections indexed by ID, inherited from the parent when available.

• type (Type | None) –

  Type associated with the reflection.

• variant (str) –

  Reflection variant recorded by TypeDoc.

children: list[Reflection] = field(default_factory=list)

comment: Comment | None = None

final_target: Reflection

flags: dict = field(default_factory=dict)

get_signature: GetSignature | None = None

groups: list[Group] = field(default_factory=list)

id: int

implementation_of: Type | None = None

inherited_from: Type | None = None

kind: ReflectionKind

name: str

overwrites: Type | None = None

parent: Reflection | None = None

path: str

resolved_groups: list[Group]

resolved_target: Reflection

root: Reflection

root_module: Reflection

set_signature: SetSignature | None = None

source_contents: str

sources: list[Source] = field(default_factory=list)

symbol_map: dict[int, Reflection]

type: Type | None = None

variant: str

A comment tag and its content.

Methods:

• markdown –

  Render tag content as Markdown.

Attributes:

• content (list[BlockTagContent]) –

  Content segments of the tag.

• kind (BlockTagKind) –

  Kind of comment tag.

content: list[BlockTagContent]

kind: BlockTagKind

markdown(**kwargs: Any) -> str

336
337
338
339
340
341
342
343
344
345

def markdown(self, **kwargs: Any) -> str:
    """Render tag content as Markdown.

    Parameters:
        **kwargs: Keyword arguments passed to each content segment's `markdown` method.

    Returns:
        The rendered content segments joined together.
    """
    return "".join(block.markdown(**kwargs) for block in self.summary)  # ty:ignore[unresolved-attribute]

A text, code, or inline tag segment in a comment.

Methods:

• markdown –

  Render the content segment as Markdown.

Attributes:

• kind (BlockTagContentKind) –

  Kind of comment content.

• target (int | str | None) –

  Reflection ID or URL targeted by an inline link.

• text (str) –

  Text of the content segment.

• ts_link_text (str | None) –

  Link text supplied in the TypeScript comment.

kind: BlockTagContentKind

target: int | str | None = None

text: str

ts_link_text: str | None = None

markdown(
    symbol_map: dict[int, Reflection] | None = None,
) -> str

308
309
310
311
312
313
314
315
316
317
318
319
320
321

def markdown(self, symbol_map: dict[int, Reflection] | None = None) -> str:
    """Render the content segment as Markdown.

    Parameters:
        symbol_map: Reflections indexed by ID, used to resolve internal links.

    Returns:
        Text, a Markdown link, or an autoref element for a resolved internal link.
    """
    if self.target:
        if isinstance(self.target, int) and symbol_map:
            return f'<autoref identifier="{symbol_map[self.target].path}">{self.text}</autoref>'
        return f"[{self.text}]({self.target})"
    return self.text

Bases: Enum

Kinds of content in a TypeDoc comment.

Attributes:

• CODE –

  Code content.

• INLINE_TAG –

  An inline comment tag.

• TEXT –

  Plain text content.

CODE = 'code'

INLINE_TAG = 'inline-tag'

TEXT = 'text'

Bases: Enum

Tags supported in TypeDoc comments.

Attributes:

• ALPHA –

  The @alpha comment tag.

• BETA –

  The @beta comment tag.

• CATEGORY –

  The @category comment tag.

• DEFAULT_VALUE –

  The @defaultValue comment tag.

• DEPRECATED –

  The @deprecated comment tag.

• ENUM –

  The @enum comment tag.

• EVENT –

  The @event comment tag.

• EVENT_PROPERTY –

  The @eventProperty comment tag.

• EXAMPLE –

  The @example comment tag.

• EXPERIMENTAL –

  The @experimental comment tag.

• GROUP –

  The @group comment tag.

• HIDDEN –

  The @hidden comment tag.

• IGNORE –

  The @ignore comment tag.

• INHERIT_DOC –

  The @inheritDoc comment tag.

• INTERFACE –

  The @interface comment tag.

• INTERNAL –

  The @internal comment tag.

• LABEL –

  The @label comment tag.

• LINK –

  The @link comment tag.

• MODULE –

  The @module comment tag.

• NAMESPACE –

  The @namespace comment tag.

• OVERLOAD –

  The @overload comment tag.

• OVERRIDE –

  The @override comment tag.

• PACKAGE_DOCUMENTATION –

  The @packageDocumentation comment tag.

• PARAM –

  The @param comment tag.

• PRIVATE –

  The @private comment tag.

• PRIVATE_REMARKS –

  The @privateRemarks comment tag.

• PROPERTY –

  The @property comment tag.

• PROTECTED –

  The @protected comment tag.

• PUBLIC –

  The @public comment tag.

• READONLY –

  The @readonly comment tag.

• REMARKS –

  The @remarks comment tag.

• RETURNS –

  The @returns comment tag.

• SATISFIES –

  The @satisfies comment tag.

• SEALED –

  The @sealed comment tag.

• SEE –

  The @see comment tag.

• TEMPLATE –

  The @template comment tag.

• THROWS –

  The @throws comment tag.

• TYPE_PARAM –

  The @typeParam comment tag.

• VIRTUAL –

  The @virtual comment tag.

ALPHA = '@alpha'

BETA = '@beta'

CATEGORY = '@category'

DEFAULT_VALUE = '@defaultValue'

DEPRECATED = '@deprecated'

ENUM = '@enum'

EVENT = '@event'

EVENT_PROPERTY = '@eventProperty'

EXAMPLE = '@example'

EXPERIMENTAL = '@experimental'

GROUP = '@group'

HIDDEN = '@hidden'

IGNORE = '@ignore'

INHERIT_DOC = '@inheritDoc'

INTERFACE = '@interface'

INTERNAL = '@internal'

LABEL = '@label'

LINK = '@link'

MODULE = '@module'

NAMESPACE = '@namespace'

OVERLOAD = '@overload'

OVERRIDE = '@override'

PACKAGE_DOCUMENTATION = '@packageDocumentation'

PARAM = '@param'

PRIVATE = '@private'

PRIVATE_REMARKS = '@privateRemarks'

PROPERTY = '@property'

PROTECTED = '@protected'

PUBLIC = '@public'

READONLY = '@readonly'

REMARKS = '@remarks'

RETURNS = '@returns'

SATISFIES = '@satisfies'

SEALED = '@sealed'

SEE = '@see'

TEMPLATE = '@template'

THROWS = '@throws'

TYPE_PARAM = '@typeParam'

VIRTUAL = '@virtual'

Bases: Reflection

A callable signature with its parameters and return type.

Attributes:

• children (list[Reflection]) –

  Child reflections.

• comment (Comment | None) –

  Documentation comment associated with the reflection.

• final_target (Reflection) –

  Final reflection reached by following reference targets.

• flags (dict) –

  Reflection flags recorded by TypeDoc.

• groups (list[Group]) –

  Named groups of child reflections.

• id (int) –

  Unique reflection ID within the project.

• implementation_of (Type | None) –

  Reference to the declaration that this reflection implements.

• inherited_from (Type | None) –

  Reference to the declaration that this reflection inherits.

• kind (ReflectionKind) –

  Kind of the reflection.

• name (str) –

  Name of the reflection.

• overwrites (Type | None) –

  Reference to the declaration that this reflection overrides.

• parameters (list[Parameter] | None) –

  Parameters of the signature.

• parent (Reflection | None) –

  Parent reflection, or None for a root reflection.

• path (str) –

  Slash-separated symbol path, with index modules omitted.

• resolved_groups (list[Group]) –

  Groups with child IDs replaced by their reflections.

• resolved_target (Reflection) –

  Referenced reflection resolved through the symbol map.

• root (Reflection) –

  The root ancestor of the reflection tree.

• root_module (Reflection) –

  The highest ancestor below the project, or this reflection if it has no parent.

• source_contents (str) –

  Source lines joined together, with trailing whitespace and an opening brace removed.

• sources (list[Source]) –

  Source locations of the reflection.

• symbol_map (dict[int, Reflection]) –

  Reflections indexed by ID, inherited from the parent when available.

• type (Type) –

  Return type of the signature.

• type_parameters (list[TypeParameter] | None) –

  Generic type parameters of the declaration.

• variant (str) –

  Reflection variant recorded by TypeDoc.

children: list[Reflection] = field(default_factory=list)

comment: Comment | None = None

final_target: Reflection

flags: dict = field(default_factory=dict)

groups: list[Group] = field(default_factory=list)

id: int

implementation_of: Type | None = None

inherited_from: Type | None = None

kind: ReflectionKind

name: str

overwrites: Type | None = None

parameters: list[Parameter] | None = None

parent: Reflection | None = None

path: str

resolved_groups: list[Group]

resolved_target: Reflection

root: Reflection

root_module: Reflection

source_contents: str

sources: list[Source] = field(default_factory=list)

symbol_map: dict[int, Reflection]

type: Type

type_parameters: list[TypeParameter] | None = None

variant: str

Bases: Reflection

A TypeScript class reflection.

Attributes:

• children (list[Reflection]) –

  Child reflections.

• comment (Comment | None) –

  Documentation comment associated with the reflection.

• extended_by (list[Type] | None) –

  Types that extend the declaration.

• extended_types (list[Type] | None) –

  Types extended by the declaration.

• final_target (Reflection) –

  Final reflection reached by following reference targets.

• flags (dict) –

  Reflection flags recorded by TypeDoc.

• groups (list[Group]) –

  Named groups of child reflections.

• id (int) –

  Unique reflection ID within the project.

• implemented_types (list[Type] | None) –

  Interfaces implemented by the class.

• index_signatures (list[IndexSignature] | None) –

  Index signatures of the declaration.

• kind (ReflectionKind) –

  Kind of the reflection.

• name (str) –

  Name of the reflection.

• parent (Reflection | None) –

  Parent reflection, or None for a root reflection.

• path (str) –

  Slash-separated symbol path, with index modules omitted.

• resolved_groups (list[Group]) –

  Groups with child IDs replaced by their reflections.

• resolved_target (Reflection) –

  Referenced reflection resolved through the symbol map.

• root (Reflection) –

  The root ancestor of the reflection tree.

• root_module (Reflection) –

  The highest ancestor below the project, or this reflection if it has no parent.

• source_contents (str) –

  Source lines joined together, with trailing whitespace and an opening brace removed.

• sources (list[Source]) –

  Source locations of the reflection.

• symbol_map (dict[int, Reflection]) –

  Reflections indexed by ID, inherited from the parent when available.

• type (Type | None) –

  Type associated with the reflection.

• type_parameters (list[TypeParameter] | None) –

  Generic type parameters of the declaration.

• variant (str) –

  Reflection variant recorded by TypeDoc.

children: list[Reflection] = field(default_factory=list)

comment: Comment | None = None

extended_by: list[Type] | None = None

extended_types: list[Type] | None = None

final_target: Reflection

flags: dict = field(default_factory=dict)

groups: list[Group] = field(default_factory=list)

id: int

implemented_types: list[Type] | None = None

index_signatures: list[IndexSignature] | None = None

kind: ReflectionKind

name: str

parent: Reflection | None = None

path: str

resolved_groups: list[Group]

resolved_target: Reflection

root: Reflection

root_module: Reflection

source_contents: str

sources: list[Source] = field(default_factory=list)

symbol_map: dict[int, Reflection]

type: Type | None = None

type_parameters: list[TypeParameter] | None = None

variant: str

A TypeDoc comment with a summary and optional tags.

Methods:

• markdown –

  Render the comment summary as Markdown.

Attributes:

• block_tags (list[BlockTag] | None) –

  Block tags associated with the comment.

• summary (list[BlockTagContent]) –

  Content segments of the comment summary.

• tags (list[BlockTag] | None) –

  Tags associated with the comment.

block_tags: list[BlockTag] | None = None

summary: list[BlockTagContent]

tags: list[BlockTag] | None = None

markdown(**kwargs: Any) -> str

362
363
364
365
366
367
368
369
370
371

def markdown(self, **kwargs: Any) -> str:
    """Render the comment summary as Markdown.

    Parameters:
        **kwargs: Keyword arguments passed to each content segment's `markdown` method.

    Returns:
        The rendered summary segments joined together.
    """
    return "".join(block.markdown(**kwargs) for block in self.summary)

Bases: Reflection

A constructor and its signatures.

Attributes:

• children (list[Reflection]) –

  Child reflections.

• comment (Comment | None) –

  Documentation comment associated with the reflection.

• final_target (Reflection) –

  Final reflection reached by following reference targets.

• flags (dict) –

  Reflection flags recorded by TypeDoc.

• groups (list[Group]) –

  Named groups of child reflections.

• id (int) –

  Unique reflection ID within the project.

• inherited_from (Type | None) –

  Reference to the declaration that this reflection inherits.

• kind (ReflectionKind) –

  Kind of the reflection.

• name (str) –

  Name of the reflection.

• overwrites (Type | None) –

  Reference to the declaration that this reflection overrides.

• parent (Reflection | None) –

  Parent reflection, or None for a root reflection.

• path (str) –

  Slash-separated symbol path, with index modules omitted.

• resolved_groups (list[Group]) –

  Groups with child IDs replaced by their reflections.

• resolved_target (Reflection) –

  Referenced reflection resolved through the symbol map.

• root (Reflection) –

  The root ancestor of the reflection tree.

• root_module (Reflection) –

  The highest ancestor below the project, or this reflection if it has no parent.

• signatures (list[ConstructorSignature] | None) –

  Callable signatures of the reflection.

• source_contents (str) –

  Source lines joined together, with trailing whitespace and an opening brace removed.

• sources (list[Source]) –

  Source locations of the reflection.

• symbol_map (dict[int, Reflection]) –

  Reflections indexed by ID, inherited from the parent when available.

• type (Type | None) –

  Type associated with the reflection.

• variant (str) –

  Reflection variant recorded by TypeDoc.

children: list[Reflection] = field(default_factory=list)

comment: Comment | None = None

final_target: Reflection

flags: dict = field(default_factory=dict)

groups: list[Group] = field(default_factory=list)

id: int

inherited_from: Type | None = None

kind: ReflectionKind

name: str

overwrites: Type | None = None

parent: Reflection | None = None

path: str

resolved_groups: list[Group]

resolved_target: Reflection

root: Reflection

root_module: Reflection

signatures: list[ConstructorSignature] | None = None

source_contents: str

sources: list[Source] = field(default_factory=list)

symbol_map: dict[int, Reflection]

type: Type | None = None

variant: str

Bases: Reflection

A constructor signature with its parameters.

Attributes:

• children (list[Reflection]) –

  Child reflections.

• comment (Comment | None) –

  Documentation comment associated with the reflection.

• final_target (Reflection) –

  Final reflection reached by following reference targets.

• flags (dict) –

  Reflection flags recorded by TypeDoc.

• groups (list[Group]) –

  Named groups of child reflections.

• id (int) –

  Unique reflection ID within the project.

• inherited_from (Type | None) –

  Reference to the declaration that this reflection inherits.

• kind (ReflectionKind) –

  Kind of the reflection.

• name (str) –

  Name of the reflection.

• overwrites (Type | None) –

  Reference to the declaration that this reflection overrides.

• parameters (list[Parameter] | None) –

  Parameters of the signature.

• parent (Reflection | None) –

  Parent reflection, or None for a root reflection.

• path (str) –

  Slash-separated symbol path, with index modules omitted.

• resolved_groups (list[Group]) –

  Groups with child IDs replaced by their reflections.

• resolved_target (Reflection) –

  Referenced reflection resolved through the symbol map.

• root (Reflection) –

  The root ancestor of the reflection tree.

• root_module (Reflection) –

  The highest ancestor below the project, or this reflection if it has no parent.

• source_contents (str) –

  Source lines joined together, with trailing whitespace and an opening brace removed.

• sources (list[Source]) –

  Source locations of the reflection.

• symbol_map (dict[int, Reflection]) –

  Reflections indexed by ID, inherited from the parent when available.

• type (Type | None) –

  Type associated with the reflection.

• type_parameters (list[TypeParameter] | None) –

  Generic type parameters of the declaration.

• variant (str) –

  Reflection variant recorded by TypeDoc.

children: list[Reflection] = field(default_factory=list)

comment: Comment | None = None

final_target: Reflection

flags: dict = field(default_factory=dict)

groups: list[Group] = field(default_factory=list)

id: int

inherited_from: Type | None = None

kind: ReflectionKind

name: str

overwrites: Type | None = None

parameters: list[Parameter] | None = None

parent: Reflection | None = None

path: str

resolved_groups: list[Group]

resolved_target: Reflection

root: Reflection

root_module: Reflection

source_contents: str

sources: list[Source] = field(default_factory=list)

symbol_map: dict[int, Reflection]

type: Type | None = None

type_parameters: list[TypeParameter] | None = None

variant: str

Bases: Reflection

A TypeScript enum reflection.

Attributes:

• children (list[Reflection]) –

  Child reflections.

• comment (Comment | None) –

  Documentation comment associated with the reflection.

• final_target (Reflection) –

  Final reflection reached by following reference targets.

• flags (dict) –

  Reflection flags recorded by TypeDoc.

• groups (list[Group]) –

  Named groups of child reflections.

• id (int) –

  Unique reflection ID within the project.

• kind (ReflectionKind) –

  Kind of the reflection.

• name (str) –

  Name of the reflection.

• parent (Reflection | None) –

  Parent reflection, or None for a root reflection.

• path (str) –

  Slash-separated symbol path, with index modules omitted.

• resolved_groups (list[Group]) –

  Groups with child IDs replaced by their reflections.

• resolved_target (Reflection) –

  Referenced reflection resolved through the symbol map.

• root (Reflection) –

  The root ancestor of the reflection tree.

• root_module (Reflection) –

  The highest ancestor below the project, or this reflection if it has no parent.

• source_contents (str) –

  Source lines joined together, with trailing whitespace and an opening brace removed.

• sources (list[Source]) –

  Source locations of the reflection.

• symbol_map (dict[int, Reflection]) –

  Reflections indexed by ID, inherited from the parent when available.

• type (Type | None) –

  Type associated with the reflection.

• variant (str) –

  Reflection variant recorded by TypeDoc.

children: list[Reflection] = field(default_factory=list)

comment: Comment | None = None

final_target: Reflection

flags: dict = field(default_factory=dict)

groups: list[Group] = field(default_factory=list)

id: int

kind: ReflectionKind

name: str

parent: Reflection | None = None

path: str

resolved_groups: list[Group]

resolved_target: Reflection

root: Reflection

root_module: Reflection

source_contents: str

sources: list[Source] = field(default_factory=list)