{! Link.base = "../"; /* all generated links will be relative to this */ !} {+JSDOC.opt.D.projectTitle+} <if test="JSDOC.opt.D.version">v.{+JSDOC.opt.D.version+}</if> : {+data.alias+} : JsDoc Reference {+include("static/header.html")+}

{+JSDOC.opt.D.projectTitle+} v.{+JSDOC.opt.D.version+}

{+new Link().toFile("index.html").withText("Class Index")+} | {+new Link().toFile("files.html").withText("File Index")+}
{+publish.classesIndex+}

{! var classType = ""; if (data.isBuiltin()) { classType += "Built-In "; } if (data.isNamespace) { if (data.is('FUNCTION')) { classType += "Function "; } classType += "Namespace "; } else { classType += "Class "; } !} {+classType+}{+data.alias+}

Author:
{+data.author+}
Version:
{+data.version+}
Extends:
{+ data.augments .sort() .map( function($) { return new Link().toSymbol($); } ) .join(", ") +}
Requires:
{+ new Link().toSymbol(item) +}
Defined in:
{+new Link().toSrc(data.srcFile)+}
See:
{+ new Link().toSymbol(item) +}

{+resolveLinks(data.classDesc)+} 

{+makeExample(example)+}

Constructor

{+ new Link().toSymbol(data.alias).inner('constructor')+}{+ makeSignature(data.params) +}
[private] [inner] {+resolveLinks(summarize(data.desc))+}
{! /** Filter: Determine whether this item is static */ function staticFilter($){return $.isStatic && !$.isNamespace} /** Filter: Determine whether this item is not static */ function notStaticFilter($){return !$.isStatic && !$.isNamespace} /** Filter: Determine whether this item is inherited */ function inheritedFilter($){return $.memberOf != data.alias} /** Filter: Determine whether this item is not inherited */ function notInheritedFilter($){return $.memberOf == data.alias} !} {! var staticProperties = data.properties.filter(staticFilter).sort(makeSortby("name")); !}

Static Fields

{+doTemplate('membertable.tmpl', { type:'Field', members:staticProperties, alias: data.alias })+} {! var staticMethods = data.methods.filter(staticFilter).sort(makeSortby("name")); !}

Static Methods

{+doTemplate('membertable.tmpl', { type:'Method', members:staticMethods, alias: data.alias })+} {! var instanceProperties = data.properties.filter(notStaticFilter).sort(makeSortby("name")); !}

Fields

{+doTemplate('membertable.tmpl', { type:'Field', members:instanceProperties, alias: data.alias })+} {! var instanceMethods = data.methods.filter(notStaticFilter).sort(makeSortby("name")); !}

Methods

{+doTemplate('membertable.tmpl', { type:'Method', members:instanceMethods, alias: data.alias })+} {! var events = data.events.filter(function($){return !$.isNamespace}).sort(makeSortby("name")); !}

Events

{+doTemplate('membertable.tmpl', { type:'Event', members:events, alias: data.alias })+}
{+classType+}Detail
{+ data.alias +}{+ makeSignature(data.params) +}
[private] [inner]
{+doTemplate("params.tmpl", data.params)+}
Deprecated:
{+resolveLinks(data.deprecated)+}
Since:
{+ data.since +}
Throws:
{{+new Link().toSymbol(item.type)+}} {+resolveLinks(item.desc)+}
Returns:
{{+new Link().toSymbol(item.type)+}} {+resolveLinks(item.desc)+}
{! var ownStaticProperties = staticProperties.filter(notInheritedFilter); !}
Static Field Details
{+doTemplate('memberdetail.tmpl', { members: ownStaticProperties, srcFile: data.srcFile })+} {! var ownStaticMethods = staticMethods.filter(notInheritedFilter); !}
Static Method Details
{+doTemplate('memberdetail.tmpl', { members: ownStaticMethods, srcFile: data.srcFile })+} {! var ownInstanceProperties = instanceProperties.filter(notInheritedFilter); !}
Field Details
{+doTemplate('memberdetail.tmpl', { members: ownInstanceProperties, srcFile: data.srcFile })+} {! var ownInstanceMethods = instanceMethods.filter(notInheritedFilter); !}
Method Details
{+doTemplate('memberdetail.tmpl', { members: ownInstanceMethods, srcFile: data.srcFile })+} {! var ownEvents = events.filter(notInheritedFilter); !}
Events
{+doTemplate('memberdetail.tmpl', { members: ownEvents, srcFile: data.srcFile })+}
©{+JSDOC.opt.D.copyright+}
 Documentation generated by JsDoc Toolkit {+JSDOC.VERSION+} on {+new Date()+}