DoxySummaryEntry

class sphinx_doxysummary.generate.DoxySummaryEntry(filename: str, name: str, template: str = 'cppbase.rst', toctree: str = '', scope: str = '', alias: str | None = None)

Simple class representing an entry in “doxysummary” directive.

filename

Name of rst file source.

Type:: str

toctree

Directory in which the rst file will be generated.

Type:: str

template

Name of the template for generating rst file. Default is the template cppbase.rst in installation directory of this package.

Type:: str

name

Content of the entry. If the entry is a function, the return type is removed. Only the function name and the arguments are retained.

Type:: str

scope

Scope of the name. The true name in Doxygen XML of the item is “scope::name”.

Type:: str

alias

Alias of the entry. If there is an alias, the displayname and the title of the generated file are the alias.

Type:: str

__init__(filename: str, name: str, template: str = 'cppbase.rst', toctree: str = '', scope: str = '', alias: str | None = None)

Parameters:

filename (str) – Name of the rst file containing the entry.
template (str) – Name of template for generating the entry.
name (str) – Content of the entry.
toctree (str, optional) – Directory to generate automatically rst files. The default is ‘’.
scope (str, optional) – Current scope of the entry. The default is ‘’.
alias (str) – Alias of the entry. The default is None.

property fullname: str

Get the fullname (scope + name) of the entry.

Returns:: Fullname of the entry.
Return type:: str