diff --git a/Gruntfile.js b/Gruntfile.js index 5b64cd37..8a8a73ca 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -108,8 +108,7 @@ module.exports = function(grunt) { src: ['README.md', 'src'], options: { destination: 'doc', - recurse: true, - template: 'jsdoc.template' + recurse: true } } }, diff --git a/jsdoc.template/README.md b/jsdoc.template/README.md deleted file mode 100644 index a7bd96bf..00000000 --- a/jsdoc.template/README.md +++ /dev/null @@ -1 +0,0 @@ -The default template for JSDoc 3 uses: [the Taffy Database library](http://taffydb.com/) and the [Underscore Template library](http://documentcloud.github.com/underscore/#template). diff --git a/jsdoc.template/publish.js b/jsdoc.template/publish.js deleted file mode 100644 index a2b66856..00000000 --- a/jsdoc.template/publish.js +++ /dev/null @@ -1,565 +0,0 @@ -/*global env: true */ -var template = require('jsdoc/template'), - fs = require('jsdoc/fs'), - path = require('jsdoc/path'), - taffy = require('taffydb').taffy, - handle = require('jsdoc/util/error').handle, - helper = require('jsdoc/util/templateHelper'), - htmlsafe = helper.htmlsafe, - linkto = helper.linkto, - resolveAuthorLinks = helper.resolveAuthorLinks, - scopeToPunc = helper.scopeToPunc, - hasOwnProp = Object.prototype.hasOwnProperty, - data, - view, - outdir = env.opts.destination; - - -function find(spec) { - return helper.find(data, spec); -} - -function tutoriallink(tutorial) { - return helper.toTutorial(tutorial, null, { tag: 'em', classname: 'disabled', prefix: 'Tutorial: ' }); -} - -function getAncestorLinks(doclet) { - return helper.getAncestorLinks(data, doclet); -} - -function hashToLink(doclet, hash) { - if ( !/^(#.+)/.test(hash) ) { return hash; } - - var url = helper.createLink(doclet); - - url = url.replace(/(#.+|$)/, hash); - return '<a href="' + url + '">' + hash + '</a>'; -} - -function needsSignature(doclet) { - var needsSig = false; - - // function and class definitions always get a signature - if (doclet.kind === 'function' || doclet.kind === 'class') { - needsSig = true; - } - // typedefs that contain functions get a signature, too - else if (doclet.kind === 'typedef' && doclet.type && doclet.type.names && - doclet.type.names.length) { - for (var i = 0, l = doclet.type.names.length; i < l; i++) { - if (doclet.type.names[i].toLowerCase() === 'function') { - needsSig = true; - break; - } - } - } - - return needsSig; -} - -function addSignatureParams(f) { - var params = helper.getSignatureParams(f, 'optional'); - - f.signature = (f.signature || '') + '('+params.join(', ')+')'; -} - -function addSignatureReturns(f) { - var returnTypes = helper.getSignatureReturns(f); - - f.signature = '<span class="signature">'+(f.signature || '') + '</span>' + '<span class="type-signature">'+(returnTypes.length? ' → {'+returnTypes.join('|')+'}' : '')+'</span>'; -} - -function addSignatureTypes(f) { - var types = helper.getSignatureTypes(f); - - f.signature = (f.signature || '') + '<span class="type-signature">'+(types.length? ' :'+types.join('|') : '')+'</span>'; -} - -function addAttribs(f) { - var attribs = helper.getAttribs(f); - - f.attribs = '<span class="type-signature">'+htmlsafe(attribs.length? '<'+attribs.join(', ')+'> ' : '')+'</span>'; -} - -function shortenPaths(files, commonPrefix) { - // always use forward slashes - var regexp = new RegExp('\\\\', 'g'); - - Object.keys(files).forEach(function(file) { - files[file].shortened = files[file].resolved.replace(commonPrefix, '') - .replace(regexp, '/'); - }); - - return files; -} - -function resolveSourcePath(filepath) { - return path.resolve(process.cwd(), filepath); -} - -function getPathFromDoclet(doclet) { - if (!doclet.meta) { - return; - } - - var filepath = doclet.meta.path && doclet.meta.path !== 'null' ? - doclet.meta.path + '/' + doclet.meta.filename : - doclet.meta.filename; - - return filepath; -} - -function generate(title, docs, filename, resolveLinks) { - resolveLinks = resolveLinks === false ? false : true; - - var docData = { - title: title, - docs: docs - }; - - var outpath = path.join(outdir, filename), - html = view.render('container.tmpl', docData); - - if (resolveLinks) { - html = helper.resolveLinks(html); // turn {@link foo} into <a href="foodoc.html">foo</a> - } - - fs.writeFileSync(outpath, html, 'utf8'); -} - -function generateSourceFiles(sourceFiles) { - Object.keys(sourceFiles).forEach(function(file) { - var source; - // links are keyed to the shortened path in each doclet's `meta.filename` property - var sourceOutfile = helper.getUniqueFilename(sourceFiles[file].shortened); - helper.registerLink(sourceFiles[file].shortened, sourceOutfile); - - try { - source = { - kind: 'source', - code: helper.htmlsafe( fs.readFileSync(sourceFiles[file].resolved, 'utf8') ) - }; - } - catch(e) { - handle(e); - } - - generate('Source: ' + sourceFiles[file].shortened, [source], sourceOutfile, - false); - }); -} - -/** - * Look for classes or functions with the same name as modules (which indicates that the module - * exports only that class or function), then attach the classes or functions to the `module` - * property of the appropriate module doclets. The name of each class or function is also updated - * for display purposes. This function mutates the original arrays. - * - * @private - * @param {Array.<module:jsdoc/doclet.Doclet>} doclets - The array of classes and functions to - * check. - * @param {Array.<module:jsdoc/doclet.Doclet>} modules - The array of module doclets to search. - */ -function attachModuleSymbols(doclets, modules) { - var symbols = {}; - - // build a lookup table - doclets.forEach(function(symbol) { - symbols[symbol.longname] = symbol; - }); - - return modules.map(function(module) { - if (symbols[module.longname]) { - module.module = symbols[module.longname]; - if (module.module.kind == 'class') { - module.module.name = module.module.name.replace('module:', '(require("') + '"))'; - } else { - module.module.name = module.module.name.replace('module:', 'require("') + '")'; - } - } - }); -} - -/** - * Create the navigation sidebar. - * @param {object} members The members that will be used to create the sidebar. - * @param {array<object>} members.classes - * @param {array<object>} members.externals - * @param {array<object>} members.globals - * @param {array<object>} members.mixins - * @param {array<object>} members.modules - * @param {array<object>} members.namespaces - * @param {array<object>} members.tutorials - * @param {array<object>} members.events - * @return {string} The HTML for the navigation sidebar. - */ -function buildNav(members) { - var nav = '<h2><a href="index.html">Index</a></h2>', - seen = {}, - hasClassList = false, - classNav = '', - globalNav = ''; - - if (members.modules.length) { - nav += '<h3>Modules</h3><ul>'; - members.modules.forEach(function(m) { - if ( !hasOwnProp.call(seen, m.longname) ) { - nav += '<li>'+linkto(m.longname, m.name)+'</li>'; - } - seen[m.longname] = true; - }); - - nav += '</ul>'; - } - - if (members.externals.length) { - nav += '<h3>Externals</h3><ul>'; - members.externals.forEach(function(e) { - if ( !hasOwnProp.call(seen, e.longname) ) { - nav += '<li>'+linkto( e.longname, e.name.replace(/(^"|"$)/g, '') )+'</li>'; - } - seen[e.longname] = true; - }); - - nav += '</ul>'; - } - - if (members.classes.length) { - members.classes.forEach(function(c) { - if ( !hasOwnProp.call(seen, c.longname) ) { - classNav += '<li>'+linkto(c.longname, c.longname.replace(/^module:/,''))+'</li>'; - } - seen[c.longname] = true; - }); - - if (classNav !== '') { - nav += '<h3>Classes</h3><ul>'; - nav += classNav; - nav += '</ul>'; - } - } - - if (members.events.length) { - nav += '<h3>Events</h3><ul>'; - members.events.forEach(function(e) { - if ( !hasOwnProp.call(seen, e.longname) ) { - nav += '<li>'+linkto(e.longname, e.name)+'</li>'; - } - seen[e.longname] = true; - }); - - nav += '</ul>'; - } - - if (members.namespaces.length) { - nav += '<h3>Namespaces</h3><ul>'; - members.namespaces.forEach(function(n) { - if ( !hasOwnProp.call(seen, n.longname) ) { - nav += '<li>'+linkto(n.longname, n.name)+'</li>'; - } - seen[n.longname] = true; - }); - - nav += '</ul>'; - } - - if (members.mixins.length) { - nav += '<h3>Mixins</h3><ul>'; - members.mixins.forEach(function(m) { - if ( !hasOwnProp.call(seen, m.longname) ) { - nav += '<li>'+linkto(m.longname, m.name)+'</li>'; - } - seen[m.longname] = true; - }); - - nav += '</ul>'; - } - - if (members.tutorials.length) { - nav += '<h3>Tutorials</h3><ul>'; - members.tutorials.forEach(function(t) { - nav += '<li>'+tutoriallink(t.name)+'</li>'; - }); - - nav += '</ul>'; - } - - if (members.globals.length) { - members.globals.forEach(function(g) { - if ( g.kind !== 'typedef' && !hasOwnProp.call(seen, g.longname) ) { - globalNav += '<li>' + linkto(g.longname, g.name) + '</li>'; - } - seen[g.longname] = true; - }); - - if (!globalNav) { - // turn the heading into a link so you can actually get to the global page - nav += '<h3>' + linkto('global', 'Global') + '</h3>'; - } - else { - nav += '<h3>Global</h3><ul>' + globalNav + '</ul>'; - } - } - - return nav; -} - - -/** - @param {TAFFY} taffyData See <http://taffydb.com/>. - @param {object} opts - @param {Tutorial} tutorials - */ -exports.publish = function(taffyData, opts, tutorials) { - data = taffyData; - - var conf = env.conf.templates || {}; - conf['default'] = conf['default'] || {}; - - var templatePath = opts.template; - view = new template.Template(templatePath + '/tmpl'); - - // claim some special filenames in advance, so the All-Powerful Overseer of Filename Uniqueness - // doesn't try to hand them out later - var indexUrl = helper.getUniqueFilename('index'); - // don't call registerLink() on this one! 'index' is also a valid longname - - var globalUrl = helper.getUniqueFilename('global'); - helper.registerLink('global', globalUrl); - - // set up templating - view.layout = 'layout.tmpl'; - - // set up tutorials for helper - helper.setTutorials(tutorials); - - data = helper.prune(data); - data.sort('longname, version, since'); - helper.addEventListeners(data); - - var sourceFiles = {}; - var sourceFilePaths = []; - data().each(function(doclet) { - doclet.attribs = ''; - - if (doclet.examples) { - doclet.examples = doclet.examples.map(function(example) { - var caption, code; - - if (example.match(/^\s*<caption>([\s\S]+?)<\/caption>(\s*[\n\r])([\s\S]+)$/i)) { - caption = RegExp.$1; - code = RegExp.$3; - } - - return { - caption: caption || '', - code: code || example - }; - }); - } - if (doclet.see) { - doclet.see.forEach(function(seeItem, i) { - doclet.see[i] = hashToLink(doclet, seeItem); - }); - } - - // build a list of source files - var sourcePath; - var resolvedSourcePath; - if (doclet.meta) { - sourcePath = getPathFromDoclet(doclet); - resolvedSourcePath = resolveSourcePath(sourcePath); - sourceFiles[sourcePath] = { - resolved: resolvedSourcePath, - shortened: null - }; - sourceFilePaths.push(resolvedSourcePath); - } - }); - - // update outdir if necessary, then create outdir - var packageInfo = ( find({kind: 'package'}) || [] ) [0]; - if (packageInfo && packageInfo.name) { - outdir = path.join(outdir, packageInfo.name, packageInfo.version); - } - fs.mkPath(outdir); - - // copy the template's static files to outdir - var fromDir = path.join(templatePath, 'static'); - var staticFiles = fs.ls(fromDir, 3); - - staticFiles.forEach(function(fileName) { - var toDir = fs.toDir( fileName.replace(fromDir, outdir) ); - fs.mkPath(toDir); - fs.copyFileSync(fileName, toDir); - }); - - // copy user-specified static files to outdir - var staticFilePaths; - var staticFileFilter; - var staticFileScanner; - if (conf['default'].staticFiles) { - staticFilePaths = conf['default'].staticFiles.paths || []; - staticFileFilter = new (require('jsdoc/src/filter')).Filter(conf['default'].staticFiles); - staticFileScanner = new (require('jsdoc/src/scanner')).Scanner(); - - staticFilePaths.forEach(function(filePath) { - var extraStaticFiles = staticFileScanner.scan([filePath], 10, staticFileFilter); - - extraStaticFiles.forEach(function(fileName) { - var sourcePath = fs.statSync(filePath).isDirectory() ? filePath : - path.dirname(filePath); - var toDir = fs.toDir( fileName.replace(sourcePath, outdir) ); - fs.mkPath(toDir); - fs.copyFileSync(fileName, toDir); - }); - }); - } - - if (sourceFilePaths.length) { - sourceFiles = shortenPaths( sourceFiles, path.commonPrefix(sourceFilePaths) ); - } - data().each(function(doclet) { - var url = helper.createLink(doclet); - helper.registerLink(doclet.longname, url); - - // replace the filename with a shortened version of the full path - var docletPath; - if (doclet.meta) { - docletPath = getPathFromDoclet(doclet); - docletPath = sourceFiles[docletPath].shortened; - if (docletPath) { - doclet.meta.filename = docletPath; - } - } - }); - - data().each(function(doclet) { - var url = helper.longnameToUrl[doclet.longname]; - - if (url.indexOf('#') > -1) { - doclet.id = helper.longnameToUrl[doclet.longname].split(/#/).pop(); - } - else { - doclet.id = doclet.name; - } - - if ( needsSignature(doclet) ) { - addSignatureParams(doclet); - addSignatureReturns(doclet); - addAttribs(doclet); - } - }); - - // do this after the urls have all been generated - data().each(function(doclet) { - doclet.ancestors = getAncestorLinks(doclet); - - if (doclet.kind === 'member') { - addSignatureTypes(doclet); - addAttribs(doclet); - } - - if (doclet.kind === 'constant') { - addSignatureTypes(doclet); - addAttribs(doclet); - doclet.kind = 'member'; - } - }); - - var members = helper.getMembers(data); - members.tutorials = tutorials.children; - - // add template helpers - view.find = find; - view.linkto = linkto; - view.resolveAuthorLinks = resolveAuthorLinks; - view.tutoriallink = tutoriallink; - view.htmlsafe = htmlsafe; - - // once for all - view.nav = buildNav(members); - attachModuleSymbols( find({ kind: ['class', 'function'], longname: {left: 'module:'} }), - members.modules ); - - // only output pretty-printed source files if requested; do this before generating any other - // pages, so the other pages can link to the source files - if (conf['default'].outputSourceFiles) { - generateSourceFiles(sourceFiles); - } - - if (members.globals.length) { generate('Global', [{kind: 'globalobj'}], globalUrl); } - - // index page displays information from package.json and lists files - var files = find({kind: 'file'}), - packages = find({kind: 'package'}); - - generate('Index', - packages.concat( - [{kind: 'mainpage', readme: opts.readme, longname: (opts.mainpagetitle) ? opts.mainpagetitle : 'Main Page'}] - ).concat(files), - indexUrl); - - // set up the lists that we'll use to generate pages - var classes = taffy(members.classes); - var modules = taffy(members.modules); - var namespaces = taffy(members.namespaces); - var mixins = taffy(members.mixins); - var externals = taffy(members.externals); - - for (var longname in helper.longnameToUrl) { - if ( hasOwnProp.call(helper.longnameToUrl, longname) ) { - var myClasses = helper.find(classes, {longname: longname}); - if (myClasses.length) { - generate('Class: ' + myClasses[0].name, myClasses, helper.longnameToUrl[longname]); - } - - var myModules = helper.find(modules, {longname: longname}); - if (myModules.length) { - generate('Module: ' + myModules[0].name, myModules, helper.longnameToUrl[longname]); - } - - var myNamespaces = helper.find(namespaces, {longname: longname}); - if (myNamespaces.length) { - generate('Namespace: ' + myNamespaces[0].name, myNamespaces, helper.longnameToUrl[longname]); - } - - var myMixins = helper.find(mixins, {longname: longname}); - if (myMixins.length) { - generate('Mixin: ' + myMixins[0].name, myMixins, helper.longnameToUrl[longname]); - } - - var myExternals = helper.find(externals, {longname: longname}); - if (myExternals.length) { - generate('External: ' + myExternals[0].name, myExternals, helper.longnameToUrl[longname]); - } - } - } - - // TODO: move the tutorial functions to templateHelper.js - function generateTutorial(title, tutorial, filename) { - var tutorialData = { - title: title, - header: tutorial.title, - content: tutorial.parse(), - children: tutorial.children - }; - - var tutorialPath = path.join(outdir, filename), - html = view.render('tutorial.tmpl', tutorialData); - - // yes, you can use {@link} in tutorials too! - html = helper.resolveLinks(html); // turn {@link foo} into <a href="foodoc.html">foo</a> - - fs.writeFileSync(tutorialPath, html, 'utf8'); - } - - // tutorials can have only one parent so there is no risk for loops - function saveChildren(node) { - node.children.forEach(function(child) { - generateTutorial('Tutorial: ' + child.title, child, helper.tutorialToUrl(child.name)); - saveChildren(child); - }); - } - saveChildren(tutorials); -}; diff --git a/jsdoc.template/static/scripts/linenumber.js b/jsdoc.template/static/scripts/linenumber.js deleted file mode 100644 index a0c570d5..00000000 --- a/jsdoc.template/static/scripts/linenumber.js +++ /dev/null @@ -1,17 +0,0 @@ -(function() { - var counter = 0; - var numbered; - var source = document.getElementsByClassName('prettyprint source'); - - if (source && source[0]) { - source = source[0].getElementsByTagName('code')[0]; - - numbered = source.innerHTML.split('\n'); - numbered = numbered.map(function(item) { - counter++; - return '<span id="line' + counter + '"></span>' + item; - }); - - source.innerHTML = numbered.join('\n'); - } -})(); diff --git a/jsdoc.template/static/scripts/prettify/Apache-License-2.0.txt b/jsdoc.template/static/scripts/prettify/Apache-License-2.0.txt deleted file mode 100644 index d6456956..00000000 --- a/jsdoc.template/static/scripts/prettify/Apache-License-2.0.txt +++ /dev/null @@ -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. diff --git a/jsdoc.template/static/scripts/prettify/lang-css.js b/jsdoc.template/static/scripts/prettify/lang-css.js deleted file mode 100644 index 041e1f59..00000000 --- a/jsdoc.template/static/scripts/prettify/lang-css.js +++ /dev/null @@ -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"]); diff --git a/jsdoc.template/static/scripts/prettify/prettify.js b/jsdoc.template/static/scripts/prettify/prettify.js deleted file mode 100644 index eef5ad7e..00000000 --- a/jsdoc.template/static/scripts/prettify/prettify.js +++ /dev/null @@ -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"}})(); diff --git a/jsdoc.template/static/styles/jsdoc-default.css b/jsdoc.template/static/styles/jsdoc-default.css deleted file mode 100644 index ea49f607..00000000 --- a/jsdoc.template/static/styles/jsdoc-default.css +++ /dev/null @@ -1,283 +0,0 @@ -html -{ - overflow: auto; - background-color: #fff; -} - -body -{ - font: 14px "DejaVu Sans Condensed", "Liberation Sans", "Nimbus Sans L", Tahoma, Geneva, "Helvetica Neue", Helvetica, Arial, sans serif; - line-height: 130%; - color: #000; - background-color: #fff; -} - -a { - color: #444; -} - -a:visited { - color: #444; -} - -a:active { - color: #444; -} - -header -{ - display: block; - padding: 6px 4px; -} - -.class-description { - font-style: italic; - font-family: Palatino, 'Palatino Linotype', serif; - font-size: 130%; - line-height: 140%; - margin-bottom: 1em; - margin-top: 1em; -} - -#main { - float: left; - width: 100%; -} - -section -{ - display: block; - - background-color: #fff; - padding: 12px 24px; - border-bottom: 1px solid #ccc; - margin-right: 240px; -} - -.variation { - display: none; -} - -.optional:after { - content: "opt"; - font-size: 60%; - color: #aaa; - font-style: italic; - font-weight: lighter; -} - -nav -{ - display: block; - float: left; - margin-left: -230px; - margin-top: 28px; - width: 220px; - border-left: 1px solid #ccc; - padding-left: 9px; -} - -nav ul { - font-family: 'Lucida Grande', 'Lucida Sans Unicode', arial, sans-serif; - font-size: 100%; - line-height: 17px; - padding:0; - margin:0; - list-style-type:none; -} - -nav h2 a, nav h2 a:visited { - color: #A35A00; - text-decoration: none; -} - -nav h3 { - margin-top: 12px; -} - -nav li { - margin-top: 6px; -} - -nav a { - color: #5C5954; -} - -nav a:visited { - color: #5C5954; -} - -nav a:active { - color: #5C5954; -} - -footer { - display: block; - padding: 6px; - margin-top: 12px; - font-style: italic; - font-size: 90%; -} - -h1 -{ - font-size: 200%; - font-weight: bold; - letter-spacing: -0.01em; - margin: 6px 0 9px 0; -} - -h2 -{ - font-size: 170%; - font-weight: bold; - letter-spacing: -0.01em; - margin: 6px 0 3px 0; -} - -h3 -{ - font-size: 150%; - font-weight: bold; - letter-spacing: -0.01em; - margin-top: 16px; - margin: 6px 0 3px 0; -} - -h4 -{ - font-size: 130%; - font-weight: bold; - letter-spacing: -0.01em; - margin-top: 16px; - margin: 18px 0 3px 0; - color: #A35A00; -} - -h5, .container-overview .subsection-title -{ - font-size: 120%; - font-weight: bold; - letter-spacing: -0.01em; - margin: 8px 0 3px -16px; -} - -h6 -{ - font-size: 100%; - letter-spacing: -0.01em; - margin: 6px 0 3px 0; - font-style: italic; -} - -.ancestors { color: #999; } -.ancestors a -{ - color: #999 !important; - text-decoration: none; -} - -.important -{ - font-weight: bold; - color: #950B02; -} - -.yes-def { - text-indent: -1000px; -} - -.type-signature { - color: #aaa; -} - -.name, .signature { - font-family: Consolas, "Lucida Console", Monaco, monospace; -} - -.details { margin-top: 14px; } -.details dt { width:100px; float:left; border-left: 2px solid #DDD; padding-left: 10px; padding-top: 6px; } -.details dd { margin-left: 50px; } -.details ul { margin: 0; } -.details ul { list-style-type: none; } -.details li { margin-left: 30px; padding-top: 6px; } - -.description { - margin-bottom: 1em; - margin-left: -16px; - margin-top: 1em; -} - -.code-caption -{ - font-style: italic; - font-family: Palatino, 'Palatino Linotype', serif; - font-size: 107%; - margin: 0; -} - -.prettyprint -{ - border: 1px solid #ddd; - width: 80%; - overflow: auto; -} - -.prettyprint.source { - width: inherit; -} - -.prettyprint code -{ - font-family: Consolas, 'Lucida Console', Monaco, monospace; - font-size: 100%; - line-height: 18px; - display: block; - padding: 4px 12px; - margin: 0; - background-color: #fff; - color: #000; - border-left: 3px #ddd solid; -} - -.params, .props -{ - border-spacing: 0; - border: 0; - border-collapse: collapse; -} - -.params .name, .props .name, .name code { - color: #A35A00; - font-family: Consolas, 'Lucida Console', Monaco, monospace; - font-size: 100%; -} - -.params td, .params th, .props td, .props th -{ - border: 1px solid #ddd; - margin: 0px; - text-align: left; - vertical-align: top; - padding: 4px 6px; - display: table-cell; -} - -.params thead tr, .props thead tr -{ - background-color: #ddd; - font-weight: bold; -} - -.params .params thead tr, .props .props thead tr -{ - background-color: #fff; - font-weight: bold; -} - -.params th, .props th { border-right: 1px solid #aaa; } -.params thead .last, .props thead .last { border-right: 1px solid #ddd; } - -.disabled { - color: #454545; -} diff --git a/jsdoc.template/static/styles/prettify-jsdoc.css b/jsdoc.template/static/styles/prettify-jsdoc.css deleted file mode 100644 index 5a2526e3..00000000 --- a/jsdoc.template/static/styles/prettify-jsdoc.css +++ /dev/null @@ -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; -} diff --git a/jsdoc.template/static/styles/prettify-tomorrow.css b/jsdoc.template/static/styles/prettify-tomorrow.css deleted file mode 100644 index aa2908c2..00000000 --- a/jsdoc.template/static/styles/prettify-tomorrow.css +++ /dev/null @@ -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: Menlo, Monaco, Consolas, 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 { - /* */ } diff --git a/jsdoc.template/tmpl/container.tmpl b/jsdoc.template/tmpl/container.tmpl deleted file mode 100644 index 03e99827..00000000 --- a/jsdoc.template/tmpl/container.tmpl +++ /dev/null @@ -1,157 +0,0 @@ -<?js - var self = this; - docs.forEach(function(doc, i) { -?> - -<?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> - <h2><?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 } ?></h2> - <?js if (doc.classdesc) { ?> - <div class="class-description"><?js= doc.classdesc ?></div> - <?js } ?> -</header> - -<article> - <div class="container-overview"> - <?js if (doc.kind === 'module' && doc.module) { ?> - <?js if (doc.description) { ?> - <div class="description"><?js= doc.description ?></div> - <?js } ?> - <?js= self.partial('method.tmpl', doc.module) ?> - <?js } ?> - - <?js if (doc.kind === 'class') { ?> - <?js= self.partial('method.tmpl', doc) ?> - <?js } else { ?> - <?js if ((doc.kind !== 'module' || !doc.module) && 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> - - <ul><?js doc.augments.forEach(function(a) { ?> - <li><?js= self.linkto(a, a) ?></li> - <?js }); ?></ul> - <?js } ?> - - <?js if (doc.mixes && doc.mixes.length) { ?> - <h3 class="subsection-title">Mixes In</h3> - - <ul><?js doc.mixes.forEach(function(a) { ?> - <li><?js= self.linkto(a, a) ?></li> - <?js }); ?></ul> - <?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 (doc.kind !== 'globalobj' && 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 namespaces = self.find({kind: 'namespace', memberof: doc.longname}); - if (doc.kind !== 'globalobj' && namespaces && namespaces.length) { - ?> - <h3 class="subsection-title">Namespaces</h3> - - <dl><?js namespaces.forEach(function(n) { ?> - <dt><a href="namespaces.html#<?js= n.longname ?>"><?js= self.linkto(n.longname, n.name) ?></a></dt> - <dd><?js if (n.summary) { ?><?js= n.summary ?><?js } ?></dd> - <?js }); ?></dl> - <?js } ?> - - <?js - var members = self.find({kind: 'member', memberof: title === 'Global' ? {isUndefined: true} : doc.longname}); - if (members && members.length && members.forEach) { - ?> - <h3 class="subsection-title">Members</h3> - - <dl><?js members.forEach(function(p) { ?> - <?js= self.partial('members.tmpl', p) ?> - <?js }); ?></dl> - <?js } ?> - - <?js - var methods = self.find({kind: 'function', memberof: title === 'Global' ? {isUndefined: true} : doc.longname}); - if (methods && methods.length && methods.forEach) { - ?> - <h3 class="subsection-title">Methods</h3> - - <dl><?js methods.forEach(function(m) { ?> - <?js= self.partial('method.tmpl', m) ?> - <?js }); ?></dl> - <?js } ?> - - <?js - var typedefs = self.find({kind: 'typedef', memberof: title === 'Global' ? {isUndefined: true} : doc.longname}); - if (typedefs && typedefs.length && typedefs.forEach) { - ?> - <h3 class="subsection-title">Type Definitions</h3> - - <dl><?js typedefs.forEach(function(e) { - if (e.signature) { - ?> - <?js= self.partial('method.tmpl', e) ?> - <?js - } - else { - ?> - <?js= self.partial('members.tmpl', e) ?> - <?js - } - }); ?></dl> - <?js } ?> - - <?js - var events = self.find({kind: 'event', memberof: title === 'Global' ? {isUndefined: true} : doc.longname}); - if (events && events.length && events.forEach) { - ?> - <h3 class="subsection-title">Events</h3> - - <dl><?js events.forEach(function(e) { ?> - <?js= self.partial('method.tmpl', e) ?> - <?js }); ?></dl> - <?js } ?> -</article> - -</section> -<?js } ?> - -<?js }); ?> diff --git a/jsdoc.template/tmpl/details.tmpl b/jsdoc.template/tmpl/details.tmpl deleted file mode 100644 index d3b35522..00000000 --- a/jsdoc.template/tmpl/details.tmpl +++ /dev/null @@ -1,98 +0,0 @@ -<?js -var data = obj; -var self = this; -?> -<dl class="details"> - <?js - var properties = data.properties; - if (properties && properties.length && properties.forEach) { - ?> - - <h5 class="subsection-title">Properties:</h5> - - <dl><?js= this.partial('properties.tmpl', properties) ?></dl> - - <?js } ?> - - <?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 ?></dd> - <?js } ?> - - <?js if (data.inherited && data.inherits) { ?> - <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></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= data.defaultvalue ?></li></ul></dd> - <?js } ?> - - <?js if (data.meta) {?> - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <?js= self.linkto(meta.filename) ?>, <?js= self.linkto(meta.filename, '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> diff --git a/jsdoc.template/tmpl/example.tmpl b/jsdoc.template/tmpl/example.tmpl deleted file mode 100644 index e87caa5b..00000000 --- a/jsdoc.template/tmpl/example.tmpl +++ /dev/null @@ -1,2 +0,0 @@ -<?js var data = obj; ?> -<pre><code><?js= data ?></code></pre> diff --git a/jsdoc.template/tmpl/examples.tmpl b/jsdoc.template/tmpl/examples.tmpl deleted file mode 100644 index 23384c9d..00000000 --- a/jsdoc.template/tmpl/examples.tmpl +++ /dev/null @@ -1,11 +0,0 @@ -<?js - var data = obj; - data.forEach(function(example) { - if (example.caption) { - ?> - <p class="code-caption"><?js= example.caption ?></p> - <?js } ?> - <pre class="prettyprint"><code><?js= example.code ?></code></pre> -<?js - }); -?> \ No newline at end of file diff --git a/jsdoc.template/tmpl/exceptions.tmpl b/jsdoc.template/tmpl/exceptions.tmpl deleted file mode 100644 index 78c4e250..00000000 --- a/jsdoc.template/tmpl/exceptions.tmpl +++ /dev/null @@ -1,30 +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> - <dt> - <dl> - <dt> - Type - </dt> - <dd> - <?js= this.partial('type.tmpl', data.type.names) ?> - </dd> - </dl> - </dt> -</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 } ?> diff --git a/jsdoc.template/tmpl/layout.tmpl b/jsdoc.template/tmpl/layout.tmpl deleted file mode 100644 index 827b5acb..00000000 --- a/jsdoc.template/tmpl/layout.tmpl +++ /dev/null @@ -1,38 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> -<head> - <meta charset="utf-8"> - <title>JSDoc: <?js= 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/jsdoc-default.css"> -</head> - -<body> - -<div id="main"> - - <h1 class="page-title"><?js= title ?></h1> - - <?js= content ?> -</div> - -<nav> - <?js= this.nav ?> -</nav> - -<br clear="both"> - -<footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc <?js= env.version.number ?></a> on <?js= (new Date()) ?> -</footer> - -<script> prettyPrint(); </script> -<script src="scripts/linenumber.js"> </script> -</body> -</html> diff --git a/jsdoc.template/tmpl/mainpage.tmpl b/jsdoc.template/tmpl/mainpage.tmpl deleted file mode 100644 index 64e9e594..00000000 --- a/jsdoc.template/tmpl/mainpage.tmpl +++ /dev/null @@ -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 } ?> diff --git a/jsdoc.template/tmpl/members.tmpl b/jsdoc.template/tmpl/members.tmpl deleted file mode 100644 index 3fded716..00000000 --- a/jsdoc.template/tmpl/members.tmpl +++ /dev/null @@ -1,34 +0,0 @@ -<?js -var data = obj; -var self = this; -?> -<dt> - <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 } ?> -</dt> -<dd> - <?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.examples && examples.length) { ?> - <h5>Example<?js= examples.length > 1? 's':'' ?></h5> - <?js= this.partial('examples.tmpl', examples) ?> - <?js } ?> -</dd> diff --git a/jsdoc.template/tmpl/method.tmpl b/jsdoc.template/tmpl/method.tmpl deleted file mode 100644 index 1fff9b86..00000000 --- a/jsdoc.template/tmpl/method.tmpl +++ /dev/null @@ -1,90 +0,0 @@ -<?js -var data = obj; -var self = this; -?> -<dt> - <h4 class="name" id="<?js= id ?>"><?js= data.attribs + (kind === 'class' ? 'new ' : '') + name + (kind !== 'event' ? data.signature : '') ?></h4> - - <?js if (data.summary) { ?> - <p class="summary"><?js= summary ?></p> - <?js } ?> -</dt> -<dd> - - <?js if (data.description) { ?> - <div class="description"> - <?js= data.description ?> - </div> - <?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) { ?> - <h5>Parameters:</h5> - <?js= this.partial('params.tmpl', params) ?> - <?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.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.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.examples && examples.length) { ?> - <h5>Example<?js= examples.length > 1? 's':'' ?></h5> - <?js= this.partial('examples.tmpl', examples) ?> - <?js } ?> -</dd> diff --git a/jsdoc.template/tmpl/params.tmpl b/jsdoc.template/tmpl/params.tmpl deleted file mode 100644 index 7b951149..00000000 --- a/jsdoc.template/tmpl/params.tmpl +++ /dev/null @@ -1,112 +0,0 @@ -<?js - var params = obj; - - /* sort subparams under their parent params (like opts.classname) */ - var parentParam = null; - params.forEach(function(param, i) { - if (!param) { return; } - if ( parentParam && param.name && param.name.indexOf(parentParam.name + '.') === 0 ) { - param.name = param.name.substr(parentParam.name.length+1); - parentParam.subparams = parentParam.subparams || []; - parentParam.subparams.push(param); - params[i] = null; - } - else { - parentParam = param; - } - }); - - /* determine if we need extra columns, "attributes" and "default" */ - params.hasAttributes = false; - params.hasDefault = false; - params.hasName = false; - - params.forEach(function(param) { - if (!param) { return; } - - if (param.optional || param.nullable || param.variable) { - params.hasAttributes = true; - } - - if (param.name) { - params.hasName = true; - } - - if (typeof param.defaultvalue !== 'undefined') { - params.hasDefault = true; - } - }); -?> - -<table class="params"> - <thead> - <tr> - <?js if (params.hasName) {?> - <th>Name</th> - <?js } ?> - - <th>Type</th> - - <?js if (params.hasAttributes) {?> - <th>Argument</th> - <?js } ?> - - <?js 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 } ?> - - <td class="type"> - <?js if (param.type && param.type.names) {?> - <?js= self.partial('type.tmpl', param.type.names) ?> - <?js } ?> - </td> - - <?js if (params.hasAttributes) {?> - <td class="attributes"> - <?js if (param.optional) { ?> - <optional><br> - <?js } ?> - - <?js if (param.nullable) { ?> - <nullable><br> - <?js } ?> - - <?js if (param.variable) { ?> - <repeatable><br> - <?js } ?> - </td> - <?js } ?> - - <?js if (params.hasDefault) {?> - <td class="default"> - <?js if (typeof param.defaultvalue !== 'undefined') { ?> - <?js= self.htmlsafe(param.defaultvalue) ?> - <?js } ?> - </td> - <?js } ?> - - <td class="description last"><?js= param.description ?><?js if (param.subparams) { ?> - <h6>Properties</h6> - <?js= self.partial('params.tmpl', param.subparams) ?> - <?js } ?></td> - </tr> - - <?js }); ?> - </tbody> -</table> \ No newline at end of file diff --git a/jsdoc.template/tmpl/properties.tmpl b/jsdoc.template/tmpl/properties.tmpl deleted file mode 100644 index 97a3d23a..00000000 --- a/jsdoc.template/tmpl/properties.tmpl +++ /dev/null @@ -1,107 +0,0 @@ -<?js - var props = obj; - - /* sort subprops under their parent props (like opts.classname) */ - var parentProp = null; - props.forEach(function(prop, i) { - if (!prop) { return; } - if ( parentProp && prop.name && prop.name.indexOf(parentProp.name + '.') === 0 ) { - prop.name = prop.name.substr(parentProp.name.length+1); - parentProp.subprops = parentProp.subprops || []; - parentProp.subprops.push(prop); - props[i] = null; - } - else { - parentProp = prop; - } - }); - - /* determine if we need extra columns, "attributes" and "default" */ - props.hasAttributes = false; - props.hasDefault = false; - props.hasName = false; - - props.forEach(function(prop) { - if (!prop) { return; } - - if (prop.optional || prop.nullable) { - props.hasAttributes = true; - } - - if (prop.name) { - props.hasName = true; - } - - if (typeof prop.defaultvalue !== 'undefined') { - props.hasDefault = true; - } - }); -?> - -<table class="props"> - <thead> - <tr> - <?js if (props.hasName) {?> - <th>Name</th> - <?js } ?> - - <th>Type</th> - - <?js if (props.hasAttributes) {?> - <th>Argument</th> - <?js } ?> - - <?js 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 } ?> - - <td class="type"> - <?js if (prop.type && prop.type.names) {?> - <?js= self.partial('type.tmpl', prop.type.names) ?> - <?js } ?> - </td> - - <?js if (props.hasAttributes) {?> - <td class="attributes"> - <?js if (prop.optional) { ?> - <optional><br> - <?js } ?> - - <?js if (prop.nullable) { ?> - <nullable><br> - <?js } ?> - </td> - <?js } ?> - - <?js if (props.hasDefault) {?> - <td class="default"> - <?js if (typeof prop.defaultvalue !== 'undefined') { ?> - <?js= self.htmlsafe(prop.defaultvalue) ?> - <?js } ?> - </td> - <?js } ?> - - <td class="description last"><?js= prop.description ?><?js if (prop.subprops) { ?> - <h6>Properties</h6><?js= self.partial('properties.tmpl', prop.subprops) ?> - <?js } ?></td> - </tr> - - <?js }); ?> - </tbody> -</table> \ No newline at end of file diff --git a/jsdoc.template/tmpl/returns.tmpl b/jsdoc.template/tmpl/returns.tmpl deleted file mode 100644 index 32e059ed..00000000 --- a/jsdoc.template/tmpl/returns.tmpl +++ /dev/null @@ -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 } ?> \ No newline at end of file diff --git a/jsdoc.template/tmpl/source.tmpl b/jsdoc.template/tmpl/source.tmpl deleted file mode 100644 index e1092ef2..00000000 --- a/jsdoc.template/tmpl/source.tmpl +++ /dev/null @@ -1,8 +0,0 @@ -<?js - var data = obj; -?> - <section> - <article> - <pre class="prettyprint source"><code><?js= data.code ?></code></pre> - </article> - </section> \ No newline at end of file diff --git a/jsdoc.template/tmpl/tutorial.tmpl b/jsdoc.template/tmpl/tutorial.tmpl deleted file mode 100644 index b0c79c1d..00000000 --- a/jsdoc.template/tmpl/tutorial.tmpl +++ /dev/null @@ -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> diff --git a/jsdoc.template/tmpl/type.tmpl b/jsdoc.template/tmpl/type.tmpl deleted file mode 100644 index db8194d6..00000000 --- a/jsdoc.template/tmpl/type.tmpl +++ /dev/null @@ -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 }); ?> \ No newline at end of file