{! Link.base = "../"; /* all generated links will be relative to this */ !} JsDoc Reference - {+data.alias+}
{+publish.classesIndex+}
«
{+JSDOC.opt.D.projectName+}

Built-In {!output+=(data.isNamespace)?"Namespace ":"Class ";!}{+data.alias+}

{+resolveLinks(data.classDesc)+}

{# isn't defined in any file #}

Defined in: {+new Link().toSrc(data.srcFile)+}.

{# have no documented constructor #}
Constructor Summary
new {+ new Link().toSymbol(data.alias).inner('constructor').withText(data.alias)+} {+ makeSignature(data.params) +} {+getDesc(data)+}
{! var ownProperties = data.properties.filter(function($){return $.memberOf == data.alias}); !}
Field Summary
{+new Link().toSymbol(member.alias).withText(member.name)+} {+getDesc(member)+}
{! var ownMethods = data.methods.filter(function($){return $.memberOf == data.alias}); !}
Method Summary
{+new Link().toSymbol(member.alias).withText(member.name)+}{+makeSignature(member.params)+} {+getDesc(member)+}
Constructor Detail
new {+ data.alias +}{+ makeSignature(data.params) +}
{+resolveLinks(data.desc)+}

Author: {+data.author+}.
{+data.example+}
Parameters:
{+((item.type)?""+("{"+(new Link().toSymbol(item.type)+"} ")) : "")+} {+item.name+} Optional, Default: {+item.defaultValue+}
{+resolveLinks(item.desc)+}
Deprecated:
{+data.deprecated+}
Since:
{+ item +}
Exceptions:
{+((item.type)?"{"+(new Link().toSymbol(item.type))+"} " : "")+} {+item.name+}
{+resolveLinks(item.desc)+}
Returns:
{+((item.type)?"{"+(new Link().toSymbol(item.type))+"} " : "")+}{+resolveLinks(item.desc)+}
Requires:
{+ resolveLinks(item) +}
See:
{+ new Link().toSymbol(item) +}
Field Detail
{! var module = getModule(member); var pClass = getPrivateClass(member); var link = new Link().toSymbol(member.alias); var fakeOut = ""; if (hasModule(member)) { output += "
"; fakeOut += "
" + link.withText(module) + "
"; } else { output += "
"; fakeOut += "
 
"; } !}
{+member.memberOf+}.{+member.name+} : {+new Link().toSymbol(member.type)+}
{+resolveLinks(member.desc)+}

Defined in: {+new Link().toSrc(member.srcFile)+}.



Author: {+member.author+}.
{+member.example+}
Deprecated:
{+ member.deprecated +}
Since:
{+ member.since +}
See:
{+ new Link().toSymbol(item) +}
Default Value:
{+resolveLinks(member.defaultValue)+}
Method Detail
{! var module = getModule(member); var pClass = getPrivateClass(member); var link = new Link().toSymbol(member.alias); var fakeOut = ""; if (hasModule(member)) { output += "
"; fakeOut += "
" + link.withText(module) + "
"; } else { output += "
"; fakeOut += "
 
"; } !}
{+member.memberOf+}.{+member.name+}{+makeSignature(member.params)+} : {+new Link().toSymbol(member.type)+}
{+resolveLinks(member.desc)+}

Defined in: {+new Link().toSrc(member.srcFile)+}.



Author: {+member.author+}.
{+member.example+}
Parameters:
{+((item.type)?"{"+(new Link().toSymbol(item.type))+"} " : "")+} {+item.name+}?, Default: {+item.defaultValue+} {+resolveLinks(item.desc)+}
Deprecated:
{+member.deprecated+}
Since:
{+ member.since +}
Exceptions:
{+((item.type)?"{"+(new Link().toSymbol(item.type))+"} " : "")+} {+item.name+} {+resolveLinks(item.desc)+}
Returns:
{+((item.type)?"{"+(new Link().toSymbol(item.type))+"} " : "")+} {+resolveLinks(item.desc)+}
Requires:
{+ resolveLinks(item) +}
See:
{+ new Link().toSymbol(item) +}
©{+JSDOC.opt.D.copyright+}

Documentation generated by JsDoc Toolkit {+JSDOC.VERSION+} on {+new Date()+}