{# This file is part of the Sincerity JsDoc Template Copyright 2011-2015 Three Crickets LLC. The contents of this file are subject to the terms of the LGPL version 3.0: http://www.gnu.org/copyleft/lesser.html Alternatively, you can obtain a royalty free commercial license with less limitations, transferable or non-transferable, directly from Three Crickets at http://threecrickets.com/ #} {! var properties = data.getAllProperties() !} {! var methods = data.getAllMethods() !} {! function meta(data) { !}
Deprecated: {+ data.deprecated.toHtml(data.alias) +}
Requires: {+ item.toLink(data.alias) +}
Version: {+ data.version.toHtml(data.alias) +}
Since: {+ data.since.toHtml(data.alias) +}
Author: {+ data.author.toHtml(data.alias) +}
See: {+ item.toLink(data.alias) +}
{! } !}
{+ (data.isa == 'CONSTRUCTOR' ? 'Class ' : 'Namespace ') + data.alias +}
Augments: {+ data.augments.sort().map(function(symbol) { return String(symbol).toLink(data.alias) }).join(', ') +}
{+ (data.classDesc || data.desc).toHtml(data.alias) +} {! meta(data) !}
Properties
{+ (property.isStatic ? data.alias + '.' : 'this.') + property.name +}
{+ property.desc.toHtml(data.alias) +}
{+ property.type.toLinks(data.alias) +}
{! meta(property) !}
Methods
{! var params = method.parseParams() !}
{+ 'new ' + data.alias + '(' + params.signature.map(niceShortParam).join(', ') + ')' +} {+ (method.isStatic ? data.alias + '.' + method.name : 'this.' + method.name) + '(' + params.signature.map(niceShortParam).join(', ') + ')' +}
{# Don't show description for constructors if it's already in the class description block above #}
{+ method.desc.toHtml(data.alias) +}
{+ param.name +}: {+ param.desc.toHtml(data.alias) +}
{+ param.type.toLinks(data.alias) +} = {+ param.defaultValue +}
Returns: {+ ret.desc.toHtml(data.alias) +}
{+ ret.type.toLinks(data.alias) +}
Throws: {+ exception.type.toLinks(data.alias) +} {+ exception.desc.toHtml(data.alias) +}
{# Don't show meta data for constructors; it's already in the class description block above #} {! meta(method) !}