`{{file}}:{{line}}`

{{ensure-access access}} {{#if static}}static{{/if}} {{#if final}}final{{/if}} {{name}}({{paramsList}}){{#if return}}: {{#crossLink return.type}}{{/crossLink}}{{/if}}

{{#if overwritten_from}}
Overwrites {{#crossLink (concat overwritten_from/class "/" overwritten_from/name ":method")}}{{overwritten_from/class}}.{{overwritten_from/name}}{{/crossLink}}
{{else}} {{#if extended_from}}
Inherited from {{#crossLink (concat extended_from "/" name ":method")}}{{extended_from}}{{/crossLink}}
{{/if}} {{/if}} {{#if deprecated}}
{{#if deprecationMessage}}

Deprecated: {{{deprecationMessage}}}

{{else}}

Deprecated: This method is deprecated.

{{/if}}
{{/if}}
{{{methodDescription}}}
{{#if params}}

Parameters:

{{#each params}} {{#each props}} {{/each}} {{/each}}
Name Type Attribute Description
{{name}} {{#crossLink type}}{{/crossLink}}
    {{#if optional}}
  • optional
    • {{/if}} {{#if optdefault}}
  • default: {{{optdefault}}}
    • {{/if}} {{#if multiple}}
  • multiple
    • {{/if}}
{{{description}}}
{{../name}}.{{name}} {{#crossLink type}}{{/crossLink}}
    {{#if optional}}
  • optional
    • {{/if}} {{#if optdefault}}
  • default: {{{optdefault}}}
    • {{/if}} {{#if multiple}}
  • multiple
    • {{/if}}
{{{description}}}
{{/if}} {{#if return}}

Return:

{{#if return.type}}{{#crossLink return.type}}{{/crossLink}}{{/if}} {{{return.description}}}
{{/if}} {{#if throws}}

Throws:

{{#if throws.type}}{{#crossLink throws.type}}{{/crossLink}}{{/if}} {{{throws.description}}}
{{/if}} {{#if example}}

Example:

{{{example}}} {{/if}}