JsDoc: {+data.overview.name+}

Library: {+(data.overview.name||data.filename)+}

Overview

{+data.overview.desc+}

{+tag.title+}: {+tag.desc+}

Constructors

{+symbol.memberof+}.{+symbol.name+}({+symbol.signature()+}) {+symbol.alias+}({+symbol.signature()+}) deprecated {+symbol.deprecated.desc+}

{+symbol.desc+}

{+symbol.doc.getTag('class').shift().desc+}

version: {+ symbol.doc.getTag('version').shift(); +}

{+example.desc+}

parameters

{+linkToType(param.type)+}

{+param.name+}? = {+param.defaultValue+}

{+param.desc+}

methods

{+method.name+}({+method.signature()+})

properties

{+property.type+} {+property.name+} {+property.desc+}

inherits

{+method.name+}({+method.signature()+}) from {+method.memberof+}

exceptions

{+linkToType(ex.type)+}

{+ex.desc+}

Namespaces

{+symbol.memberof+}.{+symbol.name+}({+symbol.signature()+}) {+symbol.alias+} deprecated {+symbol.deprecated.desc+}

{+symbol.desc+}

{+symbol.doc.getTag('class').shift().desc+}

version: {+ symbol.doc.getTag('version').shift(); +}

{+example.desc+}

parameters

{+linkToType(param.type)+}

{+param.name+}? = {+param.defaultValue+}

{+param.desc+}

methods

{+method.name+}({+method.signature()+})

properties

{+property.type+} {+property.name+}

inherits

{+method.name+}({+method.signature()+}) from {+method.memberof+}

exceptions

{+linkToType(ex.type)+}

{+ex.desc+}

Functions

{+symbol.memberof+}.{+symbol.name+}({+symbol.signature()+}) {+symbol.alias+}({+symbol.signature()+}) deprecated {+symbol.deprecated.desc+}

{+symbol.desc+}

since: {+ symbol.doc.getTag('since').shift(); +}

{+example.desc+}

parameters

{+linkToType(param.type)+}

{+param.name+}? = {+param.defaultValue+}

{+param.desc+}

returns

{+linkToType(ret.type)+}

{+ret.desc+}

exceptions

{+linkToType(ex.type)+}

{+ex.desc+}

Objects

{+symbol.type+} {+symbol.memberof+}.{+symbol.name+} {+symbol.alias+} deprecated {+symbol.deprecated.desc+}

{+symbol.desc+}

since: {+ symbol.doc.getTag('since').shift(); +}

{+example.desc+}

properties

{+linkToType(property.type)+}

{+property.name+}

{+property.desc+}