{! Link.base = "../"; /* all generated links will be relative to this */ !} JsDoc Reference - {+data.alias+}
{!
				var iblock_indent = 0;
				 data.augments.reverse().map(
					function($) {  
						output += iblock_indent ? ('') : '';
						output += new Link().toSymbol($) + "\n"; 
						iblock_indent += 20;
					}
				)
			!}{+data.alias+} 

		   
{! var fullpath = data.alias.split('.'); var cls = fullpath.pop(); var packge = fullpath.join("."); !}

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

Package:{+packge+}
Defined In: {# isn't defined in any file #} {+new Link({ url : './src/' + Link.srcFileFlatName(data.srcFile), text : Link.srcFileRelName(data.srcFile) })+}.
Class:{+cls+}
Subclasses: {+ data.childClasses .sort() .map( function($) { return new Link().toSymbol($); } ) .join(", ") +}
Extends: {+ new Link().toSymbol(data.augments[data.augments.length -1]) +}
{+resolveLinks(data.desc)+}
Class Comments / Notes => [Add Your comment/notes about this class]
{! var cfgProperties = []; if (!data.comment.getTag('singleton').length) { cfgProperties = data.configToArray(); cfgProperties = cfgProperties.sort(makeSortby("name")); } !}
Config Options - Has None
Config Options (Usually are also Properties)
Options Defined By
{! var ownProperties = []; var psorted = data.properties.sort(makeSortby("name")); psorted.filter( function($){ if (/$.hide/.test($.desc)) { return false; } if ( !$.isNamespace || (($.memberOf != data.alias) && $.isStatic)) { if ($.isStatic) ownProperties.push($); } return true; } ); !}
Public Properties - Has None
Public Properties
Property Description Defined By
 
{! if (member.isPrivate) output += "<private> "; if (member.isInner) output += "<inner> "; if (member.isConstant) output += "<constant> "; if (member.isStatic) output += ""+data.alias +"."; !}{+member.name+} : {+((member.type) ? (new Link().toSymbol(member.type)) : "" )+}
{+resolveLinks(summarize(member.desc))+}
{+resolveLinks(member.desc)+}
{+ (member.memberOf == data.alias) ? member.memberOf : new Link().toSymbol(member.memberOf) +}
{! var ownMethods = []; if (data.comment.getTag('class').length && !data.isBuiltin() && !data.comment.getTag('singleton').length && !data.comment.getTag('static').length ) { data.isInherited = false; ownMethods.push(data); } var msorted = data.methods.sort(makeSortby("name")); !} {! msorted.filter( function($){ if (/@hide/.test($.desc)) { return false; } if (!$.isEvent && (data.comment.getTag("instanceOf").length || data.comment.getTag("singleton").length)) { if ($.isStatic && (data.comment.getTag("instanceOf").length || data.comment.getTag("singleton").length) && ($.memberOf != data.alias)) { return true; } $.isInherited = ($.memberOf != data.alias); ownMethods.push($); return true; } if ($.isNamespace || $.isEvent || (($.memberOf != data.alias) && $.isStatic)){ return true; } if ($.isStatic) { $.isInherited = ($.memberOf != data.alias); ownMethods.push($); } return true; } ); !} {! msorted.filter( function($){ if (/@hide/.test($.desc)) { return false; } if (data.comment.getTag("instanceOf").length || data.comment.getTag("singleton").length) { return true; } if ($.isNamespace || $.isEvent || (($.memberOf != data.alias) && $.isStatic)){ return true; } if (!$.isStatic) { $.isInherited = ($.memberOf != data.alias); ownMethods.push($); } return true; } ); !}
Public Methods - Has None
Public Methods
Method Defined By
 
{! if (member.is('CONSTRUCTOR')) { output += "new " + member.memberOf + (member.memberOf.length ? "." : "") +""; } else { if (member.isPrivate) output += "<private> "; if (member.isInner) output += "<inner> "; if (member.isStatic || data.comment.getTag("singleton").length || data.comment.getTag("instanceOf").length) { output += data.alias + "."; } } !}{+member.name+} {+makeSignature(member.params)+} : or {+((item.type) ? (new Link().toSymbol(item.type)) : "" )+}
{+resolveLinks(summarize(member.desc))+}
Create a new {+data.alias +}
{+resolveLinks(member.desc)+}
{+member.example+}
Create a new {+data.alias +}
Parameters:
{+((item.type)?""+(new Link().toSymbol(item.type))+" " : "")+} {+item.name+} Optional , Default: {+item.defaultValue+}
{+resolveLinks(item.desc)+}
Deprecated:
{+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) +}
{+ (member.memberOf == data.alias) ? member.memberOf : new Link().toSymbol(member.memberOf) +}  
{! var ownEvents = data.methods.filter( function($){ return $.isEvent && !$.comment.getTag('hide').length; } ).sort(makeSortby("name")); !}
Events - Has None
Events
Event Defined By
©{+Options.copyright+}
Documentation generated by Introspection Doc Generator on {+new Date()+} Based on JsDoc Toolkit