{{#if final}}final {{/if}}{{#if returnType}}{{#crossLink returnType}}{{/crossLink}} {{/if}}`{{name}}`( `{{paramsList}} ` ) {{#if access}}`/* {{access}} method */`{{/if}}
{{#if overwritten_from}} Defined in {{overwritten_from/class}} but overwritten locally: {{else}} {{#if extended_from}} Defined in {{extended_from}}: {{/if}} {{/if}} `{{file}}:{{line}}`
{{{methodDescription}}} {{#if params}} Parameters:

{{#params}}
• {{#if optional}} `[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]` <{{#crossLink type}}{{/crossLink}}> {{else}} `{{name}}` <{{#crossLink type}}{{/crossLink}}> {{/if}} {{#if multiple}} (*..n) {{/if}} {{{description}}} {{#if props}}
  {{#props}}
  • `{{name}}` <{{#crossLink type}}{{/crossLink}}> {{{description}}} {{#if props}}
    {{#props}}
    • `{{name}}` <{{#crossLink type}}{{/crossLink}}> {{{description}}}
    {{/props}}
    {{/if}}
  {{/props}}
  {{/if}}
{{/params}}

{{/if}} {{#if return}} {{#return}}
{{/return}} {{/if}} {{#if throws}} {{#throws}}
{{/throws}} {{/if}} {{#if example}}

Example

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