{% block method %} ==== {{ method.name }} ==== {# twothirds column#} {% include 'includes/wrap-tags.txt.twig' with {structure:method, wrap: 'safety', wrapTags: ['api', 'api-advanced', 'overwritable-hook', 'extension-hook']} %} {% if method.deprecated %}deprecated {% endif %} {% if (node.parent is not null and method.parent.fullyQualifiedStructuralElementName != node.fullyQualifiedStructuralElementName) %}inherited {% endif %} {% if method.abstract %}abstract {% endif %} {% if method.final %}final {% endif %} {{ method.visibility }} {% if method.static %}static {% endif %} {# third column#} == {{ method.summary|replace({"\n":""})|raw }} == {{ method.description|markdown|raw }}

{% if method.abstract %}abstract {% endif %}{% if method.final %}final {% endif %}{{ method.visibility }} {% if method.static %}static {% endif %}{{ method.name }}({% for argument in method.arguments %}{{ argument.isVariadic ? '...' }}{{ argument.name }}{{ argument.default ? (' = '~argument.default)|raw }}{% if not loop.last %}, {% endif %}{% endfor %})

=== Parameters === {% if method.arguments|length > 0 -%} ^ types ^ name ^ default ^ description ^ {% for argument in method.arguments -%} | **{{ argument.types|join('|')|raw }}** | {{ argument.name }} {{ argument.isVariadic ? 'variadic' }} | {{ argument.default|raw }} | {{ argument.description|trim|replace("\n", ' ')|raw }} |{{ "\r\n" }} {%- endfor %} {% else %} //none// {% endif %} {#=== Parameters ===#} {#{% if method.arguments|length > 0 -%}#} {#{% for argument in method.arguments -%}#} {#== {{ argument.name }} ==#} {#{% set varDesc %}#} {#{{ argument.types|join('|') }}#} {#{{ argument.isVariadic ? 'variadic' }}#} {#{{ argument.description|raw }}#} {#{% endset %}#} {#{{ varDesc|markdown|raw }}#} {#{%- endfor %}#} {#{% else %}#} {#This method has no parameter#} {#{% endif %}#} {% if method.response and method.response.types|join() != 'void' %} === Returns === {{ ('**' ~ method.response.types|join('|')|trim ~ '** ' ~ method.response.description)|markdown|raw }} {% endif %} {# twothirds column#} {% if method.tags.throws|length > 0 or method.tags.throw|length > 0 %} === Throws === {% for exception in method.tags.throws -%} {% if loop.length > 1 %} * {% endif %}''{{ exception.types|join('|')|raw }}'' {{ exception.description|raw }} {% endfor %} {% endif %} {% include 'includes/inherited-from.txt.twig' with {structure:method} %} {% include 'includes/see-also.txt.twig' with {structure:method, title_level: '==='} %} {% include 'includes/uses.txt.twig' with {structure:method, title_level: '==='} %} {% include 'includes/used-by.txt.twig' with {structure:method, title_level: '==='} %} {% include 'includes/tags-with-description.txt.twig' with {structure:method, title_level: '===', WRAP: 'info', tagsWithDescription: ['api', 'api-advanced', 'overwritable-hook', 'extension-hook']} %} {% include 'includes/tags.txt.twig' with {structure:method, title_level: '===', blacklist: ['todo', 'link', 'see', 'abstract', 'example', 'param', 'return', 'access', 'deprecated', 'throws', 'throw', 'uses', 'api', 'api-advanced', 'overwritable-hook', 'extension-hook', 'used-by', 'inheritdoc', 'code-example']} %} {# third column#} {% include 'includes/code-examples.txt.twig' with {structure:method, title_level: '==='} %} {# group #} {% endblock %}