{{ method.name }}()
{{ method.name }}({% for argument in method.arguments %}{{ argument.types ? argument.types|join('|')~' ' }} {{ argument.isVariadic ? '...' }}{{ argument.name }}{{ argument.default ? ' = '~argument.default }}{% if not loop.last %}, {% endif %}{% endfor %}) {{ method.response.types ? ': '~method.response.types|join('|') }}
{{ method.summary }}
{{ method.description|markdown|raw }} {% if method.arguments|length > 0 %}Parameters
{{ argument.types|route|join('|')|raw }} | {{ argument.name }} {{ argument.isVariadic ? 'variadic' }} | {{ argument.description|markdown|raw }} |
Throws
-
{% for exception in method.tags.throws %}
- {{ exception.types|route|join('|')|raw }}
- {{ exception.description|markdown|raw }} {% endfor %} {% for exception in method.tags.throw %}
- {{ exception.types|route|join('|')|raw }}
- {{ exception.description|markdown|raw }} {% endfor %}
Returns
{{ method.response.types|route|join('|')|raw }} {% if method.response.description %} — {{ method.response.description|markdown|raw }} {% endif %} {% endif %} {% for tagName,tags in method.tags if tagName in ['example'] %} {% if loop.first %}Examples
{% endif %} {% for tag in tags %}{{ tag.description|escape }}
{{ tag.example|escape }}{% endfor %} {% endfor %}