{{ objectName }}.{{ tplData.name }}

implemented in {{ tplData.file.name }} (line {{ tplData.file.lineNumber }}, {{ tplData.file.numLines }} lines)
{{ tplData.shortDescription }}
{{ tplData.description|markdown }}

Usage

{% spaceless %} var ret = {{ objectName }}.{{ tplData.name }}({% for p in tplData.parameters %}{% ifnotequal forloop.counter "1" %}, {% endifnotequal %}{{ p.name }}{% endfor %}); {% endspaceless %}
{% if tplData.parameters.length %} {% for p in tplData.parameters %} {% endfor %}
Parameter Type Description
{{ p.name }} {{ p.datatype }} {{ p.description }}
{% endif %} {% if tplData.examples.length %}

Examples

{% for e in tplData.examples %}
{% ifnotequal tplData.examples.length 1 %}

Example {{ forloop.counter }}:

{% endifnotequal %} {{ e|markdown }}
{% endfor %}
{% endif %} {% comment %}

		{{ tplData.sourceCode }}
	
{% if tplData.info %} {% if tplData.info.description %}
{{ tplData.info.description|urlize|safe }}
{% else %} {% if tplData.info.summary %}
{{ tplData.info.summary|urlize|safe }}
{% endif %} {% endif %} {% endif %} {% ifequal tplData.moduleType "method" %}

Usage

var ret = {{ tplData.moduleName }}({% for item in tplData.params %}{% ifnotequal forloop.counter "1" %}, {% endifnotequal %}{{ item.name }}{% endfor %});
{% with tplData.params as item %} {% include tplData.parameterTemplate %} {% endwith %} {% endifequal %} {% if tplData.info.example %}
{% if tplData.info.example.items %}

Examples

{% for inner_value in tplData.info.example %}

Example {{ forloop.counter }}:

{{ inner_value|safe }}
{% endfor %} {% else %}

Example

{{ tplData.info.example|safe }}
{% endif %}
{% endif %} {% if not tplData.methods|empty %}

Methods ({{ tplData.amounts.methods.public }} public{% if tplData.amounts.methods.private %}, {{ tplData.amounts.methods.private }} private{% endif %})

{% for method in tplData.methods %} {% endfor %}
    {% if method.obj.implementedIn.length %} {% if method.obj.isOverridden %}also {% endif %}implemented in: {% for parent in method.obj.implementedIn %} {{ parent }}{% if not forloop.last %}, {% endif %} {% endfor %} {% endif %}
{% if method.obj.docString.summary %}
{{ method.obj.docString.summary }}
{% endif %} {% with method.obj.params as item %} {% include tplData.parameterTemplate %} {% endwith %} {% if method.obj.docString.description %}
{{ method.obj.docString.description|safe }}
{% endif %} {% if method.obj.docString.example %}
{% if method.obj.docString.example.items %}

Examples

{% for inner_value in method.obj.docString.example %}

Example {{ forloop.counter }}:

{{ inner_value|safe }}
{% endfor %} {% else %}

Example

{{ method.obj.docString.example|safe }}
{% endif %}
{% endif %}
{% endif %} {% endcomment %}