{% extends "base.html" %} {% set current_name = obj.name %} {% block title %}{{ obj.name }}{% endblock %} {% macro type_badge(obj_type) %} {% if obj_type == 'function_block' %}Function Block {% elif obj_type == 'program' %}Program {% elif obj_type == 'function' %}Function {% elif obj_type == 'interface' %}Interface {% elif obj_type == 'gvl' %}GVL {% elif obj_type == 'struct' %}Struct {% elif obj_type == 'enum' %}Enum {% endif %} {% endmacro %} {% macro var_table(vars, title, badge_class="") %} {% if vars %} {% set has_defaults = vars | selectattr('default_value') | list | length > 0 %}
| Name | Type | {% if has_defaults %}Default | {% endif %}Description |
|---|---|---|---|
{{ v.name }} |
{{ v.var_type | link_type }} | {% if has_defaults %}{% if v.default_value %}{{ v.default_value }}{% endif %} | {% endif %}
{{ v.comment }} |
| Name | Value | Description |
|---|---|---|
{{ m.name }} |
{{ m.var_type }} |
{{ m.comment }} |
{% if obj.extends %}Extends {{ obj.extends }}{% endif %} {% if obj.extends and obj.implements %} — {% endif %} {% if obj.implements %}Implements {% for iface in obj.implements %}{{ iface }}{% if not loop.last %}, {% endif %}{% endfor %}{% endif %}
{% endif %} {% if obj.comment.description %}{{ obj.comment.description }}
{% endif %} {% if obj.comment.remarks %}Remarks: {{ obj.comment.remarks }}
{% endif %}{{ method.comment.description }}
{% endif %} {{ var_table(method.inputs, 'Parameters') }} {{ var_table(method.inout, 'In/Out') }} {{ var_table(method.outputs, 'Outputs') }} {% if method.comment.returns %}Returns: {{ method.comment.returns }}
{% endif %} {% if method.body %}{{ method.body }}
{{ prop.comment.description }}
{{ obj.declaration }}