mirror of
https://github.com/jsdoc/jsdoc.git
synced 2025-12-08 19:46:11 +00:00
'use strict'ify
This commit is contained in:
parent
3716df0e23
commit
f55feb1a0e
1
cli.js
1
cli.js
@ -12,6 +12,7 @@
|
|||||||
* @private
|
* @private
|
||||||
*/
|
*/
|
||||||
module.exports = (function() {
|
module.exports = (function() {
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var props = {
|
var props = {
|
||||||
docs: [],
|
docs: [],
|
||||||
|
|||||||
2
jsdoc.js
2
jsdoc.js
@ -124,6 +124,8 @@ global.dump = function() {
|
|||||||
};
|
};
|
||||||
|
|
||||||
(function() {
|
(function() {
|
||||||
|
'use strict';
|
||||||
|
|
||||||
function cb(errorCode) {
|
function cb(errorCode) {
|
||||||
process.exit(errorCode || 0);
|
process.exit(errorCode || 0);
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,3 +1,5 @@
|
|||||||
|
'use strict';
|
||||||
|
|
||||||
var hasOwnProp = Object.prototype.hasOwnProperty;
|
var hasOwnProp = Object.prototype.hasOwnProperty;
|
||||||
|
|
||||||
function mapDependencies(index) {
|
function mapDependencies(index) {
|
||||||
|
|||||||
@ -4,6 +4,7 @@
|
|||||||
@author Michael Mathews <micmath@gmail.com>
|
@author Michael Mathews <micmath@gmail.com>
|
||||||
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var doop = require("jsdoc/util/doop").doop;
|
var doop = require("jsdoc/util/doop").doop;
|
||||||
|
|
||||||
|
|||||||
@ -7,6 +7,7 @@
|
|||||||
/**
|
/**
|
||||||
@module jsdoc/config
|
@module jsdoc/config
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
function mergeRecurse(target, source) {
|
function mergeRecurse(target, source) {
|
||||||
Object.keys(source).forEach(function(p) {
|
Object.keys(source).forEach(function(p) {
|
||||||
@ -23,7 +24,7 @@ function mergeRecurse(target, source) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// required config values, override these defaults in your config.json if necessary
|
// required config values, override these defaults in your config.json if necessary
|
||||||
const defaults = {
|
var defaults = {
|
||||||
"tags": {
|
"tags": {
|
||||||
"allowUnknownTags": true
|
"allowUnknownTags": true
|
||||||
},
|
},
|
||||||
|
|||||||
@ -7,6 +7,7 @@
|
|||||||
/**
|
/**
|
||||||
* @module jsdoc/doclet
|
* @module jsdoc/doclet
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var _ = require('underscore');
|
var _ = require('underscore');
|
||||||
var jsdoc = {
|
var jsdoc = {
|
||||||
@ -33,21 +34,21 @@ exports.GLOBAL_LONGNAME = '<global>';
|
|||||||
exports.UNDOCUMENTED_TAG = '@undocumented';
|
exports.UNDOCUMENTED_TAG = '@undocumented';
|
||||||
|
|
||||||
|
|
||||||
function applyTag(tag) {
|
function applyTag(doclet, tag) {
|
||||||
if (tag.title === 'name') {
|
if (tag.title === 'name') {
|
||||||
this.name = tag.value;
|
doclet.name = tag.value;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (tag.title === 'kind') {
|
if (tag.title === 'kind') {
|
||||||
this.kind = tag.value;
|
doclet.kind = tag.value;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (tag.title === 'description') {
|
if (tag.title === 'description') {
|
||||||
this.description = tag.value;
|
doclet.description = tag.value;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (tag.title === 'scope') {
|
if (tag.title === 'scope') {
|
||||||
this.scope = tag.value;
|
doclet.scope = tag.value;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -212,7 +213,7 @@ Doclet.prototype.addTag = function(title, text) {
|
|||||||
this.tags.push(newTag);
|
this.tags.push(newTag);
|
||||||
}
|
}
|
||||||
|
|
||||||
applyTag.call(this, newTag);
|
applyTag(this, newTag);
|
||||||
};
|
};
|
||||||
|
|
||||||
function removeGlobal(longname) {
|
function removeGlobal(longname) {
|
||||||
|
|||||||
@ -2,6 +2,8 @@
|
|||||||
* Extended version of the standard `fs` module.
|
* Extended version of the standard `fs` module.
|
||||||
* @module jsdoc/fs
|
* @module jsdoc/fs
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var fs = require('fs');
|
var fs = require('fs');
|
||||||
var path = require('path');
|
var path = require('path');
|
||||||
var runtime = require('jsdoc/util/runtime');
|
var runtime = require('jsdoc/util/runtime');
|
||||||
|
|||||||
@ -5,6 +5,7 @@
|
|||||||
@author Michael Mathews <micmath@gmail.com>
|
@author Michael Mathews <micmath@gmail.com>
|
||||||
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var _ = require('underscore');
|
var _ = require('underscore');
|
||||||
var jsdoc = {
|
var jsdoc = {
|
||||||
|
|||||||
@ -4,6 +4,7 @@
|
|||||||
@author Michael Mathews <micmath@gmail.com>
|
@author Michael Mathews <micmath@gmail.com>
|
||||||
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var _ = require('underscore');
|
var _ = require('underscore');
|
||||||
|
|
||||||
|
|||||||
@ -4,6 +4,7 @@
|
|||||||
@author Michael Mathews <micmath@gmail.com>
|
@author Michael Mathews <micmath@gmail.com>
|
||||||
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var ArgParser = require('jsdoc/opts/argparser'),
|
var ArgParser = require('jsdoc/opts/argparser'),
|
||||||
argParser = new ArgParser(),
|
argParser = new ArgParser(),
|
||||||
|
|||||||
@ -3,6 +3,7 @@
|
|||||||
@author Michael Mathews <micmath@gmail.com>
|
@author Michael Mathews <micmath@gmail.com>
|
||||||
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@module jsdoc/package
|
@module jsdoc/package
|
||||||
|
|||||||
@ -3,6 +3,7 @@
|
|||||||
* Extended version of the standard `path` module.
|
* Extended version of the standard `path` module.
|
||||||
* @module jsdoc/path
|
* @module jsdoc/path
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var fs = require('fs');
|
var fs = require('fs');
|
||||||
var path = require('path');
|
var path = require('path');
|
||||||
|
|||||||
@ -3,6 +3,7 @@
|
|||||||
* Utility functions to support the JSDoc plugin framework.
|
* Utility functions to support the JSDoc plugin framework.
|
||||||
* @module jsdoc/plugins
|
* @module jsdoc/plugins
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var error = require('jsdoc/util/error');
|
var error = require('jsdoc/util/error');
|
||||||
var path = require('jsdoc/path');
|
var path = require('jsdoc/path');
|
||||||
|
|||||||
@ -6,6 +6,7 @@
|
|||||||
* @author Michael Mathews <micmath@gmail.com>
|
* @author Michael Mathews <micmath@gmail.com>
|
||||||
* @author Ben Blank <ben.blank@gmail.com>
|
* @author Ben Blank <ben.blank@gmail.com>
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var fs = require('jsdoc/fs'),
|
var fs = require('jsdoc/fs'),
|
||||||
markdown = require('jsdoc/util/markdown');
|
markdown = require('jsdoc/util/markdown');
|
||||||
|
|||||||
@ -4,6 +4,7 @@
|
|||||||
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
||||||
@see <http://tools.ietf.org/html/draft-zyp-json-schema-02>
|
@see <http://tools.ietf.org/html/draft-zyp-json-schema-02>
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
exports.jsdocSchema = {
|
exports.jsdocSchema = {
|
||||||
"properties": {
|
"properties": {
|
||||||
|
|||||||
@ -1,3 +1,5 @@
|
|||||||
|
'use strict';
|
||||||
|
|
||||||
var Syntax = require('jsdoc/src/syntax').Syntax;
|
var Syntax = require('jsdoc/src/syntax').Syntax;
|
||||||
|
|
||||||
// TODO: should set e.stopPropagation == true for consistency with Rhino, right?
|
// TODO: should set e.stopPropagation == true for consistency with Rhino, right?
|
||||||
|
|||||||
@ -5,6 +5,7 @@
|
|||||||
@author Michael Mathews <micmath@gmail.com>
|
@author Michael Mathews <micmath@gmail.com>
|
||||||
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var path = require('jsdoc/path');
|
var path = require('jsdoc/path');
|
||||||
|
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
/**
|
/**
|
||||||
* @module jsdoc/src/handlers
|
* @module jsdoc/src/handlers
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var currentModule = null;
|
var currentModule = null;
|
||||||
|
|
||||||
@ -46,7 +46,7 @@ exports.attachTo = function(parser) {
|
|||||||
return false; // only interested in virtual comments (with a @name) here
|
return false; // only interested in virtual comments (with a @name) here
|
||||||
}
|
}
|
||||||
|
|
||||||
addDoclet.call(this, newDoclet);
|
addDoclet.call(parser, newDoclet);
|
||||||
|
|
||||||
e.doclet = newDoclet;
|
e.doclet = newDoclet;
|
||||||
});
|
});
|
||||||
@ -56,7 +56,7 @@ exports.attachTo = function(parser) {
|
|||||||
var subDoclets = e.comment.split(/@also\b/g);
|
var subDoclets = e.comment.split(/@also\b/g);
|
||||||
|
|
||||||
for (var i = 0, l = subDoclets.length; i < l; i++) {
|
for (var i = 0, l = subDoclets.length; i < l; i++) {
|
||||||
newSymbolDoclet.call(this, subDoclets[i], e);
|
newSymbolDoclet.call(parser, subDoclets[i], e);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -74,7 +74,7 @@ exports.attachTo = function(parser) {
|
|||||||
|
|
||||||
if (newDoclet.alias) {
|
if (newDoclet.alias) {
|
||||||
if (newDoclet.alias === '{@thisClass}') {
|
if (newDoclet.alias === '{@thisClass}') {
|
||||||
memberofName = this.resolveThis(e.astnode);
|
memberofName = parser.resolveThis(e.astnode);
|
||||||
|
|
||||||
// "class" refers to the owner of the prototype, not the prototype itself
|
// "class" refers to the owner of the prototype, not the prototype itself
|
||||||
if ( /^(.+?)(\.prototype|#)$/.test(memberofName) ) {
|
if ( /^(.+?)(\.prototype|#)$/.test(memberofName) ) {
|
||||||
@ -107,7 +107,7 @@ exports.attachTo = function(parser) {
|
|||||||
else {
|
else {
|
||||||
// like /** @module foo */ exports = {bar: 1};
|
// like /** @module foo */ exports = {bar: 1};
|
||||||
// or /** blah */ this.foo = 1;
|
// or /** blah */ this.foo = 1;
|
||||||
memberofName = this.resolveThis(e.astnode);
|
memberofName = parser.resolveThis(e.astnode);
|
||||||
scope = nameStartsWith === 'exports'? 'static' : 'instance';
|
scope = nameStartsWith === 'exports'? 'static' : 'instance';
|
||||||
|
|
||||||
// like /** @module foo */ this.bar = 1;
|
// like /** @module foo */ this.bar = 1;
|
||||||
@ -125,7 +125,7 @@ exports.attachTo = function(parser) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
else {
|
else {
|
||||||
memberofName = this.astnodeToMemberof(e.astnode);
|
memberofName = parser.astnodeToMemberof(e.astnode);
|
||||||
if( Array.isArray(memberofName) ) {
|
if( Array.isArray(memberofName) ) {
|
||||||
basename = memberofName[1];
|
basename = memberofName[1];
|
||||||
memberofName = memberofName[0];
|
memberofName = memberofName[0];
|
||||||
@ -166,7 +166,7 @@ exports.attachTo = function(parser) {
|
|||||||
newDoclet.scope = 'global';
|
newDoclet.scope = 'global';
|
||||||
}
|
}
|
||||||
|
|
||||||
addDoclet.call(this, newDoclet);
|
addDoclet.call(parser, newDoclet);
|
||||||
e.doclet = newDoclet;
|
e.doclet = newDoclet;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -179,10 +179,10 @@ exports.attachTo = function(parser) {
|
|||||||
if (newDoclet) {
|
if (newDoclet) {
|
||||||
setCurrentModule(newDoclet);
|
setCurrentModule(newDoclet);
|
||||||
e = { doclet: newDoclet };
|
e = { doclet: newDoclet };
|
||||||
this.emit('newDoclet', e);
|
parser.emit('newDoclet', e);
|
||||||
|
|
||||||
if ( !e.defaultPrevented && !filter(newDoclet) ) {
|
if ( !e.defaultPrevented && !filter(newDoclet) ) {
|
||||||
this.addResult(newDoclet);
|
parser.addResult(newDoclet);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -2,6 +2,7 @@
|
|||||||
/**
|
/**
|
||||||
* @module jsdoc/src/parser
|
* @module jsdoc/src/parser
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var Doclet = require('jsdoc/doclet');
|
var Doclet = require('jsdoc/doclet');
|
||||||
var name = require('jsdoc/name');
|
var name = require('jsdoc/name');
|
||||||
|
|||||||
@ -6,7 +6,7 @@
|
|||||||
@author Michael Mathews <micmath@gmail.com>
|
@author Michael Mathews <micmath@gmail.com>
|
||||||
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var fs = require('jsdoc/fs');
|
var fs = require('jsdoc/fs');
|
||||||
var path = require('jsdoc/path');
|
var path = require('jsdoc/path');
|
||||||
|
|||||||
@ -1,3 +1,5 @@
|
|||||||
|
'use strict';
|
||||||
|
|
||||||
// TODO: docs
|
// TODO: docs
|
||||||
exports.Syntax = {
|
exports.Syntax = {
|
||||||
ArrayExpression: 'ArrayExpression',
|
ArrayExpression: 'ArrayExpression',
|
||||||
|
|||||||
@ -1,6 +1,7 @@
|
|||||||
/**
|
/**
|
||||||
* @module jsdoc/src/visitor
|
* @module jsdoc/src/visitor
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
// TODO: consider exporting more stuff so users can override it
|
// TODO: consider exporting more stuff so users can override it
|
||||||
|
|
||||||
|
|||||||
@ -5,6 +5,7 @@
|
|||||||
* @module jsdoc/src/walker
|
* @module jsdoc/src/walker
|
||||||
* @license MIT
|
* @license MIT
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var Syntax = require('jsdoc/src/syntax').Syntax;
|
var Syntax = require('jsdoc/src/syntax').Syntax;
|
||||||
|
|
||||||
|
|||||||
@ -12,6 +12,7 @@
|
|||||||
@requires jsdoc/tag/validator
|
@requires jsdoc/tag/validator
|
||||||
@requires jsdoc/tag/type
|
@requires jsdoc/tag/type
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var jsdoc = {
|
var jsdoc = {
|
||||||
tag: {
|
tag: {
|
||||||
|
|||||||
@ -3,6 +3,7 @@
|
|||||||
@author Michael Mathews <micmath@gmail.com>
|
@author Michael Mathews <micmath@gmail.com>
|
||||||
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var hasOwnProp = Object.prototype.hasOwnProperty;
|
var hasOwnProp = Object.prototype.hasOwnProperty;
|
||||||
|
|
||||||
|
|||||||
@ -6,6 +6,7 @@
|
|||||||
@author Michael Mathews <micmath@gmail.com>
|
@author Michael Mathews <micmath@gmail.com>
|
||||||
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var path = require('jsdoc/path');
|
var path = require('jsdoc/path');
|
||||||
var Syntax = require('jsdoc/src/syntax').Syntax;
|
var Syntax = require('jsdoc/src/syntax').Syntax;
|
||||||
|
|||||||
@ -4,6 +4,7 @@
|
|||||||
* @author Jeff Williams <jeffrey.l.williams@gmail.com>
|
* @author Jeff Williams <jeffrey.l.williams@gmail.com>
|
||||||
* @license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
* @license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Information about an inline tag that was found within a string.
|
* Information about an inline tag that was found within a string.
|
||||||
@ -94,7 +95,7 @@ exports.replaceInlineTags = function(string, replacers) {
|
|||||||
};
|
};
|
||||||
tagInfo.push(matchedTag);
|
tagInfo.push(matchedTag);
|
||||||
|
|
||||||
return replacer.call(this, string, matchedTag);
|
return replacer(string, matchedTag);
|
||||||
}
|
}
|
||||||
|
|
||||||
string = string || '';
|
string = string || '';
|
||||||
|
|||||||
@ -5,6 +5,7 @@
|
|||||||
* @author Jeff Williams <jeffrey.l.williams@gmail.com>
|
* @author Jeff Williams <jeffrey.l.williams@gmail.com>
|
||||||
* @license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
* @license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var jsdoc = {
|
var jsdoc = {
|
||||||
name: require('jsdoc/name'),
|
name: require('jsdoc/name'),
|
||||||
|
|||||||
@ -6,7 +6,7 @@
|
|||||||
@author Michael Mathews <micmath@gmail.com>
|
@author Michael Mathews <micmath@gmail.com>
|
||||||
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var dictionary = require('jsdoc/tag/dictionary');
|
var dictionary = require('jsdoc/tag/dictionary');
|
||||||
var format = require('util').format;
|
var format = require('util').format;
|
||||||
|
|||||||
@ -4,6 +4,7 @@
|
|||||||
* @author <a href="mailto:matthewkastor@gmail.com">Matthew Christopher Kastor-Inare III</a>
|
* @author <a href="mailto:matthewkastor@gmail.com">Matthew Christopher Kastor-Inare III</a>
|
||||||
* @license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
* @license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var _ = require('underscore'),
|
var _ = require('underscore'),
|
||||||
fs = require('jsdoc/fs'),
|
fs = require('jsdoc/fs'),
|
||||||
|
|||||||
@ -3,6 +3,7 @@
|
|||||||
@author Rafał Wrzeszcz <rafal.wrzeszcz@wrzasq.pl>
|
@author Rafał Wrzeszcz <rafal.wrzeszcz@wrzasq.pl>
|
||||||
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var markdown = require('jsdoc/util/markdown');
|
var markdown = require('jsdoc/util/markdown');
|
||||||
|
|
||||||
|
|||||||
@ -8,6 +8,7 @@
|
|||||||
/**
|
/**
|
||||||
@module jsdoc/tutorial/resolver
|
@module jsdoc/tutorial/resolver
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var tutorial = require('jsdoc/tutorial'),
|
var tutorial = require('jsdoc/tutorial'),
|
||||||
fs = require('jsdoc/fs'),
|
fs = require('jsdoc/fs'),
|
||||||
|
|||||||
@ -2,6 +2,8 @@
|
|||||||
Deep clone a simple object.
|
Deep clone a simple object.
|
||||||
@private
|
@private
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
function doop(o) {
|
function doop(o) {
|
||||||
var clone;
|
var clone;
|
||||||
var props;
|
var props;
|
||||||
|
|||||||
@ -4,6 +4,7 @@
|
|||||||
* @author Michael Mathews <micmath@gmail.com>
|
* @author Michael Mathews <micmath@gmail.com>
|
||||||
* @license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
* @license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var util = require('util');
|
var util = require('util');
|
||||||
|
|
||||||
@ -36,7 +37,7 @@ function checkCircularRefs(o, func) {
|
|||||||
}
|
}
|
||||||
else {
|
else {
|
||||||
seenItems.push(o);
|
seenItems.push(o);
|
||||||
return func.call(this, o);
|
return func(o);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@ -3,6 +3,7 @@
|
|||||||
Helper functions for handling errors.
|
Helper functions for handling errors.
|
||||||
@module jsdoc/util/error
|
@module jsdoc/util/error
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Handle an exception appropriately based on whether lenient mode is enabled:
|
Handle an exception appropriately based on whether lenient mode is enabled:
|
||||||
|
|||||||
@ -6,6 +6,7 @@
|
|||||||
* @author Michael Mathews <micmath@gmail.com>
|
* @author Michael Mathews <micmath@gmail.com>
|
||||||
* @author Ben Blank <ben.blank@gmail.com>
|
* @author Ben Blank <ben.blank@gmail.com>
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Enumeration of Markdown parsers that are available.
|
* Enumeration of Markdown parsers that are available.
|
||||||
|
|||||||
@ -5,6 +5,7 @@
|
|||||||
* @module jsdoc/util/runtime
|
* @module jsdoc/util/runtime
|
||||||
* @private
|
* @private
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var os = require('os');
|
var os = require('os');
|
||||||
|
|
||||||
|
|||||||
@ -2,6 +2,7 @@
|
|||||||
/**
|
/**
|
||||||
* @module jsdoc/util/templateHelper
|
* @module jsdoc/util/templateHelper
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var dictionary = require('jsdoc/tag/dictionary');
|
var dictionary = require('jsdoc/tag/dictionary');
|
||||||
var util = require('util');
|
var util = require('util');
|
||||||
|
|||||||
@ -1,3 +1,5 @@
|
|||||||
|
'use strict';
|
||||||
|
|
||||||
var fs = require('fs');
|
var fs = require('fs');
|
||||||
var path = require('path');
|
var path = require('path');
|
||||||
var stream = require('stream');
|
var stream = require('stream');
|
||||||
|
|||||||
@ -1,3 +1,5 @@
|
|||||||
|
'use strict';
|
||||||
|
|
||||||
exports.pathToUri = function(_path) {
|
exports.pathToUri = function(_path) {
|
||||||
return _path;
|
return _path;
|
||||||
};
|
};
|
||||||
|
|||||||
@ -1,5 +1,7 @@
|
|||||||
#!/usr/bin/env node
|
#!/usr/bin/env node
|
||||||
|
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var fs = require('fs');
|
var fs = require('fs');
|
||||||
var path = require('path');
|
var path = require('path');
|
||||||
|
|
||||||
|
|||||||
@ -3,7 +3,7 @@
|
|||||||
@module plugins/commentConvert
|
@module plugins/commentConvert
|
||||||
@author Michael Mathews <micmath@gmail.com>
|
@author Michael Mathews <micmath@gmail.com>
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
exports.handlers = {
|
exports.handlers = {
|
||||||
///
|
///
|
||||||
|
|||||||
@ -5,6 +5,7 @@
|
|||||||
* @module plugins/commentsOnly
|
* @module plugins/commentsOnly
|
||||||
* @author Jeff Williams <jeffrey.l.williams@gmail.com>
|
* @author Jeff Williams <jeffrey.l.williams@gmail.com>
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
exports.handlers = {
|
exports.handlers = {
|
||||||
beforeParse: function(e) {
|
beforeParse: function(e) {
|
||||||
|
|||||||
@ -3,7 +3,7 @@
|
|||||||
@module plugins/escapeHtml
|
@module plugins/escapeHtml
|
||||||
@author Michael Mathews <micmath@gmail.com>
|
@author Michael Mathews <micmath@gmail.com>
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
exports.handlers = {
|
exports.handlers = {
|
||||||
/**
|
/**
|
||||||
|
|||||||
@ -4,6 +4,7 @@
|
|||||||
* @module plugins/eventDumper
|
* @module plugins/eventDumper
|
||||||
* @author Jeff Williams <jeffrey.l.williams@gmail.com>
|
* @author Jeff Williams <jeffrey.l.williams@gmail.com>
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var _ = require('underscore');
|
var _ = require('underscore');
|
||||||
var util = require('util');
|
var util = require('util');
|
||||||
|
|||||||
@ -5,6 +5,8 @@
|
|||||||
* @author Michael Mathews <micmath@gmail.com>
|
* @author Michael Mathews <micmath@gmail.com>
|
||||||
* @author Ben Blank <ben.blank@gmail.com>
|
* @author Ben Blank <ben.blank@gmail.com>
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var conf = env.conf.markdown;
|
var conf = env.conf.markdown;
|
||||||
var defaultTags = [ "classdesc", "description", "params", "properties", "returns", "see"];
|
var defaultTags = [ "classdesc", "description", "params", "properties", "returns", "see"];
|
||||||
var hasOwnProp = Object.prototype.hasOwnProperty;
|
var hasOwnProp = Object.prototype.hasOwnProperty;
|
||||||
|
|||||||
@ -36,6 +36,7 @@
|
|||||||
* @author Jeff Williams <jeffrey.l.williams@gmail.com>
|
* @author Jeff Williams <jeffrey.l.williams@gmail.com>
|
||||||
* @license Apache License 2.0
|
* @license Apache License 2.0
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
// lookup table of function doclets by longname
|
// lookup table of function doclets by longname
|
||||||
var functionDoclets;
|
var functionDoclets;
|
||||||
|
|||||||
@ -4,6 +4,7 @@
|
|||||||
@module plugins/partial
|
@module plugins/partial
|
||||||
@author Ludo Antonov <ludo@hulu.com>
|
@author Ludo Antonov <ludo@hulu.com>
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var fs = require('jsdoc/fs');
|
var fs = require('jsdoc/fs');
|
||||||
var path = require('path');
|
var path = require('path');
|
||||||
|
|||||||
@ -3,7 +3,7 @@
|
|||||||
@module plugins/railsTemplate
|
@module plugins/railsTemplate
|
||||||
@author Jannon Frank <jannon@jannon.net>
|
@author Jannon Frank <jannon@jannon.net>
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
exports.handlers = {
|
exports.handlers = {
|
||||||
/**
|
/**
|
||||||
|
|||||||
@ -3,6 +3,7 @@
|
|||||||
@module plugins/shout
|
@module plugins/shout
|
||||||
@author Michael Mathews <micmath@gmail.com>
|
@author Michael Mathews <micmath@gmail.com>
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
exports.handlers = {
|
exports.handlers = {
|
||||||
/**
|
/**
|
||||||
|
|||||||
@ -2,6 +2,7 @@
|
|||||||
@module plugins/sourcetag
|
@module plugins/sourcetag
|
||||||
@author Michael Mathews <micmath@gmail.com>
|
@author Michael Mathews <micmath@gmail.com>
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
exports.handlers = {
|
exports.handlers = {
|
||||||
/**
|
/**
|
||||||
|
|||||||
@ -4,6 +4,7 @@
|
|||||||
* @author Rob Taylor <manix84@gmail.com> - The basic idea
|
* @author Rob Taylor <manix84@gmail.com> - The basic idea
|
||||||
* @author Michael Mathews <micmath@gmail.com> - Wrote the first itteration with me :)
|
* @author Michael Mathews <micmath@gmail.com> - Wrote the first itteration with me :)
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
exports.handlers = {
|
exports.handlers = {
|
||||||
/**
|
/**
|
||||||
|
|||||||
@ -1 +1,3 @@
|
|||||||
|
'use strict';
|
||||||
|
|
||||||
module.exports = require('crypto-browserify');
|
module.exports = require('crypto-browserify');
|
||||||
|
|||||||
@ -3,6 +3,7 @@
|
|||||||
* @see https://github.com/substack/node-browserify
|
* @see https://github.com/substack/node-browserify
|
||||||
* @license MIT
|
* @license MIT
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
if (!process.EventEmitter) {
|
if (!process.EventEmitter) {
|
||||||
process.EventEmitter = function () {};
|
process.EventEmitter = function () {};
|
||||||
|
|||||||
@ -4,6 +4,7 @@
|
|||||||
* Partial Rhino shim for Node.js' `fs` module.
|
* Partial Rhino shim for Node.js' `fs` module.
|
||||||
* @see http://nodejs.org/api/fs.html
|
* @see http://nodejs.org/api/fs.html
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var path = require('path');
|
var path = require('path');
|
||||||
var util = require('util');
|
var util = require('util');
|
||||||
|
|||||||
@ -1,4 +1,5 @@
|
|||||||
// Platform-specific functions to support jsdoc.js
|
// Platform-specific functions to support jsdoc.js
|
||||||
|
'use strict';
|
||||||
|
|
||||||
exports.pathToUri = function(_path) {
|
exports.pathToUri = function(_path) {
|
||||||
return String( new java.io.File(_path).toURI() );
|
return String( new java.io.File(_path).toURI() );
|
||||||
|
|||||||
@ -3,6 +3,7 @@
|
|||||||
* Creates an Esprima-compatible AST using Rhino's JavaScript parser.
|
* Creates an Esprima-compatible AST using Rhino's JavaScript parser.
|
||||||
* @module rhino/jsdoc/src/astbuilder
|
* @module rhino/jsdoc/src/astbuilder
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var AstBuilder = exports.AstBuilder = function() {
|
var AstBuilder = exports.AstBuilder = function() {
|
||||||
this._builder = new Packages.org.jsdoc.AstBuilder();
|
this._builder = new Packages.org.jsdoc.AstBuilder();
|
||||||
|
|||||||
@ -1,4 +1,5 @@
|
|||||||
// TODO: module docs
|
// TODO: module docs
|
||||||
|
'use strict';
|
||||||
|
|
||||||
// TODO: docs
|
// TODO: docs
|
||||||
exports.createParser = require('jsdoc/src/parser').createParser;
|
exports.createParser = require('jsdoc/src/parser').createParser;
|
||||||
|
|||||||
@ -1,4 +1,5 @@
|
|||||||
// TODO: module docs
|
// TODO: module docs
|
||||||
|
'use strict';
|
||||||
|
|
||||||
// TODO: docs
|
// TODO: docs
|
||||||
var Visitor = exports.Visitor = function(parser) {
|
var Visitor = exports.Visitor = function(parser) {
|
||||||
|
|||||||
@ -4,6 +4,7 @@
|
|||||||
* @author Jeff Williams <jeffrey.l.williams@gmail.com>
|
* @author Jeff Williams <jeffrey.l.williams@gmail.com>
|
||||||
* @see http://nodejs.org/api/os.html
|
* @see http://nodejs.org/api/os.html
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
exports.EOL = String( java.lang.System.getProperty('line.separator') );
|
exports.EOL = String( java.lang.System.getProperty('line.separator') );
|
||||||
|
|
||||||
|
|||||||
@ -1,3 +1,5 @@
|
|||||||
|
'use strict';
|
||||||
|
|
||||||
var isWindows = java.lang.System.getProperty("os.name").toLowerCase().contains("windows");
|
var isWindows = java.lang.System.getProperty("os.name").toLowerCase().contains("windows");
|
||||||
var fileSeparator = exports.sep = String( java.lang.System.getProperty("file.separator") );
|
var fileSeparator = exports.sep = String( java.lang.System.getProperty("file.separator") );
|
||||||
|
|
||||||
|
|||||||
@ -5,6 +5,8 @@
|
|||||||
* @see https://github.com/joyent/node/blob/f105f2f2/lib/querystring.js
|
* @see https://github.com/joyent/node/blob/f105f2f2/lib/querystring.js
|
||||||
* @license MIT
|
* @license MIT
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var QueryString = exports;
|
var QueryString = exports;
|
||||||
|
|
||||||
// If obj.hasOwnProperty has been overridden, then calling
|
// If obj.hasOwnProperty has been overridden, then calling
|
||||||
|
|||||||
@ -18,6 +18,8 @@ global.setInterval = null;
|
|||||||
global.clearInterval = null;
|
global.clearInterval = null;
|
||||||
|
|
||||||
(function() {
|
(function() {
|
||||||
|
'use strict';
|
||||||
|
|
||||||
// TODO: tune number of threads if necessary
|
// TODO: tune number of threads if necessary
|
||||||
var timerPool = new java.util.concurrent.ScheduledThreadPoolExecutor(10);
|
var timerPool = new java.util.concurrent.ScheduledThreadPoolExecutor(10);
|
||||||
var timers = {};
|
var timers = {};
|
||||||
|
|||||||
@ -1,4 +1,6 @@
|
|||||||
/*global env: true */
|
/*global env: true */
|
||||||
|
'use strict';
|
||||||
|
|
||||||
var template = require('jsdoc/template'),
|
var template = require('jsdoc/template'),
|
||||||
fs = require('jsdoc/fs'),
|
fs = require('jsdoc/fs'),
|
||||||
path = require('jsdoc/path'),
|
path = require('jsdoc/path'),
|
||||||
|
|||||||
@ -4,6 +4,7 @@
|
|||||||
@example
|
@example
|
||||||
./jsdoc scratch/jsdoc_test.js -t templates/haruki -d console -q format=xml
|
./jsdoc scratch/jsdoc_test.js -t templates/haruki -d console -q format=xml
|
||||||
*/
|
*/
|
||||||
|
'use strict';
|
||||||
|
|
||||||
function graft(parentNode, childNodes, parentLongname, parentName) {
|
function graft(parentNode, childNodes, parentLongname, parentName) {
|
||||||
childNodes
|
childNodes
|
||||||
@ -210,7 +211,7 @@ exports.publish = function(data, opts) {
|
|||||||
console.log( xml('jsdoc', root) );
|
console.log( xml('jsdoc', root) );
|
||||||
}
|
}
|
||||||
else {
|
else {
|
||||||
dump(root);
|
global.dump(root);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
else {
|
else {
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user