{! 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+}


Extends {+ data.augments .sort() .map( function($) { return new Link().toSymbol($); } ) .join(", ") +}.
{+data.classDesc+} {# isn't defined in any file #} Defined in: {+new Link().toSrc(data.srcFile)+}.

{! var ownProperties = data.properties.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !}

Field Summary

  • {+member.memberOf+}.{+new Link().toSymbol(member.alias).withText(member.name)+}
{! var borrowedMembers = data.properties.filter(function($) {return $.memberOf != data.alias}); var contributers = []; borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)}); for (var i = 0, l = contributers.length; i < l; i++) { output += "
Fields borrowed from class "+new Link().toSymbol(contributers[i])+":
" + "
" + borrowedMembers .filter( function($) { return $.memberOf == contributers[i] } ) .sort(makeSortby("name")) .map( function($) { return new Link().toSymbol($.alias).withText($.name) } ) .join(", ") + "
"; } !}
{! var ownMethods = data.methods.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !}

Methods

  • {+new Link().toSymbol(member.alias).withText(member.name.replace(/\^\d+$/, '')) +}
{! var ownEvents = data.events.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !}
Event Summary
Event Attributes Event Name and Description
{+member.memberOf+}.{+new Link().toSymbol(member.alias).withText(member.name)+}{+makeSignature(member.params)+}
{+resolveLinks(summarize(member.desc))+}

Field Detail

{+new Link().toSymbol(member.type)+} {+member.memberOf+}.{+member.name+}
{+resolveLinks(member.desc)+}
Defined in: {+new Link().toSrc(member.srcFile)+}.

Author: {+member.author+}.
{+example+}
Deprecated:
{+ resolveLinks(member.deprecated) +}
Since:
{+ member.since +}
See:
{+ new Link().toSymbol(item) +}
Default Value:
{+resolveLinks(member.defaultValue)+}

Method Detail

{+member.name.replace(/\^\d+$/, '')+}
{+resolveLinks(member.desc)+}
Defined in: {+new Link().toSrc(member.srcFile)+}.

Author: {+member.author+}.
{+example+}
Parameters:
{+((item.type)?""+(new Link().toSymbol(item.type))+" " : "")+}{+item.name+} Optional, Default: {+item.defaultValue+}
{+resolveLinks(item.desc)+}
Deprecated:
{+ resolveLinks(member.deprecated) +}
Since:
{+ member.since +}
Throws:
{+((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) +}
Event Detail
{+new Link().toSymbol(member.type)+} {+member.memberOf+}.{+member.name+}{+makeSignature(member.params)+}
{+resolveLinks(member.desc)+}
Defined in: {+new Link().toSrc(member.srcFile)+}.

Author: {+member.author+}.
{+example+}
Parameters:
{+((item.type)?""+(new Link().toSymbol(item.type))+" " : "")+}{+item.name+} Optional, Default: {+item.defaultValue+}
{+ resolveLinks(item.desc) +}
Deprecated:
{+ resolveLinks(member.deprecated) +}
Since:
{+ member.since +}
Throws:
{+((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()+}