Interface
{{ namespace.name }}.{{ interface.name }}
Description {% if CONFIG.source_location_url and interface.docs_location %} [src] {% endif %}
{{ interface.c_decl }}
{{ interface.description }}
Stability: | {{ interface.stability }} |
Available since: | {{ interface.available_since }} |
Deprecated since: | {{ interface.deprecated_since.version }} |
{{ interface.deprecated_since.message }} |
{{ key|escape }} | {{ value|escape }} |
Instance methods
{% for method in interface.methods %}
{% endfor %}
{{ method.identifier }}
{{ method.summary }}
{% if method.available_since or method.deprecated_since -%}
{%- if method.available_since -%}
{%- endif %}
Available since: {{ method.available_since }}
{%- endif -%} {%- if method.deprecated_since -%}Deprecated since: {{ method.deprecated_since }}
{%- endif -%}Properties
{% for property in interface.properties %}
{% endfor %}
{{ interface.fqtn }}:{{ property.name }}
{{ property.summary }}
{% if property.available_since or property.deprecated_since -%}
{%- if property.available_since -%}
{%- endif %}
Available since: {{ property.available_since }}
{%- endif -%} {%- if property.deprecated_since -%}Deprecated since: {{ property.deprecated_since }}
{%- endif -%}Signals
{% for signal in interface.signals %}
{% endfor %}
{% endif %}
{% if interface.class_name %}
{{ interface.fqtn }}::{{ signal.name }}
{{ signal.summary }}
{% if signal.available_since or signal.deprecated_since -%}
{%- if signal.available_since -%}
{%- endif %}
Available since: {{ signal.available_since }}
{%- endif -%} {%- if signal.deprecated_since -%}Deprecated since: {{ signal.deprecated_since }}
{%- endif -%}Interface structure {% if CONFIG.source_location_url and interface.source_location %} [src] {% endif %}
struct {{ namespace.name}}{{ interface.class_name }} {
{% for field in interface.class_fields %}
{%- if field.is_callback -%}
{{ field.type_cname }};
{%- else -%}
{{ field.type_cname }} {{ field.name }};
{%- endif %}
{% else %}/* no available fields */{% endfor %}
}
Interface members
{{ field.name }} |
|
{{ field.description }} |
Interface methods
{% for method in interface.class_methods %}
{% endif %}
{% endfor %}
{{ method.identifier }}
{{ method.summary }}
{% if method.deprecated_since %}
Deprecated since: {{ method.deprecated_since.version }}
Functions
{% for func in interface.type_funcs %}
{% endif %}
{% endfor %}
{{ func.identifier }}
{{ func.summary }}
{% if func.deprecated_since %}
Deprecated since: {{ func.deprecated_since.version }}
Virtual methods
{% for method in interface.virtual_methods %}
{% endif %}
{% endfor %}
{{ namespace.name }}.{{ interface.name }}.{{ method.name }}
{{ method.summary }}
{% if method.deprecated_since %}
Deprecated since: {{ method.deprecated_since.version }}