archive-gh-me/jsdoc
1
0
Fork 0
mirror of https://github.com/jsdoc/jsdoc.git synced 2025-12-08 19:46:11 +00:00
Code Issues Projects Releases Wiki Activity

first pass at template overhaul and template API changes

Browse Source 
API changes:
+ No more `jsdoc/template` module. Each JSDoc template uses whatever templating system it wants.
+ No more TaffyDB. Each template finds doclets however it wants. (TODO: Update `jsdoc/util/templateHelper` so none of its methods expect a TaffyDB object.)
+ Templates are now loaded with `require('my-template-name-here')`. The resulting object must include a `publish` method.
+ The `publish` method now takes two parameters: a `data` object with `doclets` and `tutorials` properties, and an `options` object. `data.doclets` is just an array.

Other notable changes:
+ No more `haruki` template.
+ Moved the `default` and `silent` templates to new packages.
+ The `.tmpl` files for the `default` template (now called `@jsdoc/template-original`) no longer use custom delimiters.
This commit is contained in:
Jeff Williams 2019-01-21 14:13:43 -08:00
parent 3b8b0b479b
commit f27aba37b7
76 changed files with 1003 additions and 12610 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
LICENSE.md
View File

@ -55,16 +55,6 @@ license, which is reproduced below:
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
> SOFTWARE.
## Google Code Prettify ##
Google Code Prettify is distributed under the Apache License 2.0, which is
included with this package.
Copyright (c) 2006 Google Inc.
The source code for Google Code Prettify is available at:
https://code.google.com/p/google-code-prettify/
## Jasmine ##
Jasmine is distributed under the MIT license, which is reproduced above.
@ -82,23 +72,3 @@ Copyright (c) 2010 Adam Abrons and Misko Hevery (http://getangular.com).
The source code for jasmine-node is available at:
https://github.com/mhevery/jasmine-node
## Open Sans ##
Open Sans is distributed under the Apache License 2.0, which is
included with this package.
Copyright (c) 2010-2011, Google Inc.
This typeface, including the complete set of variations, are available at:
http://www.google.com/fonts/specimen/Open+Sans
## Tomorrow Theme for Google Code Prettify ##
The Tomorrow Theme for Google Code Prettify is distributed under the MIT
license, which is reproduced above.
Copyright (c) 2016 Yoshihide Jimbo.
The source code for the Tomorrow Theme is available at:
https://github.com/jmblog/color-themes-for-google-code-prettify

26
cli.js
View File

@ -413,43 +413,37 @@ module.exports = (() => {
};
cli.generateDocs = () => {
const path = require('jsdoc/path');
const resolver = require('jsdoc/tutorial/resolver');
const taffy = require('taffydb').taffy;
let template;
env.opts.template = (() => {
const publish = env.opts.template || 'templates/default';
const templatePath = path.getResourcePath(publish);
// if we didn't find the template, keep the user-specified value so the error message is
// useful
return templatePath || env.opts.template;
})();
env.opts.template = env.opts.template || '@jsdoc/template-original';
try {
template = require(`${env.opts.template}/publish`);
template = require(env.opts.template);
}
catch (e) {
logger.fatal(`Unable to load template: ${e.message}` || e);
}
// templates should include a publish.js file that exports a "publish" function
// templates should export a "publish" function
if (template.publish && typeof template.publish === 'function') {
let publishPromise;
logger.info('Generating output files...');
publishPromise = template.publish(
taffy(props.docs),
env.opts,
resolver.root
{
doclets: props.docs,
tutorials: resolver.root
},
env.opts
);
return Promise.resolve(publishPromise);
}
else {
logger.fatal(`${env.opts.template} does not export a "publish" function. Global "publish" functions are no longer supported.`);
logger.fatal(`${env.opts.template} does not export a "publish" function.`);
}
return Promise.resolve();

2
lib/jsdoc/util/templateHelper.js
View File

@ -21,6 +21,8 @@ const containers = ['class', 'module', 'external', 'namespace', 'mixin', 'interf
let tutorials;
// TODO(hegemonic): update helper functions that expect a TaffyDB object
/** Sets tutorials map.
@param {jsdoc.tutorial.Tutorial} root - Root tutorial node.
*/

21
package-lock.json generated
View File

@ -133,6 +133,27 @@
"@jsdoc/syntax": {
"version": "file:packages/jsdoc-syntax"
},
"@jsdoc/template-original": {
"version": "file:packages/jsdoc-template-original",
"requires": {
"code-prettify": "^0.1.0",
"open-sans-fonts": "^1.5.0",
"taffydb": "2.6.2"
},
"dependencies": {
"code-prettify": {
"version": "0.1.0",
"bundled": true
},
"open-sans-fonts": {
"version": "1.5.0",
"bundled": true
}
}
},
"@jsdoc/template-silent": {
"version": "file:packages/jsdoc-template-silent"
},
"@lerna/add": {
"version": "3.10.6",
"resolved": "https://registry.npmjs.org/@lerna/add/-/add-3.10.6.tgz",

14
package.json
View File

@ -14,8 +14,10 @@
},
"dependencies": {
"@babel/parser": "~7.2.3",
"@jsdoc/logger": "file:./packages/jsdoc-logger",
"@jsdoc/syntax": "file:./packages/jsdoc-syntax",
"@jsdoc/logger": "file:packages/jsdoc-logger",
"@jsdoc/syntax": "file:packages/jsdoc-syntax",
"@jsdoc/template-original": "file:packages/jsdoc-template-original",
"@jsdoc/template-silent": "file:packages/jsdoc-template-silent",
"bluebird": "~3.5.0",
"catharsis": "~0.8.9",
"escape-string-regexp": "~1.0.5",
@ -27,8 +29,7 @@
"marked": "~0.6.0",
"mkdirp": "~0.5.1",
"requizzle": "~0.2.1",
"strip-json-comments": "~2.0.1",
"taffydb": "2.6.2"
"strip-json-comments": "~2.0.1"
},
"devDependencies": {
"ajv": "~6.7.0",
@ -47,11 +48,6 @@
"bin": {
"jsdoc": "./jsdoc.js"
},
"greenkeeper": {
"ignore": [
"taffydb"
]
},
"bugs": "https://github.com/jsdoc3/jsdoc/issues",
"author": {
"name": "Michael Mathews",

11
packages/jsdoc-template-original/README.md Normal file
View File

@ -0,0 +1,11 @@
# @jsdoc/template-original
An updated version of JSDoc 3's original template.
## Installing the package
Using npm:
```shell
npm install --save @jsdoc/template-original
```

80
templates/default/publish.js → packages/jsdoc-template-original/index.js
View File

@ -5,14 +5,29 @@ const helper = require('jsdoc/util/templateHelper');
const logger = require('@jsdoc/logger');
const path = require('jsdoc/path');
const taffy = require('taffydb').taffy;
const template = require('jsdoc/template');
const util = require('util');
const Template = require('./lib/template');
const htmlsafe = helper.htmlsafe;
const linkto = helper.linkto;
const resolveAuthorLinks = helper.resolveAuthorLinks;
const hasOwnProp = Object.prototype.hasOwnProperty;
const FONT_NAMES = [
'OpenSans-Bold',
'OpenSans-BoldItalic',
'OpenSans-Italic',
'OpenSans-Light',
'OpenSans-LightItalic',
'OpenSans-Regular'
];
const PRETTIFIER_CSS_FILES = [
'tomorrow.min.css'
];
const PRETTIFIER_SCRIPT_FILES = [
'lang-css.js',
'prettify.js'
];
let data;
let view;
@ -100,8 +115,7 @@ function updateItemName(item) {
}
if (attributes && attributes.length) {
itemName = util.format( '%s<span class="signature-attributes">%s</span>', itemName,
attributes.join(', ') );
itemName = `${itemName}<span class="signature-attributes">${attributes.join(', ')}</span>`;
}
return itemName;
@ -127,7 +141,7 @@ function buildAttribsString(attribs) {
let attribsString = '';
if (attribs && attribs.length) {
attribsString = htmlsafe( util.format('(%s) ', attribs.join(', ')) );
attribsString = htmlsafe(`(${attribs.join(', ')}) `);
}
return attribsString;
@ -146,7 +160,7 @@ function addNonParamAttributes(items) {
function addSignatureParams(f) {
const params = f.params ? addParamAttributes(f.params) : [];
f.signature = util.format( '%s(%s)', (f.signature || ''), params.join(', ') );
f.signature = `${f.signature || ''}(${params.join(', ')})`;
}
function addSignatureReturns(f) {
@ -175,7 +189,7 @@ function addSignatureReturns(f) {
returnTypes = addNonParamAttributes(source);
}
if (returnTypes.length) {
returnTypesString = util.format( ' &rarr; %s{%s}', attribsString, returnTypes.join('|') );
returnTypesString = ` &rarr; ${attribsString}{${returnTypes.join('|')}}`;
}
f.signature = `<span class="signature">${f.signature || ''}</span><span class="type-signature">${returnTypesString}</span>`;
@ -191,7 +205,7 @@ function addAttribs(f) {
const attribs = helper.getAttribs(f);
const attribsString = buildAttribsString(attribs);
f.attribs = util.format('<span class="type-signature">%s</span>', attribsString);
f.attribs = `<span class="type-signature">${attribsString}</span>`;
}
function shortenPaths(files, commonPrefix) {
@ -391,11 +405,10 @@ function buildNav(members) {
}
/**
@param {TAFFY} taffyData See <http://taffydb.com/>.
@param {object} data
@param {object} opts
@param {Tutorial} tutorials
*/
exports.publish = (taffyData, opts, tutorials) => {
exports.publish = ({doclets, tutorials}, opts) => {
let classes;
let conf;
let externals;
@ -419,13 +432,13 @@ exports.publish = (taffyData, opts, tutorials) => {
let staticFileScanner;
let templatePath;
data = taffyData;
data = taffy(doclets);
conf = env.conf.templates || {};
conf.default = conf.default || {};
templatePath = path.normalize(opts.template);
view = new template.Template( path.join(templatePath, 'tmpl') );
templatePath = path.dirname(require.resolve(opts.template));
view = new Template(path.join(templatePath, 'tmpl'));
// claim some special filenames in advance, so the All-Powerful Overseer of Filename Uniqueness
// doesn't try to hand them out later
@ -495,17 +508,52 @@ exports.publish = (taffyData, opts, tutorials) => {
}
fs.mkPath(outdir);
// copy the template's static files to outdir
// copy the template's built-in static files to outdir
fromDir = path.join(templatePath, 'static');
staticFiles = fs.ls(fromDir, 3);
staticFiles.forEach(fileName => {
const toDir = fs.toDir( fileName.replace(fromDir, outdir) );
const toDir = fs.toDir(fileName.replace(fromDir, outdir));
fs.mkPath(toDir);
fs.copyFileSync(fileName, toDir);
});
// copy the fonts used by the template to outdir
staticFiles = fs.ls(path.join(templatePath, 'node_modules/open-sans-fonts/open-sans'), 3);
staticFiles.forEach(fileName => {
const toDir = path.join(outdir, 'fonts');
if (FONT_NAMES.includes(path.parse(fileName).name)) {
fs.mkPath(toDir);
fs.copyFileSync(fileName, toDir);
}
});
// copy the prettify script to outdir
PRETTIFIER_SCRIPT_FILES.forEach(fileName => {
const toDir = path.join(outdir, 'scripts');
fs.copyFileSync(
path.join(templatePath, 'node_modules/code-prettify/loader', fileName),
toDir
);
});
// copy the prettify CSS to outdir
PRETTIFIER_CSS_FILES.forEach(fileName => {
const toDir = path.join(outdir, 'styles');
fs.copyFileSync(
path.join(
templatePath, 'node_modules/color-themes-for-google-code-prettify/dist/themes',
fileName
),
toDir
);
});
// copy user-specified static files to outdir
if (conf.default.staticFiles) {
// The canonical property name is `include`. We accept `paths` for backwards compatibility

38
lib/jsdoc/template.js → packages/jsdoc-template-original/lib/template.js
View File

@ -1,47 +1,40 @@
/**
* Wrapper for underscore's template utility to allow loading templates from files.
* @module jsdoc/template
* Wrapper for `_.template` to load templates from files.
*/
const _ = require('lodash');
const fs = require('jsdoc/fs');
const path = require('path');
/**
* Underscore template helper.
* Template wrapper.
*/
class Template {
/**
* @param {string} filepath - Templates directory.
* @param {string} filepath - The directory that contains `.tmpl` files.
*/
constructor(filepath) {
this.path = filepath;
this.layout = null;
this.cache = {};
// override default template tag settings
this.settings = {
evaluate: /<\?js([\s\S]+?)\?>/g,
interpolate: /<\?js=([\s\S]+?)\?>/g,
escape: /<\?js~([\s\S]+?)\?>/g
};
}
/**
* Loads template from given file.
* Load a template from a given file.
*
* @param {string} file - Template filename.
* @return {function} Returns template closure.
* @returns {function} A template function.
*/
load(file) {
return _.template(fs.readFileSync(file, 'utf8'), null, this.settings);
}
/**
* Renders template using given data.
*
* This is low-level function, for rendering full templates use {@link Template.render()}.
* Render the given data with the specified template partial.
*
* @private
* @param {string} file - Template filename.
* @param {object} data - Template variables (doesn't have to be object, but passing variables dictionary is best way and most common use).
* @return {string} Rendered template.
* @param {object} data - Template variables.
* @return {string} Rendered data.
*/
partial(file, data) {
file = path.resolve(this.path, file);
@ -56,13 +49,11 @@ class Template {
}
/**
* Renders template with given data.
*
* This method automaticaly applies layout if set.
* Render the given data with the specified template.
*
* @param {string} file - Template filename.
* @param {object} data - Template variables (doesn't have to be object, but passing variables dictionary is best way and most common use).
* @return {string} Rendered template.
* @param {object} data - Template variables.
* @return {string} Rendered data.
*/
render(file, data) {
// main content
@ -77,4 +68,5 @@ class Template {
return content;
}
}
exports.Template = Template;
module.exports = Template;

23
packages/jsdoc-template-original/package-lock.json generated Normal file
View File

@ -0,0 +1,23 @@
{
"name": "@jsdoc/template-original",
"version": "1.0.0",
"lockfileVersion": 1,
"requires": true,
"dependencies": {
"code-prettify": {
"version": "0.1.0",
"resolved": "https://registry.npmjs.org/code-prettify/-/code-prettify-0.1.0.tgz",
"integrity": "sha1-RocMyMGlDQm61TmzOpg9vUqjSx4="
},
"color-themes-for-google-code-prettify": {
"version": "2.0.4",
"resolved": "https://registry.npmjs.org/color-themes-for-google-code-prettify/-/color-themes-for-google-code-prettify-2.0.4.tgz",
"integrity": "sha1-3urPZX/WhXaGR1TU5IbXjf2x54Q="
},
"open-sans-fonts": {
"version": "1.5.0",
"resolved": "https://registry.npmjs.org/open-sans-fonts/-/open-sans-fonts-1.5.0.tgz",
"integrity": "sha512-NvjD5sh6wnuKRCuYRbgy/Gf/ykQWeemJxUb+MM3YKpdTiTdLtrmSJy0rGntA+RivaGIWjpe689d9wR3GfiGdiQ=="
}
}
}

34
packages/jsdoc-template-original/package.json Normal file
View File

@ -0,0 +1,34 @@
{
"name": "@jsdoc/template-original",
"version": "1.0.0",
"description": "An updated version of JSDoc 3's original template.",
"main": "index.js",
"repository": {
"type": "git",
"url": "https://github.com/jsdoc3/jsdoc"
},
"keywords": [
"jsdoc",
"template"
],
"author": {
"name": "Jeff Williams",
"email": "jeffrey.l.williams@gmail.com"
},
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/jsdoc3/jsdoc/issues"
},
"homepage": "https://github.com/jsdoc3/jsdoc#readme",
"dependencies": {
"code-prettify": "^0.1.0",
"color-themes-for-google-code-prettify": "^2.0.4",
"open-sans-fonts": "^1.5.0",
"taffydb": "2.6.2"
},
"greenkeeper": {
"ignore": [
"taffydb"
]
}
}

2
templates/default/static/scripts/linenumber.js → packages/jsdoc-template-original/static/scripts/linenumber.js
View File

@ -1,4 +1,4 @@
/*global document */
/* global document */
(() => {
const source = document.getElementsByClassName('prettyprint source linenums');
let i = 0;

62
templates/default/static/styles/jsdoc-default.css → packages/jsdoc-template-original/static/styles/jsdoc-default.css
View File

@ -2,26 +2,60 @@
font-family: 'Open Sans';
font-weight: normal;
font-style: normal;
src: url('../fonts/OpenSans-Regular-webfont.eot');
src:
local('Open Sans'),
local('OpenSans'),
url('../fonts/OpenSans-Regular-webfont.eot?#iefix') format('embedded-opentype'),
url('../fonts/OpenSans-Regular-webfont.woff') format('woff'),
url('../fonts/OpenSans-Regular-webfont.svg#open_sansregular') format('svg');
src: url('../fonts/OpenSans-Regular.woff2') format('woff2'),
url('../fonts/OpenSans-Regular.woff') format('woff'),
url('../fonts/OpenSans-Regular.ttf') format('truetype'),
url('../fonts/OpenSans-Regular.svg#OpenSansRegular') format('svg');
}
@font-face {
font-family: 'Open Sans';
font-weight: bold;
font-style: normal;
src: url('../fonts/OpenSans-Bold.woff2') format('woff2'),
url('../fonts/OpenSans-Bold.woff') format('woff'),
url('../fonts/OpenSans-Bold.ttf') format('truetype'),
url('../fonts/OpenSans-Bold.svg#OpenSansBold') format('svg');
}
@font-face {
font-family: 'Open Sans';
font-weight: normal;
font-style: italic;
src: url('../fonts/OpenSans-Italic.woff2') format('woff2'),
url('../fonts/OpenSans-Italic.woff') format('woff'),
url('../fonts/OpenSans-Italic.ttf') format('truetype'),
url('../fonts/OpenSans-Italic.svg#OpenSansItalic') format('svg');
}
@font-face {
font-family: 'Open Sans';
font-weight: bold;
font-style: italic;
src: url('../fonts/OpenSans-BoldItalic.woff2') format('woff2'),
url('../fonts/OpenSans-BoldItalic.woff') format('woff'),
url('../fonts/OpenSans-BoldItalic.ttf') format('truetype'),
url('../fonts/OpenSans-BoldItalic.svg#OpenSansBoldItalic') format('svg');
}
@font-face {
font-family: 'Open Sans Light';
font-weight: normal;
font-style: normal;
src: url('../fonts/OpenSans-Light-webfont.eot');
src:
local('Open Sans Light'),
local('OpenSans Light'),
url('../fonts/OpenSans-Light-webfont.eot?#iefix') format('embedded-opentype'),
url('../fonts/OpenSans-Light-webfont.woff') format('woff'),
url('../fonts/OpenSans-Light-webfont.svg#open_sanslight') format('svg');
src: url('../fonts/OpenSans-Light.woff2') format('woff2'),
url('../fonts/OpenSans-Light.woff') format('woff'),
url('../fonts/OpenSans-Light.ttf') format('truetype'),
url('../fonts/OpenSans-Light.svg#OpenSansLight') format('svg');
}
@font-face {
font-family: 'Open Sans Light';
font-weight: normal;
font-style: italic;
src: url('../fonts/OpenSans-LightItalic.woff2') format('woff2'),
url('../fonts/OpenSans-LightItalic.woff') format('woff'),
url('../fonts/OpenSans-LightItalic.ttf') format('truetype'),
url('../fonts/OpenSans-LightItalic.svg#OpenSansLightItalic') format('svg');
}
html

10
packages/jsdoc-template-original/tmpl/augments.tmpl Normal file
View File

@ -0,0 +1,10 @@
<%
var data = obj;
var self = this;
%>
<% if (data.augments && data.augments.length) { %>
<ul><% data.augments.forEach(function(a) { %>
<li><%= self.linkto(a, a) %></li>
<% }) %></ul>
<% } %>

196
packages/jsdoc-template-original/tmpl/container.tmpl Normal file
View File

@ -0,0 +1,196 @@
<%
var self = this;
var isGlobalPage;
docs.forEach(function(doc, i) {
%>
<%
// we only need to check this once
if (typeof isGlobalPage === 'undefined') {
isGlobalPage = (doc.kind === 'globalobj');
}
%>
<% if (doc.kind === 'mainpage' || (doc.kind === 'package')) { %>
<%= self.partial('mainpage.tmpl', doc) %>
<% } else if (doc.kind === 'source') { %>
<%= self.partial('source.tmpl', doc) %>
<% } else { %>
<section>
<header>
<% if (!doc.longname || doc.kind !== 'module') { %>
<h2><% if (doc.attribs) { %><span class="attribs"><%= doc.attribs %></span><% }
if (doc.ancestors && doc.ancestors.length) { %>
<span class="ancestors"><%= doc.ancestors.join('') %></span><%
}
%><%= doc.name %><%
if (doc.variation) { %>
<sup class="variation"><%= doc.variation %></sup><% }
if (doc.signature && !doc.hideconstructor) { %><%= doc.signature %><% } %></h2>
<% if (doc.classdesc) { %>
<div class="class-description"><%= doc.classdesc %></div>
<% } %>
<% } else if (doc.kind === 'module' && doc.modules) { %>
<% doc.modules.forEach(function(module) { %>
<% if (module.classdesc) { %>
<div class="class-description"><%= module.classdesc %></div>
<% } %>
<% }) %>
<% } %>
</header>
<article>
<div class="container-overview">
<% if (doc.kind === 'module' && doc.modules) { %>
<% if (doc.description) { %>
<div class="description"><%= doc.description %></div>
<% } %>
<% doc.modules.forEach(function(module) { %>
<%= self.partial('method.tmpl', module) %>
<% }) %>
<% } else if (doc.kind === 'class' || (doc.kind === 'namespace' && doc.signature)) { %>
<%= self.partial('method.tmpl', doc) %>
<% } else { %>
<% if (doc.description) { %>
<div class="description"><%= doc.description %></div>
<% } %>
<%= self.partial('details.tmpl', doc) %>
<% if (doc.examples && doc.examples.length) { %>
<h3>Example<%= doc.examples.length > 1? 's':'' %></h3>
<%= self.partial('examples.tmpl', doc.examples) %>
<% } %>
<% } %>
</div>
<% if (doc.augments && doc.augments.length) { %>
<h3 class="subsection-title">Extends</h3>
<%= self.partial('augments.tmpl', doc) %>
<% } %>
<% if (doc.requires && doc.requires.length) { %>
<h3 class="subsection-title">Requires</h3>
<ul><% doc.requires.forEach(function(r) { %>
<li><%= self.linkto(r, r) %></li>
<% }); %></ul>
<% } %>
<%
var classes = self.find({kind: 'class', memberof: doc.longname});
if (!isGlobalPage && classes && classes.length) {
%>
<h3 class="subsection-title">Classes</h3>
<dl><% classes.forEach(function(c) { %>
<dt><%= self.linkto(c.longname, c.name) %></dt>
<dd><% if (c.summary) { %><%= c.summary %><% } %></dd>
<% }); %></dl>
<% } %>
<%
var interfaces = self.find({kind: 'interface', memberof: doc.longname});
if (!isGlobalPage && interfaces && interfaces.length) {
%>
<h3 class="subsection-title">Interfaces</h3>
<dl><% interfaces.forEach(function(i) { %>
<dt><%= self.linkto(i.longname, i.name) %></dt>
<dd><% if (i.summary) { %><%= i.summary %><% } %></dd>
<% }); %></dl>
<% } %>
<%
var mixins = self.find({kind: 'mixin', memberof: doc.longname});
if (!isGlobalPage && mixins && mixins.length) {
%>
<h3 class="subsection-title">Mixins</h3>
<dl><% mixins.forEach(function(m) { %>
<dt><%= self.linkto(m.longname, m.name) %></dt>
<dd><% if (m.summary) { %><%= m.summary %><% } %></dd>
<% }); %></dl>
<% } %>
<%
var namespaces = self.find({kind: 'namespace', memberof: doc.longname});
if (!isGlobalPage && namespaces && namespaces.length) {
%>
<h3 class="subsection-title">Namespaces</h3>
<dl><% namespaces.forEach(function(n) { %>
<dt><%= self.linkto(n.longname, n.name) %></dt>
<dd><% if (n.summary) { %><%= n.summary %><% } %></dd>
<% }); %></dl>
<% } %>
<%
var members = self.find({kind: 'member', memberof: isGlobalPage ? {isUndefined: true} : doc.longname});
// symbols that are assigned to module.exports are not globals, even though they're not a memberof anything
if (isGlobalPage && members && members.length && members.forEach) {
members = members.filter(function(m) {
return m.longname && m.longname.indexOf('module:') !== 0;
});
}
if (members && members.length && members.forEach) {
%>
<h3 class="subsection-title">Members</h3>
<% members.forEach(function(p) { %>
<%= self.partial('members.tmpl', p) %>
<% }); %>
<% } %>
<%
var methods = self.find({kind: 'function', memberof: isGlobalPage ? {isUndefined: true} : doc.longname});
if (methods && methods.length && methods.forEach) {
%>
<h3 class="subsection-title">Methods</h3>
<% methods.forEach(function(m) { %>
<%= self.partial('method.tmpl', m) %>
<% }); %>
<% } %>
<%
var typedefs = self.find({kind: 'typedef', memberof: isGlobalPage ? {isUndefined: true} : doc.longname});
if (typedefs && typedefs.length && typedefs.forEach) {
%>
<h3 class="subsection-title">Type Definitions</h3>
<% typedefs.forEach(function(e) {
if (e.signature) {
%>
<%= self.partial('method.tmpl', e) %>
<%
}
else {
%>
<%= self.partial('members.tmpl', e) %>
<%
}
}); %>
<% } %>
<%
var events = self.find({kind: 'event', memberof: isGlobalPage ? {isUndefined: true} : doc.longname});
if (events && events.length && events.forEach) {
%>
<h3 class="subsection-title">Events</h3>
<% events.forEach(function(e) { %>
<%= self.partial('method.tmpl', e) %>
<% }); %>
<% } %>
</article>
</section>
<% } %>
<% }); %>

143
packages/jsdoc-template-original/tmpl/details.tmpl Normal file
View File

@ -0,0 +1,143 @@
<%
var data = obj;
var self = this;
var defaultObjectClass = '';
// Check if the default value is an object or array; if so, apply code highlighting
if (data.defaultvalue && (data.defaultvaluetype === 'object' || data.defaultvaluetype === 'array')) {
data.defaultvalue = "<pre class=\"prettyprint\"><code>" + data.defaultvalue + "</code></pre>";
defaultObjectClass = ' class="object-value"';
}
%>
<%
var properties = data.properties;
if (properties && properties.length && properties.forEach && !data.hideconstructor) {
%>
<h5 class="subsection-title">Properties:</h5>
<%= this.partial('properties.tmpl', data) %>
<% } %>
<dl class="details">
<% if (data.version) {%>
<dt class="tag-version">Version:</dt>
<dd class="tag-version"><ul class="dummy"><li><%= version %></li></ul></dd>
<% } %>
<% if (data.since) {%>
<dt class="tag-since">Since:</dt>
<dd class="tag-since"><ul class="dummy"><li><%= since %></li></ul></dd>
<% } %>
<% if (data.inherited && data.inherits && !data.overrides) { %>
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<%= this.linkto(data.inherits, this.htmlsafe(data.inherits)) %>
</li></ul></dd>
<% } %>
<% if (data.overrides) { %>
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<%= this.linkto(data.overrides, this.htmlsafe(data.overrides)) %>
</li></ul></dd>
<% } %>
<% if (data.implementations && data.implementations.length) { %>
<dt class="implementations">Implementations:</dt>
<dd class="implementations"><ul>
<% data.implementations.forEach(function(impl) { %>
<li><%= self.linkto(impl, self.htmlsafe(impl)) %></li>
<% }); %>
</ul></dd>
<% } %>
<% if (data.implements && data.implements.length) { %>
<dt class="implements">Implements:</dt>
<dd class="implements"><ul>
<% data.implements.forEach(function(impl) { %>
<li><%= self.linkto(impl, self.htmlsafe(impl)) %></li>
<% }); %>
</ul></dd>
<% } %>
<% if (data.mixes && data.mixes.length) { %>
<dt class="mixes">Mixes In:</dt>
<dd class="mixes"><ul>
<% data.mixes.forEach(function(a) { %>
<li><%= self.linkto(a, a) %></li>
<% }); %>
</ul></dd>
<% } %>
<% if (data.deprecated) { %>
<dt class="important tag-deprecated">Deprecated:</dt><%
if (data.deprecated === true) { %><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd><% }
else { %><dd><ul class="dummy"><li><%= data.deprecated %></li></ul></dd><% }
%>
<% } %>
<% if (data.author && author.length) {%>
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul><% author.forEach(function(a) { %>
<li><%= self.resolveAuthorLinks(a) %></li>
<% }); %></ul>
</dd>
<% } %>
<% if (data.copyright) {%>
<dt class="tag-copyright">Copyright:</dt>
<dd class="tag-copyright"><ul class="dummy"><li><%= copyright %></li></ul></dd>
<% } %>
<% if (data.license) {%>
<dt class="tag-license">License:</dt>
<dd class="tag-license"><ul class="dummy"><li><%= license %></li></ul></dd>
<% } %>
<% if (data.defaultvalue) {%>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li<%= defaultObjectClass %>><%= data.defaultvalue %></li>
</ul></dd>
<% } %>
<% if (data.meta && self.outputSourceFiles) {%>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<%= self.linkto(meta.shortpath) %>, <%= self.linkto(meta.shortpath, 'line ' + meta.lineno, null, 'line' + meta.lineno) %>
</li></ul></dd>
<% } %>
<% if (data.tutorials && tutorials.length) {%>
<dt class="tag-tutorial">Tutorials:</dt>
<dd class="tag-tutorial">
<ul><% tutorials.forEach(function(t) { %>
<li><%= self.tutoriallink(t) %></li>
<% }); %></ul>
</dd>
<% } %>
<% if (data.see && see.length) {%>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul><% see.forEach(function(s) { %>
<li><%= self.linkto(s) %></li>
<% }); %></ul>
</dd>
<% } %>
<% if (data.todo && todo.length) {%>
<dt class="tag-todo">To Do:</dt>
<dd class="tag-todo">
<ul><% todo.forEach(function(t) { %>
<li><%= t %></li>
<% }); %></ul>
</dd>
<% } %>
</dl>

2
packages/jsdoc-template-original/tmpl/example.tmpl Normal file
View File

@ -0,0 +1,2 @@
<% var data = obj; %>
<pre><code><%= data %></code></pre>

13
packages/jsdoc-template-original/tmpl/examples.tmpl Normal file
View File

@ -0,0 +1,13 @@
<%
var data = obj;
var self = this;
data.forEach(function(example) {
if (example.caption) {
%>
<p class="code-caption"><%= example.caption %></p>
<% } %>
<pre class="prettyprint"><code><%= self.htmlsafe(example.code) %></code></pre>
<%
});
%>

32
packages/jsdoc-template-original/tmpl/exceptions.tmpl Normal file
View File

@ -0,0 +1,32 @@
<%
var data = obj;
%>
<% if (data.description && data.type && data.type.names) { %>
<dl>
<dt>
<div class="param-desc">
<%= data.description %>
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<%= this.partial('type.tmpl', data.type.names) %>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<% } else { %>
<div class="param-desc">
<% if (data.description) { %>
<%= data.description %>
<% } else if (data.type && data.type.names) { %>
<%= this.partial('type.tmpl', data.type.names) %>
<% } %>
</div>
<% } %>

12
templates/default/tmpl/layout.tmpl → packages/jsdoc-template-original/tmpl/layout.tmpl
View File

@ -2,14 +2,14 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: <?js= title ?></title>
<title>JSDoc: <%= title %></title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/tomorrow.min.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
@ -17,19 +17,19 @@
<div id="main">
<h1 class="page-title"><?js= title ?></h1>
<h1 class="page-title"><%= title %></h1>
<?js= content ?>
<%= content %>
</div>
<nav>
<?js= this.nav ?>
<%= this.nav %>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc <?js= env.version.number ?></a><?js if(env.conf.templates && env.conf.templates.default && env.conf.templates.default.includeDate !== false) { ?> on <?js= (new Date()) ?><?js } ?>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc <%= env.version.number %></a><% if(env.conf.templates && env.conf.templates.default && env.conf.templates.default.includeDate !== false) { %> on <%= (new Date()) %><% } %>
</footer>
<script> prettyPrint(); </script>

14
packages/jsdoc-template-original/tmpl/mainpage.tmpl Normal file
View File

@ -0,0 +1,14 @@
<%
var data = obj;
var self = this;
%>
<% if (data.kind === 'package') { %>
<h3><%= data.name %> <%= data.version %></h3>
<% } %>
<% if (data.readme) { %>
<section>
<article><%= data.readme %></article>
</section>
<% } %>

38
packages/jsdoc-template-original/tmpl/members.tmpl Normal file
View File

@ -0,0 +1,38 @@
<%
var data = obj;
var self = this;
%>
<h4 class="name" id="<%= id %>"><%= data.attribs + name + (data.signature ? data.signature : '') %></h4>
<% if (data.summary) { %>
<p class="summary"><%= summary %></p>
<% } %>
<% if (data.description) { %>
<div class="description">
<%= data.description %>
</div>
<% } %>
<% if (data.type && data.type.names) {%>
<h5>Type:</h5>
<ul>
<li>
<%= self.partial('type.tmpl', data.type.names) %>
</li>
</ul>
<% } %>
<%= this.partial('details.tmpl', data) %>
<% if (data.fires && fires.length) { %>
<h5>Fires:</h5>
<ul><% fires.forEach(function(f) { %>
<li><%= self.linkto(f) %></li>
<% }); %></ul>
<% } %>
<% if (data.examples && examples.length) { %>
<h5>Example<%= examples.length > 1? 's':'' %></h5>
<%= this.partial('examples.tmpl', examples) %>
<% } %>

131
packages/jsdoc-template-original/tmpl/method.tmpl Normal file
View File

@ -0,0 +1,131 @@
<%
var data = obj;
var self = this;
%>
<% if (data.kind !== 'module' && !data.hideconstructor) { %>
<% if (data.kind === 'class' && data.classdesc) { %>
<h2>Constructor</h2>
<% } %>
<% if (data.kind !== 'namespace') { %>
<h4 class="name" id="<%= id %>"><%= data.attribs + (kind === 'class' ? 'new ' : '') +
name + (data.signature || '') %></h4>
<% } %>
<% if (data.summary) { %>
<p class="summary"><%= summary %></p>
<% } %>
<% } %>
<% if (data.kind !== 'module' && data.description && !data.hideconstructor) { %>
<div class="description">
<%= data.description %>
</div>
<% } %>
<% if (data.augments && data.alias && data.alias.indexOf('module:') === 0) { %>
<h5>Extends:</h5>
<%= self.partial('augments.tmpl', data) %>
<% } %>
<% if (kind === 'event' && data.type && data.type.names) {%>
<h5>Type:</h5>
<ul>
<li>
<%= self.partial('type.tmpl', data.type.names) %>
</li>
</ul>
<% } %>
<% if (data['this']) { %>
<h5>This:</h5>
<ul><li><%= this.linkto(data['this'], data['this']) %></li></ul>
<% } %>
<% if (data.params && params.length && !data.hideconstructor) { %>
<h5>Parameters:</h5>
<%= this.partial('params.tmpl', params) %>
<% } %>
<%= this.partial('details.tmpl', data) %>
<% if (data.kind !== 'module' && data.requires && data.requires.length) { %>
<h5>Requires:</h5>
<ul><% data.requires.forEach(function(r) { %>
<li><%= self.linkto(r) %></li>
<% }); %></ul>
<% } %>
<% if (data.fires && fires.length) { %>
<h5>Fires:</h5>
<ul><% fires.forEach(function(f) { %>
<li><%= self.linkto(f) %></li>
<% }); %></ul>
<% } %>
<% if (data.listens && listens.length) { %>
<h5>Listens to Events:</h5>
<ul><% listens.forEach(function(f) { %>
<li><%= self.linkto(f) %></li>
<% }); %></ul>
<% } %>
<% if (data.listeners && listeners.length) { %>
<h5>Listeners of This Event:</h5>
<ul><% listeners.forEach(function(f) { %>
<li><%= self.linkto(f) %></li>
<% }); %></ul>
<% } %>
<% if (data.modifies && modifies.length) {%>
<h5>Modifies:</h5>
<% if (modifies.length > 1) { %><ul><%
modifies.forEach(function(m) { %>
<li><%= self.partial('modifies.tmpl', m) %></li>
<% });
%></ul><% } else {
modifies.forEach(function(m) { %>
<%= self.partial('modifies.tmpl', m) %>
<% });
} } %>
<% if (data.exceptions && exceptions.length) { %>
<h5>Throws:</h5>
<% if (exceptions.length > 1) { %><ul><%
exceptions.forEach(function(r) { %>
<li><%= self.partial('exceptions.tmpl', r) %></li>
<% });
%></ul><% } else {
exceptions.forEach(function(r) { %>
<%= self.partial('exceptions.tmpl', r) %>
<% });
} } %>
<% if (data.returns && returns.length) { %>
<h5>Returns:</h5>
<% if (returns.length > 1) { %><ul><%
returns.forEach(function(r) { %>
<li><%= self.partial('returns.tmpl', r) %></li>
<% });
%></ul><% } else {
returns.forEach(function(r) { %>
<%= self.partial('returns.tmpl', r) %>
<% });
} } %>
<% if (data.yields && yields.length) { %>
<h5>Yields:</h5>
<% if (yields.length > 1) { %><ul><%
yields.forEach(function(r) { %>
<li><%= self.partial('returns.tmpl', r) %></li>
<% });
%></ul><% } else {
yields.forEach(function(r) { %>
<%= self.partial('returns.tmpl', r) %>
<% });
} } %>
<% if (data.examples && examples.length) { %>
<h5>Example<%= examples.length > 1? 's':'' %></h5>
<%= this.partial('examples.tmpl', examples) %>
<% } %>

14
packages/jsdoc-template-original/tmpl/modifies.tmpl Normal file
View File

@ -0,0 +1,14 @@
<%
var data = obj || {};
%>
<% if (data.type && data.type.names) {%>
<dl>
<dt>
Type
</dt>
<dd>
<%= this.partial('type.tmpl', data.type.names) %>
</dd>
</dl>
<% } %>

66
templates/default/tmpl/params.tmpl → packages/jsdoc-template-original/tmpl/params.tmpl
View File

@ -1,4 +1,4 @@
<?js
<%
var params = obj;
/* sort subparams under their parent params (like opts.classname) */
@ -55,77 +55,77 @@
params.hasDefault = true;
}
});
?>
%>
<table class="params">
<thead>
<tr>
<?js if (params.hasName) {?>
<% if (params.hasName) {%>
<th>Name</th>
<?js } ?>
<% } %>
<th>Type</th>
<?js if (params.hasAttributes) {?>
<% if (params.hasAttributes) {%>
<th>Attributes</th>
<?js } ?>
<% } %>
<?js if (params.hasDefault) {?>
<% if (params.hasDefault) {%>
<th>Default</th>
<?js } ?>
<% } %>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<?js
<%
var self = this;
params.forEach(function(param) {
if (!param) { return; }
?>
%>
<tr>
<?js if (params.hasName) {?>
<td class="name"><code><?js= param.name ?></code></td>
<?js } ?>
<% if (params.hasName) {%>
<td class="name"><code><%= param.name %></code></td>
<% } %>
<td class="type">
<?js if (param.type && param.type.names) {?>
<?js= self.partial('type.tmpl', param.type.names) ?>
<?js } ?>
<% if (param.type && param.type.names) {%>
<%= self.partial('type.tmpl', param.type.names) %>
<% } %>
</td>
<?js if (params.hasAttributes) {?>
<% if (params.hasAttributes) {%>
<td class="attributes">
<?js if (param.optional) { ?>
<% if (param.optional) { %>
&lt;optional><br>
<?js } ?>
<% } %>
<?js if (param.nullable) { ?>
<% if (param.nullable) { %>
&lt;nullable><br>
<?js } ?>
<% } %>
<?js if (param.variable) { ?>
<% if (param.variable) { %>
&lt;repeatable><br>
<?js } ?>
<% } %>
</td>
<?js } ?>
<% } %>
<?js if (params.hasDefault) {?>
<% if (params.hasDefault) {%>
<td class="default">
<?js if (typeof param.defaultvalue !== 'undefined') { ?>
<?js= self.htmlsafe(param.defaultvalue) ?>
<?js } ?>
<% if (typeof param.defaultvalue !== 'undefined') { %>
<%= self.htmlsafe(param.defaultvalue) %>
<% } %>
</td>
<?js } ?>
<% } %>
<td class="description last"><?js= param.description ?><?js if (param.subparams) { ?>
<td class="description last"><%= param.description %><% if (param.subparams) { %>
<h6>Properties</h6>
<?js= self.partial('params.tmpl', param.subparams) ?>
<?js } ?></td>
<%= self.partial('params.tmpl', param.subparams) %>
<% } %></td>
</tr>
<?js }); ?>
<% }); %>
</tbody>
</table>

62
templates/default/tmpl/properties.tmpl → packages/jsdoc-template-original/tmpl/properties.tmpl
View File

@ -1,4 +1,4 @@
<?js
<%
var data = obj;
var props = data.subprops || data.properties;
@ -37,72 +37,72 @@
props.hasDefault = true;
}
});
?>
%>
<table class="props">
<thead>
<tr>
<?js if (props.hasName) {?>
<% if (props.hasName) {%>
<th>Name</th>
<?js } ?>
<% } %>
<th>Type</th>
<?js if (props.hasAttributes) {?>
<% if (props.hasAttributes) {%>
<th>Attributes</th>
<?js } ?>
<% } %>
<?js if (props.hasDefault) {?>
<% if (props.hasDefault) {%>
<th>Default</th>
<?js } ?>
<% } %>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<?js
<%
var self = this;
props.forEach(function(prop) {
if (!prop) { return; }
?>
%>
<tr>
<?js if (props.hasName) {?>
<td class="name"><code><?js= prop.name ?></code></td>
<?js } ?>
<% if (props.hasName) {%>
<td class="name"><code><%= prop.name %></code></td>
<% } %>
<td class="type">
<?js if (prop.type && prop.type.names) {?>
<?js= self.partial('type.tmpl', prop.type.names) ?>
<?js } ?>
<% if (prop.type && prop.type.names) {%>
<%= self.partial('type.tmpl', prop.type.names) %>
<% } %>
</td>
<?js if (props.hasAttributes) {?>
<% if (props.hasAttributes) {%>
<td class="attributes">
<?js if (prop.optional) { ?>
<% if (prop.optional) { %>
&lt;optional><br>
<?js } ?>
<% } %>
<?js if (prop.nullable) { ?>
<% if (prop.nullable) { %>
&lt;nullable><br>
<?js } ?>
<% } %>
</td>
<?js } ?>
<% } %>
<?js if (props.hasDefault) {?>
<% if (props.hasDefault) {%>
<td class="default">
<?js if (typeof prop.defaultvalue !== 'undefined') { ?>
<?js= self.htmlsafe(prop.defaultvalue) ?>
<?js } ?>
<% if (typeof prop.defaultvalue !== 'undefined') { %>
<%= self.htmlsafe(prop.defaultvalue) %>
<% } %>
</td>
<?js } ?>
<% } %>
<td class="description last"><?js= prop.description ?><?js if (prop.subprops) { ?>
<h6>Properties</h6><?js= self.partial('properties.tmpl', prop) ?>
<?js } ?></td>
<td class="description last"><%= prop.description %><% if (prop.subprops) { %>
<h6>Properties</h6><%= self.partial('properties.tmpl', prop) %>
<% } %></td>
</tr>
<?js }); ?>
<% }); %>
</tbody>
</table>

19
packages/jsdoc-template-original/tmpl/returns.tmpl Normal file
View File

@ -0,0 +1,19 @@
<%
var data = obj || {};
if (data.description) {
%>
<div class="param-desc">
<%= description %>
</div>
<% } %>
<% if (data.type && data.type.names) {%>
<dl>
<dt>
Type
</dt>
<dd>
<%= this.partial('type.tmpl', data.type.names) %>
</dd>
</dl>
<% } %>

8
packages/jsdoc-template-original/tmpl/source.tmpl Normal file
View File

@ -0,0 +1,8 @@
<%
var data = obj;
%>
<section>
<article>
<pre class="prettyprint source linenums"><code><%= data.code %></code></pre>
</article>
</section>

19
packages/jsdoc-template-original/tmpl/tutorial.tmpl Normal file
View File

@ -0,0 +1,19 @@
<section>
<header>
<% if (children.length > 0) { %>
<ul><%
var self = this;
children.forEach(function(t) { %>
<li><%= self.tutoriallink(t.name) %></li>
<% }); %></ul>
<% } %>
<h2><%= header %></h2>
</header>
<article>
<%= content %>
</article>
</section>

7
packages/jsdoc-template-original/tmpl/type.tmpl Normal file
View File

@ -0,0 +1,7 @@
<%
var data = obj;
var self = this;
data.forEach(function(name, i) { %>
<span class="param-type"><%= self.linkto(name, self.htmlsafe(name)) %></span>
<% if (i < data.length-1) { %>|<% } %>
<% }); %>

28
packages/jsdoc-template-silent/README.md Normal file
View File

@ -0,0 +1,28 @@
# @jsdoc/template-silent
A JSDoc template that generates no output.
Why would that be useful? Primarily for running JSDoc as a linter to check for
syntax errors and unrecognized tags in documentation comments.
## Installing the package
Using npm:
```shell
npm install --save @jsdoc/template-silent
```
## Using the package
The following command exits with a non-zero exit code if any errors are
encountered. It writes nothing to disk, and the only output it produces is any
error messages written to `stderr`:
jsdoc myscript.js -t templates/silent -a all --pedantic
To get warnings about tags that JSDoc does not recognize, create a configuration
file called `conf.json` that sets `"allowUnknownTags": false`, then run the
following command:
jsdoc myscript.js -t templates/silent -a all -c conf.json --pedantic

2
packages/jsdoc-template-silent/index.js Normal file
View File

@ -0,0 +1,2 @@
/* eslint-disable no-empty-function */
exports.publish = () => {};

23
packages/jsdoc-template-silent/package.json Normal file
View File

@ -0,0 +1,23 @@
{
"name": "@jsdoc/template-silent",
"version": "1.0.0",
"description": "A JSDoc template that generates no output.",
"main": "index.js",
"repository": {
"type": "git",
"url": "https://github.com/jsdoc3/jsdoc"
},
"keywords": [
"jsdoc",
"template"
],
"author": {
"name": "Jeff Williams",
"email": "jeffrey.l.williams@gmail.com"
},
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/jsdoc3/jsdoc/issues"
},
"homepage": "https://github.com/jsdoc3/jsdoc#readme"
}

27
templates/README.md
View File

@ -1,27 +0,0 @@
To create or use your own template:
1. Create a folder with the same name as your template (for example, `mycooltemplate`).
2. Within the template folder, create a file named `publish.js`. This file must be a CommonJS module that exports a method named `publish`.
For example:
````javascript
/** @module publish */
/**
* Generate documentation output.
*
* @param {TAFFY} data - A TaffyDB collection representing
* all the symbols documented in your code.
* @param {object} opts - An object with options information.
*/
exports.publish = function(data, opts) {
// do stuff here to generate your output files
};
````
To invoke JSDoc 3 with your own template, use the `-t` command line option, and specify the path to your template folder:
````
./jsdoc mycode.js -t /path/to/mycooltemplate
````

12
templates/default/README.md
View File

@ -1,12 +0,0 @@
The default template for JSDoc 3 uses: [the Taffy Database library](http://taffydb.com/) and the [Underscore Template library](http://underscorejs.org/).
## Generating Typeface Fonts
The default template uses the [OpenSans](https://www.google.com/fonts/specimen/Open+Sans) typeface. The font files can be regenerated as follows:
1. Open the [OpenSans page at Font Squirrel](<http://www.fontsquirrel.com/fonts/open-sans>).
2. Click on the 'Webfont Kit' tab.
3. Either leave the subset drop-down as 'Western Latin (Default)', or, if we decide we need more glyphs, than change it to 'No Subsetting'.
4. Click the 'DOWNLOAD @FONT-FACE KIT' button.
5. For each typeface variant we plan to use, copy the 'eot', 'svg' and 'woff' files into the 'templates/default/static/fonts' directory.

BIN
templates/default/static/fonts/OpenSans-Bold-webfont.eot
View File

Binary file not shown.

1830
templates/default/static/fonts/OpenSans-Bold-webfont.svg
View File

File diff suppressed because it is too large Load Diff
Side by Side

Before

Width:  |  Height:  |  Size: 116 KiB

BIN
templates/default/static/fonts/OpenSans-Bold-webfont.woff
View File

Binary file not shown.

BIN
templates/default/static/fonts/OpenSans-BoldItalic-webfont.eot
View File

Binary file not shown.

1830
templates/default/static/fonts/OpenSans-BoldItalic-webfont.svg
View File

File diff suppressed because it is too large Load Diff
Side by Side

Before

Width:  |  Height:  |  Size: 118 KiB

BIN
templates/default/static/fonts/OpenSans-BoldItalic-webfont.woff
View File

Binary file not shown.

BIN
templates/default/static/fonts/OpenSans-Italic-webfont.eot
View File

Binary file not shown.

1830
templates/default/static/fonts/OpenSans-Italic-webfont.svg
View File

File diff suppressed because it is too large Load Diff
Side by Side

Before

Width:  |  Height:  |  Size: 120 KiB

BIN
templates/default/static/fonts/OpenSans-Italic-webfont.woff
View File

Binary file not shown.

BIN
templates/default/static/fonts/OpenSans-Light-webfont.eot
View File

Binary file not shown.

1831
templates/default/static/fonts/OpenSans-Light-webfont.svg
View File

File diff suppressed because it is too large Load Diff
Side by Side

Before

Width:  |  Height:  |  Size: 114 KiB

BIN
templates/default/static/fonts/OpenSans-Light-webfont.woff
View File

Binary file not shown.

BIN
templates/default/static/fonts/OpenSans-LightItalic-webfont.eot
View File

Binary file not shown.

1835
templates/default/static/fonts/OpenSans-LightItalic-webfont.svg
View File

File diff suppressed because it is too large Load Diff
Side by Side

Before

Width:  |  Height:  |  Size: 120 KiB

BIN
templates/default/static/fonts/OpenSans-LightItalic-webfont.woff
View File

Binary file not shown.

BIN
templates/default/static/fonts/OpenSans-Regular-webfont.eot
View File

Binary file not shown.

1831
templates/default/static/fonts/OpenSans-Regular-webfont.svg
View File

File diff suppressed because it is too large Load Diff
Side by Side

Before

Width:  |  Height:  |  Size: 117 KiB

BIN
templates/default/static/fonts/OpenSans-Regular-webfont.woff
View File

Binary file not shown.

202
templates/default/static/scripts/prettify/Apache-License-2.0.txt
View File

@ -1,202 +0,0 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

2
templates/default/static/scripts/prettify/lang-css.js
View File

@ -1,2 +0,0 @@
PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\t\n\f\r ]+/,null," \t\r\n "]],[["str",/^"(?:[^\n\f\r"\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*"/,null],["str",/^'(?:[^\n\f\r'\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*'/,null],["lang-css-str",/^url\(([^"')]*)\)/i],["kwd",/^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\w-]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*)\s*:/i],["com",/^\/\*[^*]*\*+(?:[^*/][^*]*\*+)*\//],["com",
/^(?:<\!--|--\>)/],["lit",/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],["lit",/^#[\da-f]{3,6}/i],["pln",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i],["pun",/^[^\s\w"']+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[["kwd",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[["str",/^[^"')]+/]]),["css-str"]);

28
templates/default/static/scripts/prettify/prettify.js
View File

@ -1,28 +0,0 @@
var q=null;window.PR_SHOULD_USE_CONTINUATION=!0;
(function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:"0"<=b&&b<="7"?parseInt(a.substring(1),8):b==="u"||b==="x"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?"\\x0":"\\x")+a.toString(16);a=String.fromCharCode(a);if(a==="\\"||a==="-"||a==="["||a==="]")a="\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),a=
[],b=[],o=f[0]==="^",c=o?1:0,i=f.length;c<i;++c){var j=f[c];if(/\\[bdsw]/i.test(j))a.push(j);else{var j=m(j),d;c+2<i&&"-"===f[c+1]?(d=m(f[c+2]),c+=2):d=j;b.push([j,d]);d<65||j>122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;c<b.length;++c)i=b[c],i[0]<=j[1]+1?j[1]=Math.max(j[1],i[1]):f.push(j=i);b=["["];o&&b.push("^");b.push.apply(b,a);for(c=0;c<
f.length;++c)i=f[c],b.push(e(i[0])),i[1]>i[0]&&(i[1]+1>i[0]&&b.push("-"),b.push(e(i[1])));b.push("]");return b.join("")}function y(a){for(var f=a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),b=f.length,d=[],c=0,i=0;c<b;++c){var j=f[c];j==="("?++i:"\\"===j.charAt(0)&&(j=+j.substring(1))&&j<=i&&(d[j]=-1)}for(c=1;c<d.length;++c)-1===d[c]&&(d[c]=++t);for(i=c=0;c<b;++c)j=f[c],j==="("?(++i,d[i]===void 0&&(f[c]="(?:")):"\\"===j.charAt(0)&&
(j=+j.substring(1))&&j<=i&&(f[c]="\\"+d[i]);for(i=c=0;c<b;++c)"^"===f[c]&&"^"!==f[c+1]&&(f[c]="");if(a.ignoreCase&&s)for(c=0;c<b;++c)j=f[c],a=j.charAt(0),j.length>=2&&a==="["?f[c]=h(j):a!=="\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return f.join("")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p<d;++p){var g=a[p];if(g.ignoreCase)l=!0;else if(/[a-z]/i.test(g.source.replace(/\\u[\da-f]{4}|\\x[\da-f]{2}|\\[^UXux]/gi,""))){s=!0;l=!1;break}}for(var r=
{b:8,t:9,n:10,v:11,f:12,r:13},n=[],p=0,d=a.length;p<d;++p){g=a[p];if(g.global||g.multiline)throw Error(""+g);n.push("(?:"+y(g)+")")}return RegExp(n.join("|"),l?"gi":"g")}function M(a){function m(a){switch(a.nodeType){case 1:if(e.test(a.className))break;for(var g=a.firstChild;g;g=g.nextSibling)m(g);g=a.nodeName;if("BR"===g||"LI"===g)h[s]="\n",t[s<<1]=y++,t[s++<<1|1]=a;break;case 3:case 4:g=a.nodeValue,g.length&&(g=p?g.replace(/\r\n?/g,"\n"):g.replace(/[\t\n\r ]+/g," "),h[s]=g,t[s<<1]=y,y+=g.length,
t[s++<<1|1]=a)}}var e=/(?:^|\s)nocode(?:\s|$)/,h=[],y=0,t=[],s=0,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=document.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);m(a);return{a:h.join("").replace(/\n$/,""),c:t}}function B(a,m,e,h){m&&(a={a:m,d:a},e(a),h.push.apply(h,a.e))}function x(a,m){function e(a){for(var l=a.d,p=[l,"pln"],d=0,g=a.a.match(y)||[],r={},n=0,z=g.length;n<z;++n){var f=g[n],b=r[f],o=void 0,c;if(typeof b===
"string")c=!1;else{var i=h[f.charAt(0)];if(i)o=f.match(i[1]),b=i[0];else{for(c=0;c<t;++c)if(i=m[c],o=f.match(i[1])){b=i[0];break}o||(b="pln")}if((c=b.length>=5&&"lang-"===b.substring(0,5))&&!(o&&typeof o[1]==="string"))c=!1,b="src";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m),
l=[],p={},d=0,g=e.length;d<g;++d){var r=e[d],n=r[3];if(n)for(var k=n.length;--k>=0;)h[n.charAt(k)]=r;r=r[1];n=""+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\S\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?m.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/,
q,"'\"`"]):m.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&e.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):m.push(["com",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),e.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,q])):m.push(["com",/^#[^\n\r]*/,
q,"#"]));a.cStyleComments&&(e.push(["com",/^\/\/[^\n\r]*/,q]),e.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));a.regexLiterals&&e.push(["lang-regex",/^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);(h=a.types)&&e.push(["typ",h]);a=(""+a.keywords).replace(/^ | $/g,
"");a.length&&e.push(["kwd",RegExp("^(?:"+a.replace(/[\s,]+/g,"|")+")\\b"),q]);m.push(["pln",/^\s+/,q," \r\n\t\xa0"]);e.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,q],["pun",/^.[^\s\w"-$'./@\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if("BR"===a.nodeName)h(a),
a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e}
for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\s)nocode(?:\s|$)/,t=/\r\n?|\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);for(l=s.createElement("LI");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g<d.length;++g)e(d[g]);m===(m|0)&&d[0].setAttribute("value",
m);var r=s.createElement("OL");r.className="linenums";for(var n=Math.max(0,m-1|0)||0,g=0,z=d.length;g<z;++g)l=d[g],l.className="L"+(g+n)%10,l.firstChild||l.appendChild(s.createTextNode("\xa0")),r.appendChild(l);a.appendChild(r)}function k(a,m){for(var e=m.length;--e>=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn("cannot override language handler %s",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\s*</.test(m)?"default-markup":"default-code";return A[a]}function E(a){var m=
a.g;try{var e=M(a.h),h=e.a;a.a=h;a.c=e.c;a.d=0;C(m,h)(a);var k=/\bMSIE\b/.test(navigator.userAgent),m=/\n/g,t=a.a,s=t.length,e=0,l=a.c,p=l.length,h=0,d=a.e,g=d.length,a=0;d[g]=s;var r,n;for(n=r=0;n<g;)d[n]!==d[n+2]?(d[r++]=d[n++],d[r++]=d[n++]):n+=2;g=r;for(n=r=0;n<g;){for(var z=d[n],f=d[n+1],b=n+2;b+2<=g&&d[b+1]===f;)b+=2;d[r++]=z;d[r++]=f;n=b}for(d.length=r;h<p;){var o=l[h+2]||s,c=d[a+2]||s,b=Math.min(o,c),i=l[h+1],j;if(i.nodeType!==1&&(j=t.substring(e,b))){k&&(j=j.replace(m,"\r"));i.nodeValue=
j;var u=i.ownerDocument,v=u.createElement("SPAN");v.className=d[a+1];var x=i.parentNode;x.replaceChild(v,i);v.appendChild(i);e<o&&(l[h+1]=i=u.createTextNode(t.substring(b,o)),x.insertBefore(i,v.nextSibling))}e=b;e>=o&&(h+=2);e>=c&&(a+=2)}}catch(w){"console"in window&&console.log(w&&w.stack?w.stack:w)}}var v=["break,continue,do,else,for,if,return,while"],w=[[v,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"],
"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],F=[w,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],G=[w,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"],
H=[G,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],w=[w,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],I=[v,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"],
J=[v,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],v=[v,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,N=/\S/,O=u({keywords:[F,H,w,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END"+
I,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,["default-code"]);k(x([],[["pln",/^[^<?]+/],["dec",/^<!\w[^>]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",/^<xmp\b[^>]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^<script\b[^>]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^<style\b[^>]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]),
["default-markup","htm","html","mxml","xhtml","xml","xsl"]);k(x([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css",
/^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);k(x([],[["atv",/^[\S\s]+/]]),["uq.val"]);k(u({keywords:F,hashComments:!0,cStyleComments:!0,types:K}),["c","cc","cpp","cxx","cyc","m"]);k(u({keywords:"null,true,false"}),["json"]);k(u({keywords:H,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:K}),["cs"]);k(u({keywords:G,cStyleComments:!0}),["java"]);k(u({keywords:v,hashComments:!0,multiLineStrings:!0}),["bsh","csh","sh"]);k(u({keywords:I,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}),
["cv","py"]);k(u({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["perl","pl","pm"]);k(u({keywords:J,hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb"]);k(u({keywords:w,cStyleComments:!0,regexLiterals:!0}),["js"]);k(u({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes",
hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);k(x([],[["str",/^[\S\s]+/]]),["regex"]);window.prettyPrintOne=function(a,m,e){var h=document.createElement("PRE");h.innerHTML=a;e&&D(h,e);E({g:m,i:e,h:h});return h.innerHTML};window.prettyPrint=function(a){function m(){for(var e=window.PR_SHOULD_USE_CONTINUATION?l.now()+250:Infinity;p<h.length&&l.now()<e;p++){var n=h[p],k=n.className;if(k.indexOf("prettyprint")>=0){var k=k.match(g),f,b;if(b=
!k){b=n;for(var o=void 0,c=b.firstChild;c;c=c.nextSibling)var i=c.nodeType,o=i===1?o?b:c:i===3?N.test(c.nodeValue)?b:o:o;b=(f=o===b?void 0:o)&&"CODE"===f.tagName}b&&(k=f.className.match(g));k&&(k=k[1]);b=!1;for(o=n.parentNode;o;o=o.parentNode)if((o.tagName==="pre"||o.tagName==="code"||o.tagName==="xmp")&&o.className&&o.className.indexOf("prettyprint")>=0){b=!0;break}b||((b=(b=n.className.match(/\blinenums\b(?::(\d+))?/))?b[1]&&b[1].length?+b[1]:!0:!1)&&D(n,b),d={g:k,h:n,i:b},E(d))}}p<h.length?setTimeout(m,
250):a&&a()}for(var e=[document.getElementsByTagName("pre"),document.getElementsByTagName("code"),document.getElementsByTagName("xmp")],h=[],k=0;k<e.length;++k)for(var t=0,s=e[k].length;t<s;++t)h.push(e[k][t]);var e=q,l=Date;l.now||(l={now:function(){return+new Date}});var p=0,d,g=/\blang(?:uage)?-([\w.]+)(?!\S)/;m()};window.PR={createSimpleLexer:x,registerLangHandler:k,sourceDecorator:u,PR_ATTRIB_NAME:"atn",PR_ATTRIB_VALUE:"atv",PR_COMMENT:"com",PR_DECLARATION:"dec",PR_KEYWORD:"kwd",PR_LITERAL:"lit",
PR_NOCODE:"nocode",PR_PLAIN:"pln",PR_PUNCTUATION:"pun",PR_SOURCE:"src",PR_STRING:"str",PR_TAG:"tag",PR_TYPE:"typ"}})();

111
templates/default/static/styles/prettify-jsdoc.css
View File

@ -1,111 +0,0 @@
/* JSDoc prettify.js theme */
/* plain text */
.pln {
color: #000000;
font-weight: normal;
font-style: normal;
}
/* string content */
.str {
color: #006400;
font-weight: normal;
font-style: normal;
}
/* a keyword */
.kwd {
color: #000000;
font-weight: bold;
font-style: normal;
}
/* a comment */
.com {
font-weight: normal;
font-style: italic;
}
/* a type name */
.typ {
color: #000000;
font-weight: normal;
font-style: normal;
}
/* a literal value */
.lit {
color: #006400;
font-weight: normal;
font-style: normal;
}
/* punctuation */
.pun {
color: #000000;
font-weight: bold;
font-style: normal;
}
/* lisp open bracket */
.opn {
color: #000000;
font-weight: bold;
font-style: normal;
}
/* lisp close bracket */
.clo {
color: #000000;
font-weight: bold;
font-style: normal;
}
/* a markup tag name */
.tag {
color: #006400;
font-weight: normal;
font-style: normal;
}
/* a markup attribute name */
.atn {
color: #006400;
font-weight: normal;
font-style: normal;
}
/* a markup attribute value */
.atv {
color: #006400;
font-weight: normal;
font-style: normal;
}
/* a declaration */
.dec {
color: #000000;
font-weight: bold;
font-style: normal;
}
/* a variable name */
.var {
color: #000000;
font-weight: normal;
font-style: normal;
}
/* a function name */
.fun {
color: #000000;
font-weight: bold;
font-style: normal;
}
/* Specify class=linenums on a pre to get line numbering */
ol.linenums {
margin-top: 0;
margin-bottom: 0;
}

132
templates/default/static/styles/prettify-tomorrow.css
View File

@ -1,132 +0,0 @@
/* Tomorrow Theme */
/* Original theme - https://github.com/chriskempson/tomorrow-theme */
/* Pretty printing styles. Used with prettify.js. */
/* SPAN elements with the classes below are added by prettyprint. */
/* plain text */
.pln {
color: #4d4d4c; }
@media screen {
/* string content */
.str {
color: #718c00; }
/* a keyword */
.kwd {
color: #8959a8; }
/* a comment */
.com {
color: #8e908c; }
/* a type name */
.typ {
color: #4271ae; }
/* a literal value */
.lit {
color: #f5871f; }
/* punctuation */
.pun {
color: #4d4d4c; }
/* lisp open bracket */
.opn {
color: #4d4d4c; }
/* lisp close bracket */
.clo {
color: #4d4d4c; }
/* a markup tag name */
.tag {
color: #c82829; }
/* a markup attribute name */
.atn {
color: #f5871f; }
/* a markup attribute value */
.atv {
color: #3e999f; }
/* a declaration */
.dec {
color: #f5871f; }
/* a variable name */
.var {
color: #c82829; }
/* a function name */
.fun {
color: #4271ae; } }
/* Use higher contrast and text-weight for printable form. */
@media print, projection {
.str {
color: #060; }
.kwd {
color: #006;
font-weight: bold; }
.com {
color: #600;
font-style: italic; }
.typ {
color: #404;
font-weight: bold; }
.lit {
color: #044; }
.pun, .opn, .clo {
color: #440; }
.tag {
color: #006;
font-weight: bold; }
.atn {
color: #404; }
.atv {
color: #060; } }
/* Style */
/*
pre.prettyprint {
background: white;
font-family: Consolas, Monaco, 'Andale Mono', monospace;
font-size: 12px;
line-height: 1.5;
border: 1px solid #ccc;
padding: 10px; }
*/
/* Specify class=linenums on a pre to get line numbering */
ol.linenums {
margin-top: 0;
margin-bottom: 0; }
/* IE indents via margin-left */
li.L0,
li.L1,
li.L2,
li.L3,
li.L4,
li.L5,
li.L6,
li.L7,
li.L8,
li.L9 {
/* */ }
/* Alternate shading for lines */
li.L1,
li.L3,
li.L5,
li.L7,
li.L9 {
/* */ }

10
templates/default/tmpl/augments.tmpl
View File

@ -1,10 +0,0 @@
<?js
var data = obj;
var self = this;
?>
<?js if (data.augments && data.augments.length) { ?>
<ul><?js data.augments.forEach(function(a) { ?>
<li><?js= self.linkto(a, a) ?></li>
<?js }) ?></ul>
<?js } ?>

196
templates/default/tmpl/container.tmpl
View File

@ -1,196 +0,0 @@
<?js
var self = this;
var isGlobalPage;
docs.forEach(function(doc, i) {
?>
<?js
// we only need to check this once
if (typeof isGlobalPage === 'undefined') {
isGlobalPage = (doc.kind === 'globalobj');
}
?>
<?js if (doc.kind === 'mainpage' || (doc.kind === 'package')) { ?>
<?js= self.partial('mainpage.tmpl', doc) ?>
<?js } else if (doc.kind === 'source') { ?>
<?js= self.partial('source.tmpl', doc) ?>
<?js } else { ?>
<section>
<header>
<?js if (!doc.longname || doc.kind !== 'module') { ?>
<h2><?js if (doc.attribs) { ?><span class="attribs"><?js= doc.attribs ?></span><?js }
if (doc.ancestors && doc.ancestors.length) { ?>
<span class="ancestors"><?js= doc.ancestors.join('') ?></span><?js
}
?><?js= doc.name ?><?js
if (doc.variation) { ?>
<sup class="variation"><?js= doc.variation ?></sup><?js }
if (doc.signature && !doc.hideconstructor) { ?><?js= doc.signature ?><?js } ?></h2>
<?js if (doc.classdesc) { ?>
<div class="class-description"><?js= doc.classdesc ?></div>
<?js } ?>
<?js } else if (doc.kind === 'module' && doc.modules) { ?>
<?js doc.modules.forEach(function(module) { ?>
<?js if (module.classdesc) { ?>
<div class="class-description"><?js= module.classdesc ?></div>
<?js } ?>
<?js }) ?>
<?js } ?>
</header>
<article>
<div class="container-overview">
<?js if (doc.kind === 'module' && doc.modules) { ?>
<?js if (doc.description) { ?>
<div class="description"><?js= doc.description ?></div>
<?js } ?>
<?js doc.modules.forEach(function(module) { ?>
<?js= self.partial('method.tmpl', module) ?>
<?js }) ?>
<?js } else if (doc.kind === 'class' || (doc.kind === 'namespace' && doc.signature)) { ?>
<?js= self.partial('method.tmpl', doc) ?>
<?js } else { ?>
<?js if (doc.description) { ?>
<div class="description"><?js= doc.description ?></div>
<?js } ?>
<?js= self.partial('details.tmpl', doc) ?>
<?js if (doc.examples && doc.examples.length) { ?>
<h3>Example<?js= doc.examples.length > 1? 's':'' ?></h3>
<?js= self.partial('examples.tmpl', doc.examples) ?>
<?js } ?>
<?js } ?>
</div>
<?js if (doc.augments && doc.augments.length) { ?>
<h3 class="subsection-title">Extends</h3>
<?js= self.partial('augments.tmpl', doc) ?>
<?js } ?>
<?js if (doc.requires && doc.requires.length) { ?>
<h3 class="subsection-title">Requires</h3>
<ul><?js doc.requires.forEach(function(r) { ?>
<li><?js= self.linkto(r, r) ?></li>
<?js }); ?></ul>
<?js } ?>
<?js
var classes = self.find({kind: 'class', memberof: doc.longname});
if (!isGlobalPage && classes && classes.length) {
?>
<h3 class="subsection-title">Classes</h3>
<dl><?js classes.forEach(function(c) { ?>
<dt><?js= self.linkto(c.longname, c.name) ?></dt>
<dd><?js if (c.summary) { ?><?js= c.summary ?><?js } ?></dd>
<?js }); ?></dl>
<?js } ?>
<?js
var interfaces = self.find({kind: 'interface', memberof: doc.longname});
if (!isGlobalPage && interfaces && interfaces.length) {
?>
<h3 class="subsection-title">Interfaces</h3>
<dl><?js interfaces.forEach(function(i) { ?>
<dt><?js= self.linkto(i.longname, i.name) ?></dt>
<dd><?js if (i.summary) { ?><?js= i.summary ?><?js } ?></dd>
<?js }); ?></dl>
<?js } ?>
<?js
var mixins = self.find({kind: 'mixin', memberof: doc.longname});
if (!isGlobalPage && mixins && mixins.length) {
?>
<h3 class="subsection-title">Mixins</h3>
<dl><?js mixins.forEach(function(m) { ?>
<dt><?js= self.linkto(m.longname, m.name) ?></dt>
<dd><?js if (m.summary) { ?><?js= m.summary ?><?js } ?></dd>
<?js }); ?></dl>
<?js } ?>
<?js
var namespaces = self.find({kind: 'namespace', memberof: doc.longname});
if (!isGlobalPage && namespaces && namespaces.length) {
?>
<h3 class="subsection-title">Namespaces</h3>
<dl><?js namespaces.forEach(function(n) { ?>
<dt><?js= self.linkto(n.longname, n.name) ?></dt>
<dd><?js if (n.summary) { ?><?js= n.summary ?><?js } ?></dd>
<?js }); ?></dl>
<?js } ?>
<?js
var members = self.find({kind: 'member', memberof: isGlobalPage ? {isUndefined: true} : doc.longname});
// symbols that are assigned to module.exports are not globals, even though they're not a memberof anything
if (isGlobalPage && members && members.length && members.forEach) {
members = members.filter(function(m) {
return m.longname && m.longname.indexOf('module:') !== 0;
});
}
if (members && members.length && members.forEach) {
?>
<h3 class="subsection-title">Members</h3>
<?js members.forEach(function(p) { ?>
<?js= self.partial('members.tmpl', p) ?>
<?js }); ?>
<?js } ?>
<?js
var methods = self.find({kind: 'function', memberof: isGlobalPage ? {isUndefined: true} : doc.longname});
if (methods && methods.length && methods.forEach) {
?>
<h3 class="subsection-title">Methods</h3>
<?js methods.forEach(function(m) { ?>
<?js= self.partial('method.tmpl', m) ?>
<?js }); ?>
<?js } ?>
<?js
var typedefs = self.find({kind: 'typedef', memberof: isGlobalPage ? {isUndefined: true} : doc.longname});
if (typedefs && typedefs.length && typedefs.forEach) {
?>
<h3 class="subsection-title">Type Definitions</h3>
<?js typedefs.forEach(function(e) {
if (e.signature) {
?>
<?js= self.partial('method.tmpl', e) ?>
<?js
}
else {
?>
<?js= self.partial('members.tmpl', e) ?>
<?js
}
}); ?>
<?js } ?>
<?js
var events = self.find({kind: 'event', memberof: isGlobalPage ? {isUndefined: true} : doc.longname});
if (events && events.length && events.forEach) {
?>
<h3 class="subsection-title">Events</h3>
<?js events.forEach(function(e) { ?>
<?js= self.partial('method.tmpl', e) ?>
<?js }); ?>
<?js } ?>
</article>
</section>
<?js } ?>
<?js }); ?>

143
templates/default/tmpl/details.tmpl
View File

@ -1,143 +0,0 @@
<?js
var data = obj;
var self = this;
var defaultObjectClass = '';
// Check if the default value is an object or array; if so, apply code highlighting
if (data.defaultvalue && (data.defaultvaluetype === 'object' || data.defaultvaluetype === 'array')) {
data.defaultvalue = "<pre class=\"prettyprint\"><code>" + data.defaultvalue + "</code></pre>";
defaultObjectClass = ' class="object-value"';
}
?>
<?js
var properties = data.properties;
if (properties && properties.length && properties.forEach && !data.hideconstructor) {
?>
<h5 class="subsection-title">Properties:</h5>
<?js= this.partial('properties.tmpl', data) ?>
<?js } ?>
<dl class="details">
<?js if (data.version) {?>
<dt class="tag-version">Version:</dt>
<dd class="tag-version"><ul class="dummy"><li><?js= version ?></li></ul></dd>
<?js } ?>
<?js if (data.since) {?>
<dt class="tag-since">Since:</dt>
<dd class="tag-since"><ul class="dummy"><li><?js= since ?></li></ul></dd>
<?js } ?>
<?js if (data.inherited && data.inherits && !data.overrides) { ?>
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<?js= this.linkto(data.inherits, this.htmlsafe(data.inherits)) ?>
</li></ul></dd>
<?js } ?>
<?js if (data.overrides) { ?>
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<?js= this.linkto(data.overrides, this.htmlsafe(data.overrides)) ?>
</li></ul></dd>
<?js } ?>
<?js if (data.implementations && data.implementations.length) { ?>
<dt class="implementations">Implementations:</dt>
<dd class="implementations"><ul>
<?js data.implementations.forEach(function(impl) { ?>
<li><?js= self.linkto(impl, self.htmlsafe(impl)) ?></li>
<?js }); ?>
</ul></dd>
<?js } ?>
<?js if (data.implements && data.implements.length) { ?>
<dt class="implements">Implements:</dt>
<dd class="implements"><ul>
<?js data.implements.forEach(function(impl) { ?>
<li><?js= self.linkto(impl, self.htmlsafe(impl)) ?></li>
<?js }); ?>
</ul></dd>
<?js } ?>
<?js if (data.mixes && data.mixes.length) { ?>
<dt class="mixes">Mixes In:</dt>
<dd class="mixes"><ul>
<?js data.mixes.forEach(function(a) { ?>
<li><?js= self.linkto(a, a) ?></li>
<?js }); ?>
</ul></dd>
<?js } ?>
<?js if (data.deprecated) { ?>
<dt class="important tag-deprecated">Deprecated:</dt><?js
if (data.deprecated === true) { ?><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd><?js }
else { ?><dd><ul class="dummy"><li><?js= data.deprecated ?></li></ul></dd><?js }
?>
<?js } ?>
<?js if (data.author && author.length) {?>
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul><?js author.forEach(function(a) { ?>
<li><?js= self.resolveAuthorLinks(a) ?></li>
<?js }); ?></ul>
</dd>
<?js } ?>
<?js if (data.copyright) {?>
<dt class="tag-copyright">Copyright:</dt>
<dd class="tag-copyright"><ul class="dummy"><li><?js= copyright ?></li></ul></dd>
<?js } ?>
<?js if (data.license) {?>
<dt class="tag-license">License:</dt>
<dd class="tag-license"><ul class="dummy"><li><?js= license ?></li></ul></dd>
<?js } ?>
<?js if (data.defaultvalue) {?>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li<?js= defaultObjectClass ?>><?js= data.defaultvalue ?></li>
</ul></dd>
<?js } ?>
<?js if (data.meta && self.outputSourceFiles) {?>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<?js= self.linkto(meta.shortpath) ?>, <?js= self.linkto(meta.shortpath, 'line ' + meta.lineno, null, 'line' + meta.lineno) ?>
</li></ul></dd>
<?js } ?>
<?js if (data.tutorials && tutorials.length) {?>
<dt class="tag-tutorial">Tutorials:</dt>
<dd class="tag-tutorial">
<ul><?js tutorials.forEach(function(t) { ?>
<li><?js= self.tutoriallink(t) ?></li>
<?js }); ?></ul>
</dd>
<?js } ?>
<?js if (data.see && see.length) {?>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul><?js see.forEach(function(s) { ?>
<li><?js= self.linkto(s) ?></li>
<?js }); ?></ul>
</dd>
<?js } ?>
<?js if (data.todo && todo.length) {?>
<dt class="tag-todo">To Do:</dt>
<dd class="tag-todo">
<ul><?js todo.forEach(function(t) { ?>
<li><?js= t ?></li>
<?js }); ?></ul>
</dd>
<?js } ?>
</dl>

2
templates/default/tmpl/example.tmpl
View File

@ -1,2 +0,0 @@
<?js var data = obj; ?>
<pre><code><?js= data ?></code></pre>

13
templates/default/tmpl/examples.tmpl
View File

@ -1,13 +0,0 @@
<?js
var data = obj;
var self = this;
data.forEach(function(example) {
if (example.caption) {
?>
<p class="code-caption"><?js= example.caption ?></p>
<?js } ?>
<pre class="prettyprint"><code><?js= self.htmlsafe(example.code) ?></code></pre>
<?js
});
?>

32
templates/default/tmpl/exceptions.tmpl
View File

@ -1,32 +0,0 @@
<?js
var data = obj;
?>
<?js if (data.description && data.type && data.type.names) { ?>
<dl>
<dt>
<div class="param-desc">
<?js= data.description ?>
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<?js= this.partial('type.tmpl', data.type.names) ?>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<?js } else { ?>
<div class="param-desc">
<?js if (data.description) { ?>
<?js= data.description ?>
<?js } else if (data.type && data.type.names) { ?>
<?js= this.partial('type.tmpl', data.type.names) ?>
<?js } ?>
</div>
<?js } ?>

14
templates/default/tmpl/mainpage.tmpl
View File

@ -1,14 +0,0 @@
<?js
var data = obj;
var self = this;
?>
<?js if (data.kind === 'package') { ?>
<h3><?js= data.name ?> <?js= data.version ?></h3>
<?js } ?>
<?js if (data.readme) { ?>
<section>
<article><?js= data.readme ?></article>
</section>
<?js } ?>

38
templates/default/tmpl/members.tmpl
View File

@ -1,38 +0,0 @@
<?js
var data = obj;
var self = this;
?>
<h4 class="name" id="<?js= id ?>"><?js= data.attribs + name + (data.signature ? data.signature : '') ?></h4>
<?js if (data.summary) { ?>
<p class="summary"><?js= summary ?></p>
<?js } ?>
<?js if (data.description) { ?>
<div class="description">
<?js= data.description ?>
</div>
<?js } ?>
<?js if (data.type && data.type.names) {?>
<h5>Type:</h5>
<ul>
<li>
<?js= self.partial('type.tmpl', data.type.names) ?>
</li>
</ul>
<?js } ?>
<?js= this.partial('details.tmpl', data) ?>
<?js if (data.fires && fires.length) { ?>
<h5>Fires:</h5>
<ul><?js fires.forEach(function(f) { ?>
<li><?js= self.linkto(f) ?></li>
<?js }); ?></ul>
<?js } ?>
<?js if (data.examples && examples.length) { ?>
<h5>Example<?js= examples.length > 1? 's':'' ?></h5>
<?js= this.partial('examples.tmpl', examples) ?>
<?js } ?>

131
templates/default/tmpl/method.tmpl
View File

@ -1,131 +0,0 @@
<?js
var data = obj;
var self = this;
?>
<?js if (data.kind !== 'module' && !data.hideconstructor) { ?>
<?js if (data.kind === 'class' && data.classdesc) { ?>
<h2>Constructor</h2>
<?js } ?>
<?js if (data.kind !== 'namespace') { ?>
<h4 class="name" id="<?js= id ?>"><?js= data.attribs + (kind === 'class' ? 'new ' : '') +
name + (data.signature || '') ?></h4>
<?js } ?>
<?js if (data.summary) { ?>
<p class="summary"><?js= summary ?></p>
<?js } ?>
<?js } ?>
<?js if (data.kind !== 'module' && data.description && !data.hideconstructor) { ?>
<div class="description">
<?js= data.description ?>
</div>
<?js } ?>
<?js if (data.augments && data.alias && data.alias.indexOf('module:') === 0) { ?>
<h5>Extends:</h5>
<?js= self.partial('augments.tmpl', data) ?>
<?js } ?>
<?js if (kind === 'event' && data.type && data.type.names) {?>
<h5>Type:</h5>
<ul>
<li>
<?js= self.partial('type.tmpl', data.type.names) ?>
</li>
</ul>
<?js } ?>
<?js if (data['this']) { ?>
<h5>This:</h5>
<ul><li><?js= this.linkto(data['this'], data['this']) ?></li></ul>
<?js } ?>
<?js if (data.params && params.length && !data.hideconstructor) { ?>
<h5>Parameters:</h5>
<?js= this.partial('params.tmpl', params) ?>
<?js } ?>
<?js= this.partial('details.tmpl', data) ?>
<?js if (data.kind !== 'module' && data.requires && data.requires.length) { ?>
<h5>Requires:</h5>
<ul><?js data.requires.forEach(function(r) { ?>
<li><?js= self.linkto(r) ?></li>
<?js }); ?></ul>
<?js } ?>
<?js if (data.fires && fires.length) { ?>
<h5>Fires:</h5>
<ul><?js fires.forEach(function(f) { ?>
<li><?js= self.linkto(f) ?></li>
<?js }); ?></ul>
<?js } ?>
<?js if (data.listens && listens.length) { ?>
<h5>Listens to Events:</h5>
<ul><?js listens.forEach(function(f) { ?>
<li><?js= self.linkto(f) ?></li>
<?js }); ?></ul>
<?js } ?>
<?js if (data.listeners && listeners.length) { ?>
<h5>Listeners of This Event:</h5>
<ul><?js listeners.forEach(function(f) { ?>
<li><?js= self.linkto(f) ?></li>
<?js }); ?></ul>
<?js } ?>
<?js if (data.modifies && modifies.length) {?>
<h5>Modifies:</h5>
<?js if (modifies.length > 1) { ?><ul><?js
modifies.forEach(function(m) { ?>
<li><?js= self.partial('modifies.tmpl', m) ?></li>
<?js });
?></ul><?js } else {
modifies.forEach(function(m) { ?>
<?js= self.partial('modifies.tmpl', m) ?>
<?js });
} } ?>
<?js if (data.exceptions && exceptions.length) { ?>
<h5>Throws:</h5>
<?js if (exceptions.length > 1) { ?><ul><?js
exceptions.forEach(function(r) { ?>
<li><?js= self.partial('exceptions.tmpl', r) ?></li>
<?js });
?></ul><?js } else {
exceptions.forEach(function(r) { ?>
<?js= self.partial('exceptions.tmpl', r) ?>
<?js });
} } ?>
<?js if (data.returns && returns.length) { ?>
<h5>Returns:</h5>
<?js if (returns.length > 1) { ?><ul><?js
returns.forEach(function(r) { ?>
<li><?js= self.partial('returns.tmpl', r) ?></li>
<?js });
?></ul><?js } else {
returns.forEach(function(r) { ?>
<?js= self.partial('returns.tmpl', r) ?>
<?js });
} } ?>
<?js if (data.yields && yields.length) { ?>
<h5>Yields:</h5>
<?js if (yields.length > 1) { ?><ul><?js
yields.forEach(function(r) { ?>
<li><?js= self.partial('returns.tmpl', r) ?></li>
<?js });
?></ul><?js } else {
yields.forEach(function(r) { ?>
<?js= self.partial('returns.tmpl', r) ?>
<?js });
} } ?>
<?js if (data.examples && examples.length) { ?>
<h5>Example<?js= examples.length > 1? 's':'' ?></h5>
<?js= this.partial('examples.tmpl', examples) ?>
<?js } ?>

14
templates/default/tmpl/modifies.tmpl
View File

@ -1,14 +0,0 @@
<?js
var data = obj || {};
?>
<?js if (data.type && data.type.names) {?>
<dl>
<dt>
Type
</dt>
<dd>
<?js= this.partial('type.tmpl', data.type.names) ?>
</dd>
</dl>
<?js } ?>

19
templates/default/tmpl/returns.tmpl
View File

@ -1,19 +0,0 @@
<?js
var data = obj || {};
if (data.description) {
?>
<div class="param-desc">
<?js= description ?>
</div>
<?js } ?>
<?js if (data.type && data.type.names) {?>
<dl>
<dt>
Type
</dt>
<dd>
<?js= this.partial('type.tmpl', data.type.names) ?>
</dd>
</dl>
<?js } ?>

8
templates/default/tmpl/source.tmpl
View File

@ -1,8 +0,0 @@
<?js
var data = obj;
?>
<section>
<article>
<pre class="prettyprint source linenums"><code><?js= data.code ?></code></pre>
</article>
</section>

19
templates/default/tmpl/tutorial.tmpl
View File

@ -1,19 +0,0 @@
<section>
<header>
<?js if (children.length > 0) { ?>
<ul><?js
var self = this;
children.forEach(function(t) { ?>
<li><?js= self.tutoriallink(t.name) ?></li>
<?js }); ?></ul>
<?js } ?>
<h2><?js= header ?></h2>
</header>
<article>
<?js= content ?>
</article>
</section>

7
templates/default/tmpl/type.tmpl
View File

@ -1,7 +0,0 @@
<?js
var data = obj;
var self = this;
data.forEach(function(name, i) { ?>
<span class="param-type"><?js= self.linkto(name, self.htmlsafe(name)) ?></span>
<?js if (i < data.length-1) { ?>|<?js } ?>
<?js }); ?>

39
templates/haruki/README.md
View File

@ -1,39 +0,0 @@
OVERVIEW
========
JSDoc 3 Haruki is an experimental template optimised for use with publishing processes that consume either JSON or XML. Whereas the default JSDoc template outputs an HTML representation of your API, Haruki will output a JSON, or optionally an XML, representation.
Currently Haruki only supports a subset of the tags supported by the default template. Those are:
* @name
* @desc
* @type
* @namespace
* @method (or @function)
* @member (or @var)
* @class
* @mixin
* @event
* @param
* @returns
* @throws
* @example
* @access (like @private or @public)
This limited support set is intentional, as it is meant to be a usable set that could be shared with either JavaScript or PHP documentation -- another experimental tool, named "Vonnegut", can produce Haruki compatible JSON from PHPDoc tags.
Note: `@link`s will appear in the output untransformed, there is no way to know at this stage what the file layout of your output will eventually be. It is assumed that whatever process emits the final output file/s will transform `@link` tags at that point.
USAGE
=====
./jsdoc myscript.js -t templates/haruki -d console -q format=xml
The results of this command will appear in `stdout` and can be piped into other tools for further processing.
MORE
=====
If you are interested in Haruki, you are encouraged to discuss your questions or ideas on the JSDoc-Users mailing list and fork/contribute to this project.
For more information contact Michael Mathews at <micmath+haruki@gmail.com>.

224
templates/haruki/publish.js
View File

@ -1,224 +0,0 @@
/* eslint-disable indent, no-nested-ternary, space-infix-ops */
/**
@overview Builds a tree-like JSON string from the doclet data.
@version 0.0.3
@example
./jsdoc scratch/jsdoc_test.js -t templates/haruki -d console -q format=xml
*/
const xml = require('js2xmlparser');
const hasOwnProp = Object.prototype.hasOwnProperty;
function graft(parentNode, childNodes, parentLongname) {
childNodes
.filter(({memberof}) => memberof === parentLongname)
.forEach(element => {
let i;
let len;
let thisClass;
let thisEvent;
let thisFunction;
let thisMixin;
let thisNamespace;
if (element.kind === 'namespace') {
if (!parentNode.namespaces) {
parentNode.namespaces = [];
}
thisNamespace = {
'name': element.name,
'description': element.description || '',
'access': element.access || '',
'virtual': Boolean(element.virtual)
};
parentNode.namespaces.push(thisNamespace);
graft(thisNamespace, childNodes, element.longname);
}
else if (element.kind === 'mixin') {
if (!parentNode.mixins) {
parentNode.mixins = [];
}
thisMixin = {
'name': element.name,
'description': element.description || '',
'access': element.access || '',
'virtual': Boolean(element.virtual)
};
parentNode.mixins.push(thisMixin);
graft(thisMixin, childNodes, element.longname);
}
else if (element.kind === 'function') {
if (!parentNode.functions) {
parentNode.functions = [];
}
thisFunction = {
'name': element.name,
'access': element.access || '',
'virtual': Boolean(element.virtual),
'description': element.description || '',
'parameters': [],
'examples': []
};
parentNode.functions.push(thisFunction);
if (element.returns) {
thisFunction.returns = {
'type': element.returns[0].type? (element.returns[0].type.names.length === 1? element.returns[0].type.names[0] : element.returns[0].type.names) : '',
'description': element.returns[0].description || ''
};
}
if (element.examples) {
for (i = 0, len = element.examples.length; i < len; i++) {
thisFunction.examples.push(element.examples[i]);
}
}
if (element.params) {
for (i = 0, len = element.params.length; i < len; i++) {
thisFunction.parameters.push({
'name': element.params[i].name,
'type': element.params[i].type? (element.params[i].type.names.length === 1? element.params[i].type.names[0] : element.params[i].type.names) : '',
'description': element.params[i].description || '',
'default': hasOwnProp.call(element.params[i], 'defaultvalue') ? element.params[i].defaultvalue : '',
'optional': typeof element.params[i].optional === 'boolean'? element.params[i].optional : '',
'nullable': typeof element.params[i].nullable === 'boolean'? element.params[i].nullable : ''
});
}
}
}
else if (element.kind === 'member') {
if (!parentNode.properties) {
parentNode.properties = [];
}
parentNode.properties.push({
'name': element.name,
'access': element.access || '',
'virtual': Boolean(element.virtual),
'description': element.description || '',
'type': element.type? (element.type.length === 1? element.type[0] : element.type) : ''
});
}
else if (element.kind === 'event') {
if (!parentNode.events) {
parentNode.events = [];
}
thisEvent = {
'name': element.name,
'access': element.access || '',
'virtual': Boolean(element.virtual),
'description': element.description || '',
'parameters': [],
'examples': []
};
parentNode.events.push(thisEvent);
if (element.returns) {
thisEvent.returns = {
'type': element.returns.type ? (element.returns.type.names.length === 1 ? element.returns.type.names[0] : element.returns.type.names) : '',
'description': element.returns.description || ''
};
}
if (element.examples) {
for (i = 0, len = element.examples.length; i < len; i++) {
thisEvent.examples.push(element.examples[i]);
}
}
if (element.params) {
for (i = 0, len = element.params.length; i < len; i++) {
thisEvent.parameters.push({
'name': element.params[i].name,
'type': element.params[i].type? (element.params[i].type.names.length === 1? element.params[i].type.names[0] : element.params[i].type.names) : '',
'description': element.params[i].description || '',
'default': hasOwnProp.call(element.params[i], 'defaultvalue') ? element.params[i].defaultvalue : '',
'optional': typeof element.params[i].optional === 'boolean'? element.params[i].optional : '',
'nullable': typeof element.params[i].nullable === 'boolean'? element.params[i].nullable : ''
});
}
}
}
else if (element.kind === 'class') {
if (!parentNode.classes) {
parentNode.classes = [];
}
thisClass = {
'name': element.name,
'description': element.classdesc || '',
'extends': element.augments || [],
'access': element.access || '',
'virtual': Boolean(element.virtual),
'fires': element.fires || '',
'constructor': {
'name': element.name,
'description': element.description || '',
'parameters': [
],
'examples': []
}
};
parentNode.classes.push(thisClass);
if (element.examples) {
for (i = 0, len = element.examples.length; i < len; i++) {
thisClass.constructor.examples.push(element.examples[i]);
}
}
if (element.params) {
for (i = 0, len = element.params.length; i < len; i++) {
thisClass.constructor.parameters.push({
'name': element.params[i].name,
'type': element.params[i].type? (element.params[i].type.names.length === 1? element.params[i].type.names[0] : element.params[i].type.names) : '',
'description': element.params[i].description || '',
'default': hasOwnProp.call(element.params[i], 'defaultvalue') ? element.params[i].defaultvalue : '',
'optional': typeof element.params[i].optional === 'boolean'? element.params[i].optional : '',
'nullable': typeof element.params[i].nullable === 'boolean'? element.params[i].nullable : ''
});
}
}
graft(thisClass, childNodes, element.longname);
}
});
}
/**
@param {TAFFY} data
@param {object} opts
*/
exports.publish = (data, {destination, query}) => {
let docs;
const root = {};
data({undocumented: true}).remove();
docs = data().get(); // <-- an array of Doclet objects
graft(root, docs);
if (destination === 'console') {
if (query && query.format === 'xml') {
console.log( xml.parse('jsdoc', root) );
}
else {
console.log( require('jsdoc/util/dumper').dump(root) );
}
}
else {
console.log('This template only supports output to the console. Use the option "-d console" when you run JSDoc.');
}
};

11
templates/silent/README.md
View File

@ -1,11 +0,0 @@
OVERVIEW
========
The `silent` template outputs nothing at all. Why would that be useful? Primarily for running JSDoc as a linter to check for syntax errors and unrecognized tags in documentation comments, although it may also be useful for testing or benchmarking purposes.
USAGE
=====
./jsdoc myscript.js -t templates/silent -a all --pedantic
This command exits with a non-zero exit code if any errors are encountered. It writes nothing to disk and the only output it produces is any error messages written to `stderr`. This command can also be used to warn about tags which are unknown to JSDoc by setting `"allowUnknownTags": false` in a configuration file.

7
templates/silent/publish.js
View File

@ -1,7 +0,0 @@
/* eslint-disable no-empty-function, no-unused-vars */
/**
@param {TAFFY} taffyData See <http://taffydb.com/>.
@param {object} opts
@param {Tutorial} tutorials
*/
exports.publish = (taffyData, opts, tutorials) => {};

3
test/specs/jsdoc/template.js
View File

@ -1,3 +0,0 @@
xdescribe('jsdoc/template', () => {
// TODO
});