{% extends "base.html" %} {% block title %}{{ function.title|e }}{% endblock %} {% block content %}

fn() {{ function.title|e }}
{{ sections.brief(function) }}

{{ sections.top_box(function) }} {{ sections.params(function) }} {{ sections.tparams(function) }} {{ sections.return_values(function) }} {% if function.internals or function.deprecation_msgs or function.warnings or function.notes or function.akas or not function.body.empty %}

Detailed Description

{% if function.internals %}
Internal:

For internal use only.

{% endif %} {% if function.deprecation_msgs %} {% for msg in function.deprecation_msgs %}
Deprecated.

{{ msg|transtext(False) }}

{% endfor %} {% endif %} {% if function.warnings %} {% for msg in function.warnings %}
Warning:

{{ msg|transtext(False) }}

{% endfor %} {% endif %} {% if function.notes %} {% for msg in function.notes %}
Note:

{{ msg|transtext(False) }}

{% endfor %} {% endif %} {% if function.akas %}
Also known as:

{{ function.akas|join(', ') }}

{% endif %} {{ sections.body(function) }}
{% endif %} {{ sections.throws(function) }} {{ sections.dataraces(function) }} {{ sections.see_also(function) }} {{ sections.dox_source(function, in_comment=True) }} {% endblock %}