Class
{{ namespace.name }}{{ class.name }}
{%- if CONFIG.is_unstable(class.available_since) -%} unstable {%- endif %} {%- if class.deprecated_since -%} deprecated: {{ class.deprecated_since.version }} {%- endif -%} {%- if class.available_since -%} since: {{ class.available_since }} {%- endif -%}
Description {% if CONFIG.source_location_url and class.docs_location %} [src] {% endif %}
{{ class.c_decl }}
Stability: {{ class.stability }}
{% endif %} {% if class.available_since %}Available since: {{ class.available_since }}
{% endif %} {% if class.deprecated_since %} {%- if class.deprecated_since.message -%}Deprecated since: {{ class.deprecated_since.version }}
{{ class.deprecated_since.message }}Deprecated since: {{ class.deprecated_since.version }}. Do not use in newly written code.
{%- endif -%} {% endif %}{{ key|escape }} | {{ value|escape }} |
Ancestors
-
{% for ancestor in class.ancestors %}
{% if ancestor.namespace == namespace.name %}
- {{ ancestor.type_cname }} {% else %}
- {{ ancestor.type_cname }} {% endif %} {% endfor %}
Descendants
-
{%- for cls in class.descendants %}
- {{ cls.ctype }} {% endfor -%}
Implements
-
{% for iface in class.interfaces %}
{% if iface.namespace == namespace.name %}
- {{ iface.type_cname }} {% else %}
- {{ iface.type_cname }} {% endif %} {% endfor %}
Constructors
{{ ctor.identifier }}
{%- if CONFIG.is_unstable(ctor.available_since) -%} unstable {%- endif %} {%- if ctor.deprecated_since -%} deprecated: {{ ctor.deprecated_since }} {%- endif -%} {%- if ctor.available_since -%} since: {{ ctor.available_since }} {%- endif -%}
Functions
{{ func.identifier }}
{%- if CONFIG.is_unstable(func.available_since) -%} unstable {%- endif %} {%- if func.deprecated_since -%} deprecated: {{ func.deprecated_since }} {%- endif -%} {%- if func.available_since -%} since: {{ func.available_since }} {%- endif -%}
Instance methods
{{ method.identifier }}
{%- if CONFIG.is_unstable(method.available_since) -%} unstable {%- endif %} {%- if method.deprecated_since -%} deprecated: {{ method.deprecated_since }} {%- endif -%} {%- if method.available_since -%} since: {{ method.available_since }} {%- endif -%}
Methods inherited from {{ ancestor.type_cname }} ({{ ancestor.n_methods }})
{%- else -%}Methods inherited from {{ ancestor.type_cname }} ({{ ancestor.n_methods }})
{% endif -%}{{ method.identifier }}
{%- else -%}{{ method.identifier }}
{% endif -%}{%- if CONFIG.is_unstable(method.available_since) -%} unstable {%- endif %} {%- if method.deprecated_since -%} deprecated: {{ method.deprecated_since }} {%- endif -%} {%- if method.available_since -%} since: {{ method.available_since }} {%- endif -%}
Please see {%- if ancestor.namespace == namespace.name -%} {{ ancestor.type_cname }} {%- else -%} {{ ancestor.type_cname }} {%- endif -%} for a full list of methods.
Methods inherited from {{ iface.type_cname }} ({{ iface.n_methods }})
{%- else -%}Methods inherited from {{ iface.type_cname }} ({{ iface.n_methods }})
{% endif -%}{{ method.identifier }}
{%- else -%}{{ method.identifier }}
{% endif -%}{%- if CONFIG.is_unstable(method.available_since) -%} unstable {%- endif %} {%- if method.deprecated_since -%} deprecated: {{ method.deprecated_since }} {%- endif -%} {%- if method.available_since -%} since: {{ method.available_since }} {%- endif -%}
Please see {%- if iface.namespace == namespace.name -%} {{ iface.type_cname }} {%- else -%} {{ iface.type_cname }} {%- endif -%} for a full list of methods.
Properties
{% if class.properties %}{{ class.fqtn }}:{{ property.name }}
{%- if CONFIG.is_unstable(property.available_since) -%} unstable {%- endif %} {%- if property.deprecated_since -%} deprecated: {{ property.deprecated_since }} {%- endif -%} {%- if property.available_since -%} since: {{ property.available_since }} {%- endif -%}
Properties inherited from {{ ancestor.type_cname }} ({{ ancestor.n_properties }})
{%- else -%}Properties inherited from {{ ancestor.type_cname }} ({{ ancestor.n_properties }})
{% endif -%}{{ ancestor.fqtn }}:{{ property.name }}
{%- else -%}{{ ancestor.fqtn }}:{{ property.name }}
{% endif -%}{%- if CONFIG.is_unstable(property.available_since) -%} unstable {%- endif %} {%- if property.deprecated_since -%} deprecated: {{ property.deprecated_since }} {%- endif -%} {%- if property.available_since -%} since: {{ property.available_since }} {%- endif -%}
Properties inherited from {{ iface.type_cname }} ({{ iface.n_properties }})
{%- else -%}Properties inherited from {{ iface.type_cname }} ({{ iface.n_properties }})
{% endif -%}{{ iface.type_cname }}:{{ property.name }}
{%- else -%}{{ iface.fqtn }}:{{ property.name }}
{% endif -%}{%- if CONFIG.is_unstable(property.available_since) -%} unstable {%- endif %} {%- if property.deprecated_since -%} deprecated: {{ property.deprecated_since }} {%- endif -%} {%- if property.available_since -%} since: {{ property.available_since }} {%- endif -%}
Signals
{% if class.signals %}{{ class.fqtn }}::{{ signal.name }}
{%- if CONFIG.is_unstable(signal.available_since) -%} unstable {%- endif %} {%- if signal.deprecated_since -%} deprecated: {{ signal.deprecated_since }} {%- endif -%} {%- if signal.available_since -%} since: {{ signal.available_since }} {%- endif -%}
Signals inherited from {{ ancestor.type_cname }} ({{ ancestor.n_signals }})
{%- else -%}Signals inherited from {{ ancestor.type_cname }} ({{ ancestor.n_signals }})
{% endif -%}{{ ancestor.type_cname }}::{{ signal.name }}
{%- else -%}{{ ancestor.type_cname }}::{{ signal.name }}
{% endif -%}{%- if CONFIG.is_unstable(signal.available_since) -%} unstable {%- endif %} {%- if signal.deprecated_since -%} deprecated: {{ signal.deprecated_since }} {%- endif -%} {%- if signal.available_since -%} since: {{ signal.available_since }} {%- endif -%}
Signals inherited from {{ iface.type_cname }} ({{ iface.n_signals }})
{%- else -%}Signals inherited from {{ iface.type_cname }} ({{ iface.n_signals }})
{% endif -%}{{ iface.type_cname }}::{{ signal.name }}
{%- else -%}{{ iface.type_cname }}::{{ signal.name }}
{% endif -%}{%- if CONFIG.is_unstable(signal.available_since) -%} unstable {%- endif %} {%- if signal.deprecated_since -%} deprecated: {{ signal.deprecated_since }} {%- endif -%} {%- if signal.available_since -%} since: {{ signal.available_since }} {%- endif -%}
Class structure
struct {{ namespace.name}}{{ class.class_name }} {
{% for field in class.class_fields %}
{%- if field.is_callback -%}
{{ field.type_cname }};
{%- else -%}
{{ field.type_cname }} {{ field.name }};
{%- endif %}
{% else %}/* no available fields */{% endfor %}
}
Class members
-
{% for field in class.class_fields %}
{{ field.name }}: {{ field.type_cname }}
- {{ field.description }} {% endfor %}
Virtual methods
{{ namespace.name }}.{{ class.class_name }}.{{ method.name }}
{%- if CONFIG.is_unstable(method.available_since) -%} unstable {%- endif %} {%- if method.deprecated_since -%} deprecated: {{ method.deprecated_since }} {%- endif -%} {%- if method.available_since -%} since: {{ method.available_since }} {%- endif -%}
Class methods
{{ method.identifier }}
{%- if CONFIG.is_unstable(method.available_since) -%} unstable {%- endif %} {%- if method.deprecated_since -%} deprecated: {{ method.deprecated_since }} {%- endif -%} {%- if method.available_since -%} since: {{ method.available_since }} {%- endif -%}