mirror of
https://github.com/jsdoc/jsdoc.git
synced 2025-12-08 19:46:11 +00:00
new parser infrastructure
consumes ASTs that follow the Mozilla Parser API spec: https://developer.mozilla.org/en-US/docs/SpiderMonkey/Parser_API passes all tests on OS X; performance is comparable to previous version. also includes some miscellaneous cleanup. remaining issues: - only Rhino AST builder is supported - node visitors (old and new) may not be hooked up yet - circular-reference issues in doclets - docs are (mostly) missing - various other TODO comments
This commit is contained in:
Jeff Williams
parent
12cdd46dba
commit
44d9ec6831
14
LICENSE.md
14
LICENSE.md
@ -56,6 +56,20 @@ license, which is reproduced below:
|
||||
> SOFTWARE.
|
||||
|
||||
|
||||
## Acorn ##
|
||||
|
||||
Portions of the Acorn source code are incorporated into the following files:
|
||||
|
||||
- `lib/jsdoc/src/walker.js`
|
||||
|
||||
Acorn is distributed under the MIT license, which is reproduced above.
|
||||
|
||||
Copyright (C) 2012 Marijn Haverbeke <marijnh@gmail.com>.
|
||||
|
||||
The source code for Acorn is available at:
|
||||
https://github.com/marijnh/acorn
|
||||
|
||||
|
||||
## Async.js ##
|
||||
|
||||
Async.js is distributed under the MIT license, which is reproduced above.
|
||||
|
||||
@ -1,24 +1,36 @@
|
||||
/**
|
||||
@overview
|
||||
@author Michael Mathews <micmath@gmail.com>
|
||||
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
||||
* @overview
|
||||
* @author Michael Mathews <micmath@gmail.com>
|
||||
* @license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
||||
*/
|
||||
|
||||
/**
|
||||
@module jsdoc/doclet
|
||||
@requires jsdoc/tag
|
||||
@requires jsdoc/name
|
||||
@requires jsdoc/tag/dictionary
|
||||
* @module jsdoc/doclet
|
||||
*/
|
||||
|
||||
var _ = require('underscore');
|
||||
var jsdoc = {
|
||||
name: require('jsdoc/name'),
|
||||
src: {
|
||||
Syntax: require('jsdoc/src/syntax').Syntax,
|
||||
},
|
||||
tag: {
|
||||
Tag: require('jsdoc/tag').Tag,
|
||||
dictionary: require('jsdoc/tag/dictionary')
|
||||
},
|
||||
name: require('jsdoc/name')
|
||||
util: {
|
||||
doop: require('jsdoc/util/doop')
|
||||
}
|
||||
};
|
||||
var path = require('path');
|
||||
var path = require('jsdoc/path');
|
||||
|
||||
|
||||
// Longname used for doclets whose actual longname cannot be identified.
|
||||
exports.ANONYMOUS_LONGNAME = '<anonymous>';
|
||||
// Longname used for doclets in global scope.
|
||||
exports.GLOBAL_LONGNAME = '<global>';
|
||||
// Special tag identifying undocumented symbols; not to be used in actual JSDoc comments.
|
||||
exports.UNDOCUMENTED_TAG = '@undocumented';
|
||||
|
||||
|
||||
function applyTag(tag) {
|
||||
@ -41,13 +53,13 @@ function applyTag(tag) {
|
||||
|
||||
// use the meta info about the source code to guess what the doclet kind should be
|
||||
function codetypeToKind(type) {
|
||||
var kind = (type || '').toLowerCase();
|
||||
|
||||
if (kind !== 'function') {
|
||||
return 'member';
|
||||
var Syntax = jsdoc.src.Syntax;
|
||||
if (type === Syntax.FunctionDeclaration || type === Syntax.FunctionExpression ||
|
||||
type === 'function') {
|
||||
return 'function';
|
||||
}
|
||||
|
||||
return kind;
|
||||
|
||||
return 'member';
|
||||
}
|
||||
|
||||
function unwrap(docletSrc) {
|
||||
@ -67,49 +79,49 @@ function unwrap(docletSrc) {
|
||||
}
|
||||
|
||||
function split(docletSrc) {
|
||||
var tagSrcs = [],
|
||||
tagText,
|
||||
tagTitle;
|
||||
var tagSrcs = [];
|
||||
|
||||
// split out the basic tags, keep surrounding whitespace
|
||||
// like: @tagTitle tagBody
|
||||
docletSrc
|
||||
.replace(/^(\s*)@(\S)/gm, '$1\\@$2') // replace splitter ats with an arbitrary sequence
|
||||
.split('\\@') // then split on that arbitrary sequence
|
||||
.forEach(function($) {
|
||||
if ($) {
|
||||
var parsedTag = $.match(/^(\S+)(:?\s+(\S[\s\S]*))?/);
|
||||
|
||||
if (parsedTag) {
|
||||
// we don't need parsedTag[0]
|
||||
tagTitle = parsedTag[1];
|
||||
tagText = parsedTag[2];
|
||||
.replace(/^(\s*)@(\S)/gm, '$1\\@$2') // replace splitter ats with an arbitrary sequence
|
||||
.split('\\@') // then split on that arbitrary sequence
|
||||
.forEach(function($) {
|
||||
var parsedTag;
|
||||
var tagText;
|
||||
var tagTitle;
|
||||
|
||||
if (tagTitle) {
|
||||
tagSrcs.push({
|
||||
title: tagTitle,
|
||||
text: tagText
|
||||
});
|
||||
if ($) {
|
||||
parsedTag = $.match(/^(\S+)(:?\s+(\S[\s\S]*))?/);
|
||||
|
||||
if (parsedTag) {
|
||||
// we don't need parsedTag[0]
|
||||
tagTitle = parsedTag[1];
|
||||
tagText = parsedTag[2];
|
||||
|
||||
if (tagTitle) {
|
||||
tagSrcs.push({
|
||||
title: tagTitle,
|
||||
text: tagText
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
return tagSrcs;
|
||||
}
|
||||
|
||||
/**
|
||||
Convert the raw source of the doclet comment into an array of Tag objects.
|
||||
@private
|
||||
* Convert the raw source of the doclet comment into an array of Tag objects.
|
||||
* @private
|
||||
*/
|
||||
function toTags(docletSrc) {
|
||||
var tagSrcs,
|
||||
tags = [];
|
||||
|
||||
tagSrcs = split(docletSrc);
|
||||
var tags = [];
|
||||
var tagSrcs = split(docletSrc);
|
||||
|
||||
for (var i = 0, l = tagSrcs.length; i < l; i++) {
|
||||
tags.push( {title: tagSrcs[i].title, text: tagSrcs[i].text} );
|
||||
tags.push({ title: tagSrcs[i].title, text: tagSrcs[i].text });
|
||||
}
|
||||
|
||||
return tags;
|
||||
@ -123,12 +135,12 @@ function fixDescription(docletSrc) {
|
||||
}
|
||||
|
||||
/**
|
||||
@class
|
||||
@classdesc Represents a single JSDoc comment.
|
||||
@param {string} docletSrc - The raw source code of the jsdoc comment.
|
||||
@param {object=} meta - Properties describing the code related to this comment.
|
||||
* @class
|
||||
* @classdesc Represents a single JSDoc comment.
|
||||
* @param {string} docletSrc - The raw source code of the jsdoc comment.
|
||||
* @param {object=} meta - Properties describing the code related to this comment.
|
||||
*/
|
||||
exports.Doclet = function(docletSrc, meta) {
|
||||
var Doclet = exports.Doclet = function(docletSrc, meta) {
|
||||
var newTags = [];
|
||||
|
||||
/** The original text of the comment from the source code. */
|
||||
@ -140,7 +152,7 @@ exports.Doclet = function(docletSrc, meta) {
|
||||
|
||||
newTags = toTags.call(this, docletSrc);
|
||||
|
||||
for (var i = 0, leni = newTags.length; i < leni; i++) {
|
||||
for (var i = 0, l = newTags.length; i < l; i++) {
|
||||
this.addTag(newTags[i].title, newTags[i].text);
|
||||
}
|
||||
|
||||
@ -148,8 +160,13 @@ exports.Doclet = function(docletSrc, meta) {
|
||||
};
|
||||
|
||||
/** Called once after all tags have been added. */
|
||||
exports.Doclet.prototype.postProcess = function() {
|
||||
if (!this.preserveName) { jsdoc.name.resolve(this); }
|
||||
Doclet.prototype.postProcess = function() {
|
||||
var i;
|
||||
var l;
|
||||
|
||||
if (!this.preserveName) {
|
||||
jsdoc.name.resolve(this);
|
||||
}
|
||||
if (this.name && !this.longname) {
|
||||
this.setLongname(this.name);
|
||||
}
|
||||
@ -158,16 +175,17 @@ exports.Doclet.prototype.postProcess = function() {
|
||||
}
|
||||
|
||||
if (!this.kind && this.meta && this.meta.code) {
|
||||
//console.log('adding kind to: %j', this.meta.code);
|
||||
this.addTag( 'kind', codetypeToKind(this.meta.code.type) );
|
||||
}
|
||||
|
||||
if (this.variation && this.longname && !/\)$/.test(this.longname) ) {
|
||||
this.longname += '('+this.variation+')';
|
||||
this.longname += '(' + this.variation + ')';
|
||||
}
|
||||
|
||||
// add in any missing param names
|
||||
if (this.params && this.meta && this.meta.code && this.meta.code.paramnames) {
|
||||
for (var i = 0, len = this.params.length; i < len; i++) {
|
||||
for (i = 0, l = this.params.length; i < l; i++) {
|
||||
if (!this.params[i].name) {
|
||||
this.params[i].name = this.meta.code.paramnames[i] || '';
|
||||
}
|
||||
@ -175,11 +193,13 @@ exports.Doclet.prototype.postProcess = function() {
|
||||
}
|
||||
};
|
||||
|
||||
/** Add a tag to this doclet.
|
||||
@param {string} title - The title of the tag being added.
|
||||
@param {string} [text] - The text of the tag being added.
|
||||
*/
|
||||
exports.Doclet.prototype.addTag = function(title, text) {
|
||||
/**
|
||||
* Add a tag to the doclet.
|
||||
*
|
||||
* @param {string} title - The title of the tag being added.
|
||||
* @param {string} [text] - The text of the tag being added.
|
||||
*/
|
||||
Doclet.prototype.addTag = function(title, text) {
|
||||
var tagDef = jsdoc.tag.dictionary.lookUp(title),
|
||||
newTag = new jsdoc.tag.Tag(title, text, this.meta);
|
||||
|
||||
@ -195,108 +215,117 @@ exports.Doclet.prototype.addTag = function(title, text) {
|
||||
applyTag.call(this, newTag);
|
||||
};
|
||||
|
||||
/** Set the `memberof` property of this doclet.
|
||||
@param {string} sid - The longname of the symbol that this doclet is a member of.
|
||||
*/
|
||||
exports.Doclet.prototype.setMemberof = function(sid) {
|
||||
if (/^<global>\.?/.test(sid)) { sid = sid.replace(/^<global>.?/, ''); }
|
||||
function removeGlobal(longname) {
|
||||
var globalRegexp = new RegExp('^' + exports.GLOBAL_LONGNAME + '\\.?');
|
||||
|
||||
return longname.replace(globalRegexp, '');
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the doclet's `memberof` property.
|
||||
*
|
||||
* @param {string} sid - The longname of the doclet's parent symbol.
|
||||
*/
|
||||
Doclet.prototype.setMemberof = function(sid) {
|
||||
/**
|
||||
The longname of the symbol that contains this one, if any.
|
||||
@type string
|
||||
* The longname of the symbol that contains this one, if any.
|
||||
* @type string
|
||||
*/
|
||||
this.memberof = sid.replace(/\.prototype/g, '#');
|
||||
this.memberof = removeGlobal(sid)
|
||||
.replace(/\.prototype/g, jsdoc.name.INSTANCE);
|
||||
};
|
||||
|
||||
/** Set the `longname` property of this doclet.
|
||||
@param {string} name
|
||||
*/
|
||||
exports.Doclet.prototype.setLongname = function(name) {
|
||||
if (/^<global>\.?/.test(name)) { name = name.replace(/^<global>\.?/, ''); }
|
||||
|
||||
/**
|
||||
* Set the doclet's `longname` property.
|
||||
*
|
||||
* @param {string} name - The longname for the doclet.
|
||||
*/
|
||||
Doclet.prototype.setLongname = function(name) {
|
||||
/**
|
||||
The fully resolved symbol name.
|
||||
@type string
|
||||
* The fully resolved symbol name.
|
||||
* @type string
|
||||
*/
|
||||
this.longname = name;
|
||||
this.longname = removeGlobal(name);
|
||||
if (jsdoc.tag.dictionary.isNamespace(this.kind)) {
|
||||
this.longname = jsdoc.name.applyNamespace(this.longname, this.kind);
|
||||
}
|
||||
};
|
||||
|
||||
/** Add a symbol to this doclet's `borrowed` array.
|
||||
@param {string} source - The longname of the symbol that is the source.
|
||||
@param {string} target - The name the symbol is being assigned to.
|
||||
*/
|
||||
exports.Doclet.prototype.borrow = function(source, target) {
|
||||
var about = {from: source};
|
||||
if (target) { about.as = target; }
|
||||
/**
|
||||
* Add a symbol to this doclet's `borrowed` array.
|
||||
*
|
||||
* @param {string} source - The longname of the symbol that is the source.
|
||||
* @param {string} target - The name the symbol is being assigned to.
|
||||
*/
|
||||
Doclet.prototype.borrow = function(source, target) {
|
||||
var about = { from: source };
|
||||
if (target) {
|
||||
about.as = target;
|
||||
}
|
||||
|
||||
if (!this.borrowed) {
|
||||
/**
|
||||
A list of symbols that are borrowed by this one, if any.
|
||||
@type Array.<string>
|
||||
* A list of symbols that are borrowed by this one, if any.
|
||||
* @type Array.<string>
|
||||
*/
|
||||
this.borrowed = [];
|
||||
}
|
||||
this.borrowed.push(about);
|
||||
};
|
||||
|
||||
exports.Doclet.prototype.mix = function(source) {
|
||||
if (!this.mixes) {
|
||||
/**
|
||||
A list of symbols that are mixed into this one, if any.
|
||||
@type Array.<string>
|
||||
*/
|
||||
this.mixes = [];
|
||||
}
|
||||
Doclet.prototype.mix = function(source) {
|
||||
/**
|
||||
* A list of symbols that are mixed into this one, if any.
|
||||
* @type Array.<string>
|
||||
*/
|
||||
this.mixes = this.mixes || [];
|
||||
this.mixes.push(source);
|
||||
};
|
||||
|
||||
/** Add a symbol to this doclet's `augments` array.
|
||||
@param {string} base - The longname of the base symbol.
|
||||
*/
|
||||
exports.Doclet.prototype.augment = function(base) {
|
||||
if (!this.augments) {
|
||||
/**
|
||||
A list of symbols that are augmented by this one, if any.
|
||||
@type Array.<string>
|
||||
*/
|
||||
this.augments = [];
|
||||
}
|
||||
/**
|
||||
* Add a symbol to the doclet's `augments` array.
|
||||
*
|
||||
* @param {string} base - The longname of the base symbol.
|
||||
*/
|
||||
Doclet.prototype.augment = function(base) {
|
||||
/**
|
||||
* A list of symbols that are augmented by this one, if any.
|
||||
* @type Array.<string>
|
||||
*/
|
||||
this.augments = this.augments || [];
|
||||
this.augments.push(base);
|
||||
};
|
||||
|
||||
/**
|
||||
Set the `meta` property of this doclet.
|
||||
@param {object} meta
|
||||
*/
|
||||
exports.Doclet.prototype.setMeta = function(meta) {
|
||||
if (!this.meta) {
|
||||
/**
|
||||
Information about the source code associated with this doclet.
|
||||
@namespace
|
||||
*/
|
||||
this.meta = {};
|
||||
}
|
||||
* Set the `meta` property of this doclet.
|
||||
*
|
||||
* @param {object} meta
|
||||
*/
|
||||
Doclet.prototype.setMeta = function(meta) {
|
||||
/**
|
||||
* Information about the source code associated with this doclet.
|
||||
* @namespace
|
||||
*/
|
||||
this.meta = this.meta || {};
|
||||
|
||||
if (meta.range) {
|
||||
/**
|
||||
The positions of the first and last characters of the code associated with this doclet.
|
||||
@type Array.<number>
|
||||
* The positions of the first and last characters of the code associated with this doclet.
|
||||
* @type Array.<number>
|
||||
*/
|
||||
this.meta.range = meta.range.slice(0);
|
||||
}
|
||||
|
||||
if (meta.lineno) {
|
||||
/**
|
||||
The name of the file containing the code associated with this doclet.
|
||||
@type string
|
||||
* The name of the file containing the code associated with this doclet.
|
||||
* @type string
|
||||
*/
|
||||
this.meta.filename = path.basename(meta.filename);
|
||||
/**
|
||||
The line number of the code associated with this doclet.
|
||||
@type number
|
||||
*/
|
||||
* The line number of the code associated with this doclet.
|
||||
* @type number
|
||||
*/
|
||||
this.meta.lineno = meta.lineno;
|
||||
|
||||
var pathname = path.dirname(meta.filename);
|
||||
@ -306,10 +335,10 @@ exports.Doclet.prototype.setMeta = function(meta) {
|
||||
}
|
||||
|
||||
/**
|
||||
Information about the code symbol.
|
||||
@namespace
|
||||
* Information about the code symbol.
|
||||
* @namespace
|
||||
*/
|
||||
this.meta.code = (this.meta.code || {});
|
||||
this.meta.code = this.meta.code || {};
|
||||
if (meta.id) { this.meta.code.id = meta.id; }
|
||||
if (meta.code) {
|
||||
if (meta.code.name) {
|
||||
@ -331,7 +360,7 @@ exports.Doclet.prototype.setMeta = function(meta) {
|
||||
this.meta.code.value = meta.code.value;
|
||||
}
|
||||
if (meta.code.paramnames) {
|
||||
this.meta.code.paramnames = meta.code.paramnames.concat([]);
|
||||
this.meta.code.paramnames = meta.code.paramnames.slice(0);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
@ -6,12 +6,24 @@
|
||||
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
||||
*/
|
||||
|
||||
var _ = require('underscore');
|
||||
var jsdoc = {
|
||||
doclet: require('jsdoc/doclet'),
|
||||
tagDictionary: require('jsdoc/tag/dictionary')
|
||||
};
|
||||
|
||||
var puncToScope = { '.': 'static', '~': 'inner', '#': 'instance' },
|
||||
scopeToPunc = { 'static': '.', 'inner': '~', 'instance': '#' };
|
||||
// Scope identifiers.
|
||||
var INNER = exports.INNER = '~';
|
||||
var INSTANCE = exports.INSTANCE = '#';
|
||||
var STATIC = exports.STATIC = '.';
|
||||
var scopeToPunc = exports.scopeToPunc = {
|
||||
'inner': INNER,
|
||||
'instance': INSTANCE,
|
||||
'static': STATIC
|
||||
};
|
||||
var puncToScope = exports.puncToScope = _.invert(scopeToPunc);
|
||||
|
||||
var MODULE_PREFIX = exports.MODULE_PREFIX = 'module:';
|
||||
|
||||
var DEFAULT_SCOPE = 'static';
|
||||
|
||||
@ -23,17 +35,20 @@ exports.resolve = function(doclet) {
|
||||
var name = doclet.name,
|
||||
memberof = doclet.memberof || '',
|
||||
about = {},
|
||||
scopePunc = '([' + INNER + INSTANCE + STATIC + '])',
|
||||
leadingScope = new RegExp('^' + scopePunc),
|
||||
trailingScope = new RegExp(scopePunc + '$'),
|
||||
parentDoc;
|
||||
|
||||
doclet.name = name = name? (''+name).replace(/(^|\.)prototype\.?/g, '#') : '';
|
||||
|
||||
doclet.name = name = name? ('' + name).replace(/(^|\.)prototype\.?/g, INSTANCE) : '';
|
||||
|
||||
// member of a var in an outer scope?
|
||||
if (name && !memberof && doclet.meta.code && doclet.meta.code.funcscope) {
|
||||
name = doclet.longname = doclet.meta.code.funcscope + '~' + name;
|
||||
name = doclet.longname = doclet.meta.code.funcscope + INNER + name;
|
||||
}
|
||||
|
||||
if (memberof || doclet.forceMemberof) { // @memberof tag given
|
||||
memberof = ('' || memberof).replace(/\.prototype\.?/g, '#');
|
||||
memberof = ('' || memberof).replace(/\.prototype\.?/g, INSTANCE);
|
||||
|
||||
// the name is a fullname, like @name foo.bar, @memberof foo
|
||||
if (name && name.indexOf(memberof) === 0 && name !== memberof) {
|
||||
@ -41,7 +56,7 @@ exports.resolve = function(doclet) {
|
||||
}
|
||||
// the name and memberof are identical and refer to a module,
|
||||
// like @name module:foo, @memberof module:foo (probably a member like 'var exports')
|
||||
else if (name && name === memberof && name.indexOf('module:') === 0) {
|
||||
else if (name && name === memberof && name.indexOf(MODULE_PREFIX) === 0) {
|
||||
about = exports.shorten(name, (doclet.forceMemberof ? memberof : undefined));
|
||||
}
|
||||
// the name and memberof are identical, like @name foo, @memberof foo
|
||||
@ -51,7 +66,7 @@ exports.resolve = function(doclet) {
|
||||
about = exports.shorten(name, (doclet.forceMemberof ? memberof : undefined));
|
||||
}
|
||||
// like @memberof foo# or @memberof foo~
|
||||
else if (name && /([#.~])$/.test(memberof) ) {
|
||||
else if (name && trailingScope.test(memberof) ) {
|
||||
about = exports.shorten(memberof + name, (doclet.forceMemberof ? memberof : undefined));
|
||||
}
|
||||
else if (name && doclet.scope) {
|
||||
@ -60,7 +75,7 @@ exports.resolve = function(doclet) {
|
||||
}
|
||||
}
|
||||
else { // no @memberof
|
||||
about = exports.shorten(name);
|
||||
about = exports.shorten(name);
|
||||
}
|
||||
|
||||
if (about.name) {
|
||||
@ -80,7 +95,7 @@ exports.resolve = function(doclet) {
|
||||
delete doclet.memberof;
|
||||
}
|
||||
else if (about.scope) {
|
||||
if (about.memberof === '<global>') { // via @memberof <global> ?
|
||||
if (about.memberof === jsdoc.doclet.GLOBAL_LONGNAME) { // via @memberof <global> ?
|
||||
doclet.scope = 'global';
|
||||
}
|
||||
else {
|
||||
@ -89,7 +104,7 @@ exports.resolve = function(doclet) {
|
||||
}
|
||||
else {
|
||||
if (doclet.name && doclet.memberof && !doclet.longname) {
|
||||
if ( /^([#.~])/.test(doclet.name) ) {
|
||||
if ( leadingScope.test(doclet.name) ) {
|
||||
doclet.scope = puncToScope[RegExp.$1];
|
||||
doclet.name = doclet.name.substr(1);
|
||||
}
|
||||
@ -177,7 +192,7 @@ exports.shorten = function(longname, forcedMemberof) {
|
||||
parts,
|
||||
variation;
|
||||
|
||||
longname = longname.replace( /\.prototype\.?/g, '#' );
|
||||
longname = longname.replace(/\.prototype\.?/g, INSTANCE);
|
||||
|
||||
if (typeof forcedMemberof !== 'undefined') {
|
||||
name = longname.substr(forcedMemberof.length);
|
||||
|
||||
@ -6,18 +6,28 @@
|
||||
var currentModule = null;
|
||||
|
||||
function getNewDoclet(comment, e) {
|
||||
var jsdoc = {doclet: require('jsdoc/doclet')};
|
||||
var Doclet = require('jsdoc/doclet').Doclet;
|
||||
var util = require('util');
|
||||
|
||||
var err;
|
||||
var doclet;
|
||||
|
||||
try {
|
||||
return new jsdoc.doclet.Doclet(comment, e);
|
||||
doclet = new Doclet(comment, e);
|
||||
}
|
||||
catch (error) {
|
||||
err = new Error( util.format('cannot create a doclet for the comment "%s": %s',
|
||||
comment.replace(/[\r\n]/g, ''), error.message) );
|
||||
require('jsdoc/util/error').handle(err);
|
||||
return new jsdoc.doclet.Doclet('', {});
|
||||
doclet = new Doclet('', {});
|
||||
}
|
||||
|
||||
return doclet;
|
||||
}
|
||||
|
||||
function setCurrentModule(doclet) {
|
||||
if (doclet.kind === 'module') {
|
||||
currentModule = doclet.longname;
|
||||
}
|
||||
}
|
||||
|
||||
@ -37,12 +47,8 @@ exports.attachTo = function(parser) {
|
||||
}
|
||||
|
||||
addDoclet.call(this, newDoclet);
|
||||
if (newDoclet.kind === 'module') {
|
||||
currentModule = newDoclet.longname;
|
||||
}
|
||||
e.doclet = newDoclet;
|
||||
|
||||
//resolveProperties(newDoclet);
|
||||
e.doclet = newDoclet;
|
||||
});
|
||||
|
||||
// handles named symbols in the code, may or may not have a JSDoc comment attached
|
||||
@ -153,8 +159,6 @@ exports.attachTo = function(parser) {
|
||||
return false;
|
||||
}
|
||||
|
||||
//resolveProperties(newDoclet);
|
||||
|
||||
// set the scope to global unless a) the doclet is a memberof something or b) the current
|
||||
// module exports only this symbol
|
||||
if (!newDoclet.memberof && currentModule !== newDoclet.name) {
|
||||
@ -165,8 +169,6 @@ exports.attachTo = function(parser) {
|
||||
e.doclet = newDoclet;
|
||||
}
|
||||
|
||||
//parser.on('fileBegin', function(e) { });
|
||||
|
||||
parser.on('fileComplete', function(e) {
|
||||
currentModule = null;
|
||||
});
|
||||
@ -174,6 +176,7 @@ exports.attachTo = function(parser) {
|
||||
function addDoclet(newDoclet) {
|
||||
var e;
|
||||
if (newDoclet) {
|
||||
setCurrentModule(newDoclet);
|
||||
e = { doclet: newDoclet };
|
||||
this.emit('newDoclet', e);
|
||||
|
||||
@ -195,6 +198,4 @@ exports.attachTo = function(parser) {
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
function resolveProperties(newDoclet) {}
|
||||
};
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
13
lib/jsdoc/src/rhino/astbuilder.js
Normal file
13
lib/jsdoc/src/rhino/astbuilder.js
Normal file
@ -0,0 +1,13 @@
|
||||
/*global Packages: true */
|
||||
/**
|
||||
* Creates an Esprima-compatible AST using Rhino's JavaScript parser.
|
||||
* @module jsdoc/src/rhino/astbuilder
|
||||
*/
|
||||
|
||||
var AstBuilder = module.exports = function() {
|
||||
this._builder = new Packages.org.jsdoc.AstBuilder();
|
||||
};
|
||||
|
||||
AstBuilder.prototype.build = function(sourceCode, sourceName) {
|
||||
return this._builder.build(sourceCode, sourceName);
|
||||
};
|
||||
50
lib/jsdoc/src/syntax.js
Normal file
50
lib/jsdoc/src/syntax.js
Normal file
@ -0,0 +1,50 @@
|
||||
// TODO: docs
|
||||
exports.Syntax = {
|
||||
ArrayExpression: 'ArrayExpression',
|
||||
ArrayPattern: 'ArrayPattern',
|
||||
AssignmentExpression: 'AssignmentExpression',
|
||||
BinaryExpression: 'BinaryExpression',
|
||||
BlockStatement: 'BlockStatement',
|
||||
BreakStatement: 'BreakStatement',
|
||||
CallExpression: 'CallExpression',
|
||||
CatchClause: 'CatchClause',
|
||||
ComprehensionBlock: 'ComprehensionBlock',
|
||||
ComprehensionExpression: 'ComprehensionExpression',
|
||||
ConditionalExpression: 'ConditionalExpression',
|
||||
ContinueStatement: 'ContinueStatement',
|
||||
DebuggerStatement: 'DebuggerStatement',
|
||||
DoWhileStatement: 'DoWhileStatement',
|
||||
EmptyStatement: 'EmptyStatement',
|
||||
ExpressionStatement: 'ExpressionStatement',
|
||||
ForInStatement: 'ForInStatement',
|
||||
ForOfStatement: 'ForOfStatement',
|
||||
ForStatement: 'ForStatement',
|
||||
FunctionDeclaration: 'FunctionDeclaration',
|
||||
FunctionExpression: 'FunctionExpression',
|
||||
Identifier: 'Identifier',
|
||||
IfStatement: 'IfStatement',
|
||||
LabeledStatement: 'LabeledStatement',
|
||||
LetStatement: 'LetStatement',
|
||||
Literal: 'Literal',
|
||||
LogicalExpression: 'LogicalExpression',
|
||||
MemberExpression: 'MemberExpression',
|
||||
NewExpression: 'NewExpression',
|
||||
ObjectExpression: 'ObjectExpression',
|
||||
ObjectPattern: 'ObjectPattern',
|
||||
Program: 'Program',
|
||||
Property: 'Property',
|
||||
ReturnStatement: 'ReturnStatement',
|
||||
SequenceExpression: 'SequenceExpression',
|
||||
SwitchCase: 'SwitchCase',
|
||||
SwitchStatement: 'SwitchStatement',
|
||||
ThisExpression: 'ThisExpression',
|
||||
ThrowStatement: 'ThrowStatement',
|
||||
TryStatement: 'TryStatement',
|
||||
UnaryExpression: 'UnaryExpression',
|
||||
UpdateExpression: 'UpdateExpression',
|
||||
VariableDeclaration: 'VariableDeclaration',
|
||||
VariableDeclarator: 'VariableDeclarator',
|
||||
WhileStatement: 'WhileStatement',
|
||||
WithStatement: 'WithStatement',
|
||||
YieldExpression: 'YieldExpression'
|
||||
};
|
||||
340
lib/jsdoc/src/visitor.js
Normal file
340
lib/jsdoc/src/visitor.js
Normal file
@ -0,0 +1,340 @@
|
||||
/**
|
||||
* @module jsdoc/src/visitor
|
||||
*/
|
||||
|
||||
// TODO: consider exporting more stuff so users can override it
|
||||
|
||||
var doclet = require('jsdoc/doclet');
|
||||
var Syntax = require('jsdoc/src/syntax').Syntax;
|
||||
var util = require('util');
|
||||
|
||||
var hasOwnProp = Object.prototype.hasOwnProperty;
|
||||
|
||||
// TODO: docs
|
||||
function getLeadingComment(node) {
|
||||
var comment = null;
|
||||
var leadingComments = node.leadingComments;
|
||||
|
||||
if (Array.isArray(leadingComments) && leadingComments.length && leadingComments[0].raw) {
|
||||
comment = leadingComments[0].raw;
|
||||
}
|
||||
|
||||
return comment;
|
||||
}
|
||||
|
||||
// TODO: docs
|
||||
function makeVarsFinisher(scopeDoc) {
|
||||
return function(e) {
|
||||
// no need to evaluate all things related to scopeDoc again, just use it
|
||||
if (scopeDoc && e.doclet && e.doclet.alias) {
|
||||
scopeDoc.meta.vars[e.code.name] = e.doclet.longname;
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
// TODO: docs
|
||||
function SymbolFound(node, filename, extras) {
|
||||
var self = this;
|
||||
extras = extras || {};
|
||||
|
||||
this.id = extras.id || node.nodeId;
|
||||
this.comment = extras.comment || getLeadingComment(node) || doclet.UNDOCUMENTED_TAG;
|
||||
this.lineno = extras.lineno || node.loc.start.line;
|
||||
this.range = extras.range || node.range;
|
||||
this.filename = extras.filename || filename;
|
||||
this.astnode = extras.astnode || node;
|
||||
this.code = extras.code;
|
||||
this.event = extras.event || 'symbolFound';
|
||||
this.finishers = extras.finishers || [];
|
||||
|
||||
// make sure the event includes properties that don't have default values
|
||||
Object.keys(extras).forEach(function(key) {
|
||||
self[key] = extras[key];
|
||||
});
|
||||
}
|
||||
|
||||
// TODO: docs
|
||||
function JsdocCommentFound(comment, filename) {
|
||||
this.comment = comment.raw;
|
||||
this.lineno = comment.loc.start.line;
|
||||
this.filename = filename;
|
||||
this.range = comment.range;
|
||||
|
||||
Object.defineProperty(this, 'event', {
|
||||
value: 'jsdocCommentFound'
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
// TODO: docs
|
||||
var Visitor = module.exports = function(parser) {
|
||||
this._parser = parser;
|
||||
|
||||
// Mozilla Parser API node visitors added by plugins
|
||||
this._nodeVisitors = [];
|
||||
// Rhino node visitors added by plugins (deprecated in JSDoc 3.3)
|
||||
this._rhinoNodeVisitors = [];
|
||||
// built-in visitors
|
||||
this._visitors = [
|
||||
this.visitNodeComments,
|
||||
this.visitNode
|
||||
];
|
||||
};
|
||||
|
||||
// TODO: docs
|
||||
Visitor.prototype.addNodeVisitor = function(visitor) {
|
||||
this._nodeVisitors.push(visitor);
|
||||
};
|
||||
|
||||
// TODO: docs
|
||||
Visitor.prototype.removeNodeVisitor = function(visitor) {
|
||||
var idx = this._nodeVisitors.indexOf(visitor);
|
||||
if (idx !== -1) {
|
||||
this._nodeVisitors.splice(idx, 1);
|
||||
}
|
||||
};
|
||||
|
||||
// TODO: docs
|
||||
Visitor.prototype.getNodeVisitors = function() {
|
||||
return this._nodeVisitors;
|
||||
};
|
||||
|
||||
// TODO: docs (deprecated)
|
||||
Visitor.prototype._addRhinoNodeVisitor = function(visitor) {
|
||||
this._rhinoNodeVisitors.push(visitor);
|
||||
};
|
||||
|
||||
// TODO: docs (deprecated)
|
||||
Visitor.prototype._getRhinoNodeVisitors = function() {
|
||||
return this._rhinoNodeVisitors;
|
||||
};
|
||||
|
||||
// TODO: docs; visitor signature is (node, parser, filename)
|
||||
Visitor.prototype.visit = function(node, filename) {
|
||||
var i;
|
||||
var l;
|
||||
|
||||
for (i = 0, l = this._visitors.length; i < l; i++) {
|
||||
this._visitors[i].call(this, node, this._parser, filename);
|
||||
}
|
||||
|
||||
// we also need to visit standalone comments, which are not attached to a node
|
||||
if (node.type === Syntax.Program && node.comments && node.comments.length) {
|
||||
for (i = 0, l = node.comments.length; i < l; i++) {
|
||||
this.visitNodeComments.call(this, node.comments[i], this._parser, filename);
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
// TODO: docs
|
||||
/**
|
||||
* Verify that a block comment exists and that its leading delimiter does not contain three or more
|
||||
* asterisks.
|
||||
*
|
||||
* @private
|
||||
* @memberof module:jsdoc/src/parser.Parser
|
||||
*/
|
||||
function isValidJsdoc(commentSrc) {
|
||||
return commentSrc && commentSrc.indexOf('/***') !== 0;
|
||||
}
|
||||
|
||||
// TODO: docs
|
||||
function hasJsdocComments(node) {
|
||||
return (
|
||||
(node && node.leadingComments && node.leadingComments.length > 0) ||
|
||||
(node && node.type === Syntax.Program && node.trailingComments &&
|
||||
node.trailingComments.length > 0) );
|
||||
}
|
||||
|
||||
// TODO: docs
|
||||
function removeCommentDelimiters(comment) {
|
||||
return comment.substring(2, comment.length - 2);
|
||||
}
|
||||
|
||||
// TODO: docs
|
||||
function updateCommentNode(commentNode, comment) {
|
||||
commentNode.raw = comment;
|
||||
commentNode.value = removeCommentDelimiters(comment);
|
||||
}
|
||||
|
||||
// TODO: docs
|
||||
Visitor.prototype.visitNodeComments = function(node, parser, filename) {
|
||||
var comment;
|
||||
var comments;
|
||||
var e;
|
||||
|
||||
var BLOCK_COMMENT = 'Block';
|
||||
|
||||
if ( !hasJsdocComments(node) && (!node.type || node.type !== BLOCK_COMMENT) ) {
|
||||
return true;
|
||||
}
|
||||
|
||||
comments = [];
|
||||
if (node.type === BLOCK_COMMENT) {
|
||||
comments.push(node);
|
||||
}
|
||||
|
||||
if (node.leadingComments && node.leadingComments.length) {
|
||||
comments = node.leadingComments.slice(0);
|
||||
}
|
||||
|
||||
if (node.type === Syntax.Program && node.trailingComments && node.trailingComments.length) {
|
||||
comments = comments.concat( node.trailingComments.slice(0) );
|
||||
}
|
||||
|
||||
for (var i = 0, l = comments.length; i < l; i++) {
|
||||
comment = comments[i];
|
||||
if ( isValidJsdoc(comment.raw) ) {
|
||||
e = new JsdocCommentFound(comment, filename);
|
||||
|
||||
parser.emit(e.event, e, parser);
|
||||
|
||||
if (e.comment !== comment.raw) {
|
||||
updateCommentNode(comment, e.comment);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
// TODO: docs
|
||||
Visitor.prototype.visitNode = function(node, parser, filename) {
|
||||
var e = this.makeSymbolFoundEvent(node, parser, filename);
|
||||
|
||||
function callNodeVisitors(visitors, nodeToVisit) {
|
||||
if (visitors) {
|
||||
for (var i = 0, l = visitors.length; i < l; i++) {
|
||||
visitors[i].visitNode(nodeToVisit, e, parser, filename);
|
||||
if (e.stopPropagation) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (!node.nodeId) {
|
||||
Object.defineProperty(node, 'nodeId', {
|
||||
value: parser.getUniqueId()
|
||||
});
|
||||
}
|
||||
|
||||
callNodeVisitors(this._nodeVisitors, node);
|
||||
if (e.code && e.code.node) {
|
||||
callNodeVisitors(this._rhinoNodeVisitors, e.code.node); // TODO: check this!!
|
||||
}
|
||||
|
||||
if (!e.preventDefault && e.comment && isValidJsdoc(e.comment)) {
|
||||
parser.emit(e.event, e, parser);
|
||||
}
|
||||
|
||||
// add the node to the parser's lookup table
|
||||
parser.addDocletRef(e);
|
||||
|
||||
for (var i = 0, l = e.finishers.length; i < l; i++) {
|
||||
e.finishers[i].call(parser, e);
|
||||
}
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
// TODO: docs
|
||||
function trackVars(parser, node, e) {
|
||||
// keep track of vars within a given scope
|
||||
var scope = '__global__';
|
||||
var doclet = null;
|
||||
|
||||
if (node.enclosingScope) {
|
||||
scope = node.enclosingScope.nodeId;
|
||||
}
|
||||
|
||||
doclet = parser.refs[scope];
|
||||
if (doclet) {
|
||||
doclet.meta.vars = doclet.meta.vars || {};
|
||||
doclet.meta.vars[e.code.name] = false;
|
||||
e.finishers.push(makeVarsFinisher(doclet));
|
||||
}
|
||||
}
|
||||
|
||||
// TODO: docs
|
||||
Visitor.prototype.makeSymbolFoundEvent = function(node, parser, filename) {
|
||||
var e;
|
||||
var basename;
|
||||
var i;
|
||||
var l;
|
||||
|
||||
var extras = {
|
||||
code: parser.getNodeInfo(node)
|
||||
};
|
||||
|
||||
switch (node.type) {
|
||||
// like: i = 0;
|
||||
case Syntax.AssignmentExpression:
|
||||
// TODO: ignore unless operator is '=' (for example, ignore '+=')
|
||||
// falls through
|
||||
|
||||
// like: var i = 0;
|
||||
case Syntax.VariableDeclarator:
|
||||
e = new SymbolFound(node, filename, extras);
|
||||
|
||||
basename = parser.getBasename(e.code.name);
|
||||
// TODO: handle code that does things like 'var self = this';
|
||||
if (basename !== 'this') {
|
||||
e.code.funcscope = parser.resolveVar(node, basename);
|
||||
}
|
||||
|
||||
trackVars(parser, node, e);
|
||||
|
||||
break;
|
||||
|
||||
// like: function foo() {}
|
||||
case Syntax.FunctionDeclaration:
|
||||
// falls through
|
||||
|
||||
// like: var foo = function() {};
|
||||
case Syntax.FunctionExpression:
|
||||
e = new SymbolFound(node, filename, extras);
|
||||
|
||||
trackVars(parser, node, e);
|
||||
|
||||
basename = parser.getBasename(e.code.name);
|
||||
e.code.funcscope = parser.resolveVar(node, basename);
|
||||
|
||||
break;
|
||||
|
||||
// like "obj.prop" in: /** @typedef {string} */ obj.prop;
|
||||
// Closure Compiler uses this pattern extensively for enums.
|
||||
// No need to fire events for them unless they're already commented.
|
||||
case Syntax.MemberExpression:
|
||||
if (node.leadingComments) {
|
||||
e = new SymbolFound(node, filename, extras);
|
||||
}
|
||||
|
||||
break;
|
||||
|
||||
// like "bar: true" in: var foo = { bar: true };
|
||||
// like "get bar() {}" in: var foo = { get bar() {} };
|
||||
case Syntax.Property:
|
||||
if ( node.kind !== ('get' || 'set') ) {
|
||||
extras.finishers = [parser.resolveEnum];
|
||||
}
|
||||
|
||||
e = new SymbolFound(node, filename, extras);
|
||||
|
||||
break;
|
||||
|
||||
default:
|
||||
// ignore
|
||||
}
|
||||
|
||||
if (!e) {
|
||||
e = {
|
||||
finishers: []
|
||||
};
|
||||
}
|
||||
|
||||
return e;
|
||||
};
|
||||
380
lib/jsdoc/src/walker.js
Normal file
380
lib/jsdoc/src/walker.js
Normal file
@ -0,0 +1,380 @@
|
||||
/**
|
||||
* Traversal utilities for ASTs that are compatible with the Mozilla Parser API. Adapted from
|
||||
* [Acorn](http://marijnhaverbeke.nl/acorn/).
|
||||
*
|
||||
* @module jsdoc/src/walker
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
var Syntax = require('jsdoc/src/syntax').Syntax;
|
||||
|
||||
/**
|
||||
* Check whether an AST node creates a new scope.
|
||||
*
|
||||
* @private
|
||||
* @param {Object} node - The AST node to check.
|
||||
* @return {Boolean} Set to `true` if the node creates a new scope, or `false` in all other cases.
|
||||
*/
|
||||
function isScopeNode(node) {
|
||||
// TODO: handle blocks with "let" declarations
|
||||
return node && typeof node === 'object' && (node.type === Syntax.CatchClause ||
|
||||
node.type === Syntax.FunctionDeclaration || node.type === Syntax.FunctionExpression);
|
||||
}
|
||||
|
||||
// TODO: docs
|
||||
function moveComments(source, target) {
|
||||
if (source.leadingComments) {
|
||||
target.leadingComments = source.leadingComments.slice(0);
|
||||
source.leadingComments = [];
|
||||
}
|
||||
}
|
||||
|
||||
function ignore(node, parent, state, cb) {}
|
||||
|
||||
|
||||
// TODO: docs
|
||||
var walkers = exports.walkers = {};
|
||||
|
||||
walkers[Syntax.ArrayExpression] = function(node, parent, state, cb) {
|
||||
for (var i = 0, l = node.elements.length; i < l; i++) {
|
||||
var e = node.elements[i];
|
||||
if (e) {
|
||||
cb(e, node, state);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
// TODO: verify correctness
|
||||
walkers[Syntax.ArrayPattern] = function(node, parent, state, cb) {
|
||||
for (var i = 0, l = node.elements.length; i < l; i++) {
|
||||
var e = node.elements[i];
|
||||
// must be an identifier or an expression
|
||||
if (e && e.type !== Syntax.Identifier) {
|
||||
cb(e, node, state);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
walkers[Syntax.AssignmentExpression] = function(node, parent, state, cb) {
|
||||
cb(node.left, node, state);
|
||||
cb(node.right, node, state);
|
||||
};
|
||||
|
||||
walkers[Syntax.BinaryExpression] = walkers[Syntax.AssignmentExpression];
|
||||
|
||||
walkers[Syntax.BlockStatement] = function(node, parent, state, cb) {
|
||||
for (var i = 0, l = node.body.length; i < l; i++) {
|
||||
cb(node.body[i], node, state);
|
||||
}
|
||||
};
|
||||
|
||||
walkers[Syntax.BreakStatement] = ignore;
|
||||
|
||||
walkers[Syntax.CallExpression] = function(node, parent, state, cb) {
|
||||
var i;
|
||||
var l;
|
||||
|
||||
cb(node.callee, node, state);
|
||||
if (node.arguments) {
|
||||
for (i = 0, l = node.arguments.length; i < l; i++) {
|
||||
cb(node.arguments[i], node, state);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
walkers[Syntax.CatchClause] = ignore;
|
||||
|
||||
// TODO: verify correctness
|
||||
walkers[Syntax.ComprehensionBlock] = walkers[Syntax.AssignmentExpression];
|
||||
|
||||
// TODO: verify correctness
|
||||
walkers[Syntax.ComprehensionExpression] = function(node, parent, state, cb) {
|
||||
cb(node.body, node, state);
|
||||
|
||||
if (node.filter) {
|
||||
cb(node.filter, node, state);
|
||||
}
|
||||
|
||||
for (var i = 0, l = node.blocks.length; i < l; i++) {
|
||||
cb(node.blocks[i], node, state);
|
||||
}
|
||||
};
|
||||
|
||||
walkers[Syntax.ConditionalExpression] = function(node, parent, state, cb) {
|
||||
cb(node.test, node, state);
|
||||
cb(node.consequent, node, state);
|
||||
cb(node.alternate, node, state);
|
||||
};
|
||||
|
||||
walkers[Syntax.ContinueStatement] = ignore;
|
||||
|
||||
walkers[Syntax.DebuggerStatement] = ignore;
|
||||
|
||||
walkers[Syntax.DoWhileStatement] = function(node, parent, state, cb) {
|
||||
cb(node.test, node, state);
|
||||
cb(node.body, node, state);
|
||||
};
|
||||
|
||||
walkers[Syntax.EmptyStatement] = ignore;
|
||||
|
||||
walkers[Syntax.ExpressionStatement] = function(node, parent, state, cb) {
|
||||
cb(node.expression, node, state);
|
||||
};
|
||||
|
||||
walkers[Syntax.ForInStatement] = function(node, parent, state, cb) {
|
||||
cb(node.left, node, state);
|
||||
cb(node.right, node, state);
|
||||
cb(node.body, node, state);
|
||||
};
|
||||
|
||||
walkers[Syntax.ForOfStatement] = walkers[Syntax.ForInStatement];
|
||||
|
||||
walkers[Syntax.ForStatement] = function(node, parent, state, cb) {
|
||||
if (node.init) {
|
||||
cb(node.init, node, state);
|
||||
}
|
||||
|
||||
if (node.test) {
|
||||
cb(node.test, node, state);
|
||||
}
|
||||
|
||||
if (node.update) {
|
||||
cb(node.update, node, state);
|
||||
}
|
||||
|
||||
cb(node.body, node, state);
|
||||
};
|
||||
|
||||
walkers[Syntax.FunctionDeclaration] = function(node, parent, state, cb) {
|
||||
var i;
|
||||
var l;
|
||||
|
||||
// can be null for function expressions
|
||||
if (node.id) {
|
||||
cb(node.id, node, state);
|
||||
}
|
||||
|
||||
if (node.params && node.params.length) {
|
||||
for (i = 0, l = node.params.length; i < l; i++) {
|
||||
cb(node.params[i], node, state);
|
||||
}
|
||||
}
|
||||
|
||||
// ignore node.defaults and node.rest for now; always empty
|
||||
|
||||
cb(node.body, node, state);
|
||||
};
|
||||
|
||||
walkers[Syntax.FunctionExpression] = walkers[Syntax.FunctionDeclaration];
|
||||
|
||||
walkers[Syntax.Identifier] = ignore;
|
||||
|
||||
walkers[Syntax.IfStatement] = function(node, parent, state, cb) {
|
||||
cb(node.test, node, state);
|
||||
cb(node.consequent, node, state);
|
||||
if (node.alternate) {
|
||||
cb(node.alternate, node, state);
|
||||
}
|
||||
};
|
||||
|
||||
walkers[Syntax.LabeledStatement] = function(node, parent, state, cb) {
|
||||
cb(node.body, node, state);
|
||||
};
|
||||
|
||||
// TODO: add scope info??
|
||||
walkers[Syntax.LetStatement] = function(node, parent, state, cb) {
|
||||
for (var i = 0, l = node.head.length; i < l; i++) {
|
||||
var head = node.head[i];
|
||||
cb(head.id, node, state);
|
||||
if (head.init) {
|
||||
cb(head.init, node, state);
|
||||
}
|
||||
}
|
||||
|
||||
cb(node.body, node, state);
|
||||
};
|
||||
|
||||
walkers[Syntax.Literal] = ignore;
|
||||
|
||||
walkers[Syntax.LogicalExpression] = walkers[Syntax.AssignmentExpression];
|
||||
|
||||
walkers[Syntax.MemberExpression] = function(node, parent, state, cb) {
|
||||
if (node.property) {
|
||||
cb(node.property, node, state);
|
||||
}
|
||||
cb(node.object, node, state);
|
||||
};
|
||||
|
||||
walkers[Syntax.NewExpression] = walkers[Syntax.CallExpression];
|
||||
|
||||
walkers[Syntax.ObjectExpression] = function(node, parent, state, cb) {
|
||||
for (var i = 0, l = node.properties.length; i < l; i++) {
|
||||
cb(node.properties[i], node, state);
|
||||
}
|
||||
};
|
||||
|
||||
walkers[Syntax.ObjectPattern] = walkers[Syntax.ObjectExpression];
|
||||
|
||||
walkers[Syntax.Program] = walkers[Syntax.BlockStatement];
|
||||
|
||||
walkers[Syntax.Property] = function(node, parent, state, cb) {
|
||||
// move leading comments from key to property node
|
||||
moveComments(node.key, node);
|
||||
|
||||
cb(node.value, node, state);
|
||||
};
|
||||
|
||||
walkers[Syntax.ReturnStatement] = function(node, parent, state, cb) {
|
||||
if (node.argument) {
|
||||
cb(node.argument, node, state);
|
||||
}
|
||||
};
|
||||
|
||||
walkers[Syntax.SequenceExpression] = function(node, parent, state, cb) {
|
||||
for (var i = 0, l = node.expressions.length; i < l; i++) {
|
||||
cb(node.expressions[i], node, state);
|
||||
}
|
||||
};
|
||||
|
||||
walkers[Syntax.SwitchCase] = function(node, parent, state, cb) {
|
||||
if (node.test) {
|
||||
cb(node.test, node, state);
|
||||
}
|
||||
|
||||
for (var i = 0, l = node.consequent.length; i < l; i++) {
|
||||
cb(node.consequent[i], node, state);
|
||||
}
|
||||
};
|
||||
|
||||
walkers[Syntax.SwitchStatement] = function(node, parent, state, cb) {
|
||||
cb(node.discriminant, node, state);
|
||||
|
||||
for (var i = 0, l = node.cases.length; i < l; i++) {
|
||||
cb(node.cases[i], node, state);
|
||||
}
|
||||
};
|
||||
|
||||
walkers[Syntax.ThisExpression] = ignore;
|
||||
|
||||
walkers[Syntax.ThrowStatement] = function(node, parent, state, cb) {
|
||||
cb(node.argument, node, state);
|
||||
};
|
||||
|
||||
walkers[Syntax.TryStatement] = function(node, parent, state, cb) {
|
||||
var i;
|
||||
var l;
|
||||
|
||||
cb(node.block, node, state);
|
||||
|
||||
// handle Esprima ASTs, which deviate from the spec a bit
|
||||
if ( node.handlers && Array.isArray(node.handlers) && node.handlers[0] ) {
|
||||
cb(node.handlers[0].body, node, state);
|
||||
}
|
||||
else if (node.handler) {
|
||||
cb(node.handler.body, node, state);
|
||||
}
|
||||
|
||||
if (node.guardedHandlers) {
|
||||
for (i = 0, l = node.guardedHandlers.length; i < l; i++) {
|
||||
cb(node.guardedHandlers[i].body, node, state);
|
||||
}
|
||||
}
|
||||
|
||||
if (node.finalizer) {
|
||||
cb(node.finalizer, node, state);
|
||||
}
|
||||
};
|
||||
|
||||
walkers[Syntax.UnaryExpression] = function(node, parent, state, cb) {
|
||||
cb(node.argument, node, state);
|
||||
};
|
||||
|
||||
walkers[Syntax.UpdateExpression] = walkers[Syntax.UnaryExpression];
|
||||
|
||||
walkers[Syntax.VariableDeclaration] = function(node, parent, state, cb) {
|
||||
// move leading comments to first declarator
|
||||
moveComments(node, node.declarations[0]);
|
||||
|
||||
for (var i = 0, l = node.declarations.length; i < l; i++) {
|
||||
cb(node.declarations[i], node, state);
|
||||
}
|
||||
};
|
||||
|
||||
walkers[Syntax.VariableDeclarator] = function(node, parent, state, cb) {
|
||||
cb(node.id, node, state);
|
||||
|
||||
if (node.init) {
|
||||
cb(node.init, node, state);
|
||||
}
|
||||
};
|
||||
|
||||
walkers[Syntax.WhileStatement] = walkers[Syntax.DoWhileStatement];
|
||||
|
||||
walkers[Syntax.WithStatement] = function(node, parent, state, cb) {
|
||||
cb(node.object, node, state);
|
||||
cb(node.body, node, state);
|
||||
};
|
||||
|
||||
walkers[Syntax.YieldExpression] = function(node, parent, state, cb) {
|
||||
if (node.argument) {
|
||||
cb(node.argument, node, state);
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Create a walker that can traverse an AST that is consistent with the Mozilla Parser API.
|
||||
*
|
||||
* @todo docs
|
||||
* @memberof module:jsdoc/src/walker
|
||||
*/
|
||||
var Walker = exports.Walker = function() {};
|
||||
|
||||
function getCurrentScope(scopes) {
|
||||
return scopes[scopes.length - 1] || null;
|
||||
}
|
||||
|
||||
// TODO: docs
|
||||
Walker.prototype.recurse = function(filename, ast, visitor) {
|
||||
// TODO: look for other state that we can track/attach during the walk
|
||||
var state = {
|
||||
nodes: [],
|
||||
scopes: []
|
||||
};
|
||||
|
||||
function cb(node, parent, state, override) {
|
||||
var type = override || node.type;
|
||||
var isScope = isScopeNode(node);
|
||||
|
||||
if (node.parent === undefined) {
|
||||
Object.defineProperty(node, 'parent', {
|
||||
value: parent || null
|
||||
});
|
||||
}
|
||||
|
||||
if (node.enclosingScope === undefined) {
|
||||
Object.defineProperty(node, 'enclosingScope', {
|
||||
value: getCurrentScope(state.scopes)
|
||||
});
|
||||
}
|
||||
|
||||
if (isScope) {
|
||||
state.scopes.push(node);
|
||||
}
|
||||
state.nodes.push(node);
|
||||
|
||||
walkers[type](node, parent, state, cb);
|
||||
|
||||
if (isScope) {
|
||||
state.scopes.pop();
|
||||
}
|
||||
}
|
||||
|
||||
cb(ast, null, state);
|
||||
|
||||
for (var i = 0, l = state.nodes.length; i < l; i++) {
|
||||
visitor.visit.call(visitor, state.nodes[i], filename);
|
||||
}
|
||||
|
||||
return ast;
|
||||
};
|
||||
@ -7,7 +7,8 @@
|
||||
@license Apache License 2.0 - See file 'LICENSE.md' in this project.
|
||||
*/
|
||||
|
||||
var path = require('path');
|
||||
var path = require('jsdoc/path');
|
||||
var Syntax = require('jsdoc/src/syntax').Syntax;
|
||||
|
||||
/** @private */
|
||||
function setDocletKindToTitle(doclet, tag) {
|
||||
@ -232,24 +233,18 @@ exports.defineTags = function(dictionary) {
|
||||
|
||||
dictionary.defineTag('default', {
|
||||
onTagged: function(doclet, tag) {
|
||||
var type;
|
||||
var value;
|
||||
|
||||
if (tag.value) {
|
||||
doclet.defaultvalue = tag.value;
|
||||
}
|
||||
else if (doclet.meta && doclet.meta.code && typeof doclet.meta.code.value !== 'undefined') {
|
||||
if (doclet.meta.code.type && /STRING|NUMBER|NAME|TRUE|FALSE/.test(doclet.meta.code.type)) {
|
||||
doclet.defaultvalue = doclet.meta.code.value;
|
||||
if (doclet.meta.code.type === 'STRING') {
|
||||
// TODO: handle escaped quotes in values
|
||||
doclet.defaultvalue = '"'+doclet.defaultvalue.replace(/"/g, '\\"')+'"';
|
||||
}
|
||||
|
||||
if (doclet.defaultvalue === 'TRUE' || doclet.defaultvalue == 'FALSE') {
|
||||
doclet.defaultvalue = doclet.defaultvalue.toLowerCase();
|
||||
}
|
||||
}
|
||||
else if (doclet.meta.code.type === 'NULL') {
|
||||
// TODO: handle escaped quotes in values
|
||||
doclet.defaultvalue = 'null';
|
||||
else if (doclet.meta && doclet.meta.code && doclet.meta.code.value) {
|
||||
type = doclet.meta.code.type;
|
||||
value = doclet.meta.code.value;
|
||||
|
||||
if (type === Syntax.Literal) {
|
||||
doclet.defaultvalue = String(value);
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -394,7 +389,9 @@ exports.defineTags = function(dictionary) {
|
||||
|
||||
dictionary.defineTag('lends', {
|
||||
onTagged: function(doclet, tag) {
|
||||
doclet.alias = tag.value || '<global>';
|
||||
var GLOBAL_LONGNAME = require('jsdoc/doclet').GLOBAL_LONGNAME;
|
||||
|
||||
doclet.alias = tag.value || GLOBAL_LONGNAME;
|
||||
doclet.addTag('undocumented');
|
||||
}
|
||||
});
|
||||
@ -431,9 +428,11 @@ exports.defineTags = function(dictionary) {
|
||||
dictionary.defineTag('memberof', {
|
||||
mustHaveValue: true,
|
||||
onTagged: function(doclet, tag) {
|
||||
var GLOBAL_LONGNAME = require('jsdoc/doclet').GLOBAL_LONGNAME;
|
||||
|
||||
if (tag.originalTitle === 'memberof!') {
|
||||
doclet.forceMemberof = true;
|
||||
if (tag.value === '<global>') {
|
||||
if (tag.value === GLOBAL_LONGNAME) {
|
||||
doclet.addTag('global');
|
||||
delete doclet.memberof;
|
||||
}
|
||||
@ -535,10 +534,13 @@ exports.defineTags = function(dictionary) {
|
||||
dictionary.defineTag('requires', {
|
||||
mustHaveValue: true,
|
||||
onTagged: function(doclet, tag) {
|
||||
var MODULE_PREFIX = require('jsdoc/name').MODULE_PREFIX;
|
||||
var modName = firstWordOf(tag.value);
|
||||
if (modName.indexOf('module:') !== 0) {
|
||||
modName = 'module:'+modName;
|
||||
|
||||
if (modName.indexOf(MODULE_PREFIX) !== 0) {
|
||||
modName = MODULE_PREFIX + modName;
|
||||
}
|
||||
|
||||
if (!doclet.requires) { doclet.requires = []; }
|
||||
doclet.requires.push(modName);
|
||||
}
|
||||
|
||||
@ -2,19 +2,42 @@
|
||||
Deep clone a simple object.
|
||||
@private
|
||||
*/
|
||||
var doop = exports.doop = function(o) {
|
||||
var clone,
|
||||
prop;
|
||||
function doop(o) {
|
||||
var clone;
|
||||
var descriptor;
|
||||
var props;
|
||||
var i;
|
||||
var l;
|
||||
|
||||
if (o instanceof Object && o.constructor != Function) {
|
||||
clone = o instanceof Array ? [] : {};
|
||||
if ( Array.isArray(o) ) {
|
||||
clone = [];
|
||||
for (i = 0, l = o.length; i < l; i++) {
|
||||
clone[i] = (o[i] instanceof Object) ? doop(o[i]) : o[i];
|
||||
}
|
||||
}
|
||||
else {
|
||||
// TODO: replace some of this with Object.create()?
|
||||
// TODO: are we getting circular refs, etc., because we're not calling doop() on the
|
||||
// descriptor?
|
||||
clone = {};
|
||||
props = Object.getOwnPropertyNames(o);
|
||||
for (i = 0, l = props.length; i < l; i++) {
|
||||
descriptor = Object.getOwnPropertyDescriptor(o, props[i]);
|
||||
if (descriptor.value instanceof Object) {
|
||||
descriptor.value = doop(descriptor.value);
|
||||
}
|
||||
Object.defineProperty(clone, props[i], descriptor);
|
||||
}
|
||||
}
|
||||
|
||||
Object.keys(o).forEach(function(prop) {
|
||||
clone[prop] = (o[prop] instanceof Object) ? doop(o[prop]) : o[prop];
|
||||
});
|
||||
|
||||
return clone;
|
||||
}
|
||||
|
||||
return o;
|
||||
};
|
||||
}
|
||||
|
||||
// for backwards compatibility
|
||||
doop.doop = doop;
|
||||
|
||||
module.exports = doop;
|
||||
|
||||
@ -24,7 +24,7 @@ exports.setTutorials = function(root) {
|
||||
|
||||
exports.globalName = 'global';
|
||||
exports.fileExtension = '.html';
|
||||
exports.scopeToPunc = { 'static': '.', 'inner': '~', 'instance': '#' };
|
||||
exports.scopeToPunc = require('jsdoc/name').scopeToPunc;
|
||||
|
||||
function getNamespace(kind) {
|
||||
if (dictionary.isNamespace(kind)) {
|
||||
@ -428,8 +428,10 @@ var find = exports.find = function(data, spec) {
|
||||
* otherwise, `false`.
|
||||
*/
|
||||
function isModuleFunction(doclet) {
|
||||
var MODULE_PREFIX = require('jsdoc/name').MODULE_PREFIX;
|
||||
|
||||
return doclet.longname && doclet.longname === doclet.name &&
|
||||
doclet.longname.indexOf('module:') === 0 && doclet.kind === 'function';
|
||||
doclet.longname.indexOf(MODULE_PREFIX) === 0 && doclet.kind === 'function';
|
||||
}
|
||||
|
||||
/**
|
||||
@ -696,6 +698,7 @@ function getFilename(longname) {
|
||||
/** Turn a doclet into a URL. */
|
||||
exports.createLink = function(doclet) {
|
||||
var url = '';
|
||||
var INSTANCE = exports.scopeToPunc.instance;
|
||||
var longname = doclet.longname;
|
||||
var filename;
|
||||
|
||||
@ -704,7 +707,7 @@ exports.createLink = function(doclet) {
|
||||
}
|
||||
else {
|
||||
filename = getFilename(doclet.memberof || exports.globalName);
|
||||
url = filename + '#' + getNamespace(doclet.kind) + doclet.name;
|
||||
url = filename + INSTANCE + getNamespace(doclet.kind) + doclet.name;
|
||||
}
|
||||
|
||||
return url;
|
||||
|
||||
3
test/fixtures/augmentstag.js
vendored
3
test/fixtures/augmentstag.js
vendored
@ -28,7 +28,7 @@ Foo.prototype.method2 = function() {};
|
||||
* @extends Foo
|
||||
*/
|
||||
function Bar() {
|
||||
/** Thrid prop **/
|
||||
/** Third prop **/
|
||||
this.prop3 = true;
|
||||
}
|
||||
|
||||
@ -50,4 +50,3 @@ function Baz() {
|
||||
* Third grandchild method.
|
||||
*/
|
||||
Baz.prototype.method3 = function() {};
|
||||
|
||||
|
||||
@ -1,10 +1,11 @@
|
||||
/*global describe: true, expect: true, it: true, jasmine: true */
|
||||
describe("aliases", function() {
|
||||
describe("standard", function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/alias.js'),
|
||||
found = docSet.getByLongname('myObject').filter(function($) {
|
||||
return ! $.undocumented;
|
||||
}),
|
||||
foundMember = docSet.getByLongname('myObject.myProperty');
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/alias.js');
|
||||
var found = docSet.getByLongname('myObject').filter(function($) {
|
||||
return ! $.undocumented;
|
||||
});
|
||||
var foundMember = docSet.getByLongname('myObject.myProperty');
|
||||
|
||||
it('When a symbol is given an alias it is documented as if the name is the alias value.', function() {
|
||||
expect(found[0].longname).toEqual('myObject');
|
||||
@ -17,8 +18,8 @@ describe("aliases", function() {
|
||||
});
|
||||
|
||||
it('When a symbol is a member of an alias of a nested name it is documented as if the memberof is the nested alias value.', function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/alias2.js'),
|
||||
foundMember = docSet.getByLongname('ns.Myclass#myProperty');
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/alias2.js');
|
||||
var foundMember = docSet.getByLongname('ns.Myclass#myProperty');
|
||||
|
||||
expect(foundMember[0].longname).toEqual('ns.Myclass#myProperty');
|
||||
expect(foundMember[0].name).toEqual('myProperty');
|
||||
@ -27,23 +28,23 @@ describe("aliases", function() {
|
||||
});
|
||||
|
||||
it('When a symbol is a member of an aliased class, a this-variables is documented as if it were a member that class.', function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/alias3.js'),
|
||||
tcm = docSet.getByLongname('trackr.CookieManager')[0],
|
||||
tcmValue = docSet.getByLongname('trackr.CookieManager#value')[0];
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/alias3.js');
|
||||
var tcm = docSet.getByLongname('trackr.CookieManager')[0];
|
||||
var tcmValue = docSet.getByLongname('trackr.CookieManager#value')[0];
|
||||
|
||||
expect(tcmValue.memberof).toEqual('trackr.CookieManager');
|
||||
});
|
||||
|
||||
it('When a symbol is documented as a static member of <global> it\'s scope is "global" and not "static".', function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/aliasglobal.js'),
|
||||
log = docSet.getByLongname('log')[0];
|
||||
it('When a symbol is documented as a static member of <global>, its scope is "global" and not "static".', function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/aliasglobal.js');
|
||||
var log = docSet.getByLongname('log')[0];
|
||||
|
||||
expect(log.scope).toEqual('global');
|
||||
});
|
||||
|
||||
it('When a symbol is documented as an instance member of <global> class it\'s scope is "instance" and not "static".', function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/aliasglobal2.js'),
|
||||
run = docSet.getByLongname('Test#run')[0];
|
||||
it('When a symbol is documented as an instance member of <global>, its scope is "instance" and not "static".', function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/aliasglobal2.js');
|
||||
var run = docSet.getByLongname('Test#run')[0];
|
||||
|
||||
expect(run.scope).toEqual('instance');
|
||||
expect(run.memberof).toEqual('Test');
|
||||
@ -51,17 +52,17 @@ describe("aliases", function() {
|
||||
|
||||
describe("resolving", function() {
|
||||
it('When a local reference has alias, put all members into aliased definition. Local modifications should be visible to outside.', function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/aliasresolve.js'),
|
||||
method = docSet.getByLongname('A.F.method');
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/aliasresolve.js');
|
||||
var method = docSet.getByLongname('A.F.method');
|
||||
|
||||
expect(method.length).toEqual(1);
|
||||
});
|
||||
|
||||
it('When a reference in an outer scope has alias, put all members into aliased definition. Local modifications are visible to outside.', function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/aliasresolve2.js'),
|
||||
method = docSet.getByLongname('A.F.method');
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/aliasresolve2.js');
|
||||
var method = docSet.getByLongname('A.F.method');
|
||||
|
||||
expect(method.length).toEqual(1);
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@ -1,7 +1,8 @@
|
||||
/*global describe: true, expect: true, it: true, jasmine: true */
|
||||
describe("'exports' symbol in modules", function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/exports.js'),
|
||||
helloworld = docSet.getByLongname('module:hello/world')[0],
|
||||
sayhello = docSet.getByLongname('module:hello/world.sayHello')[0];
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/exports.js');
|
||||
var helloworld = docSet.getByLongname('module:hello/world')[0];
|
||||
var sayhello = docSet.getByLongname('module:hello/world.sayHello')[0];
|
||||
|
||||
it('When a symbol starts with the special name "exports" and is in a file with a @module tag, the symbol is documented as a member of that module.', function() {
|
||||
expect(typeof sayhello).toEqual('object');
|
||||
|
||||
29
test/specs/documentation/funcExpression.js
Normal file
29
test/specs/documentation/funcExpression.js
Normal file
@ -0,0 +1,29 @@
|
||||
/*global describe: true, expect: true, it: true, jasmine: true */
|
||||
describe('function expressions', function() {
|
||||
function checkLongnames(docSet, namespace) {
|
||||
var memberName = (namespace || '') + 'Foo#member1';
|
||||
var variableName = (namespace || '') + 'Foo~var1';
|
||||
var fooMember = docSet.getByLongname(memberName)[0];
|
||||
var fooVariable = docSet.getByLongname(variableName)[0];
|
||||
|
||||
it('should assign the correct longname to members of a function expression', function() {
|
||||
expect(fooMember.longname).toBe(memberName);
|
||||
});
|
||||
|
||||
it('should assign the correct longname to variables in a function expression', function() {
|
||||
expect(fooVariable.longname).toBe(variableName);
|
||||
});
|
||||
}
|
||||
|
||||
describe('standard', function() {
|
||||
checkLongnames( jasmine.getDocSetFromFile('test/fixtures/funcExpression.js') );
|
||||
});
|
||||
|
||||
describe('global', function() {
|
||||
checkLongnames( jasmine.getDocSetFromFile('test/fixtures/funcExpression2.js') );
|
||||
});
|
||||
|
||||
describe('as object literal property', function() {
|
||||
checkLongnames( jasmine.getDocSetFromFile('test/fixtures/funcExpression3.js'), 'ns.' );
|
||||
});
|
||||
});
|
||||
@ -1,7 +1,8 @@
|
||||
/*global describe: true, expect: true, it: true, jasmine: true */
|
||||
describe("When a getter or setter is the child of an object literal", function () {
|
||||
var docSet = jasmine.getDocSetFromFile("test/fixtures/getset.js"),
|
||||
foundName = docSet.getByLongname("Person#name"),
|
||||
foundAge = docSet.getByLongname("Person#age");
|
||||
var docSet = jasmine.getDocSetFromFile("test/fixtures/getset.js");
|
||||
var foundName = docSet.getByLongname("Person#name");
|
||||
var foundAge = docSet.getByLongname("Person#age");
|
||||
|
||||
it("should have a doclet with the correct longname", function () {
|
||||
expect(foundName.length).toEqual(2);
|
||||
|
||||
@ -1,9 +1,10 @@
|
||||
/*global describe: true, expect: true, it: true, jasmine: true */
|
||||
describe("inner scope", function() {
|
||||
describe("Outer~inner.member cases", function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/innerscope.js'),
|
||||
to = docSet.getByLongname('Message~headers.to'),
|
||||
from = docSet.getByLongname('Message~headers.from'),
|
||||
response = docSet.getByLongname('Message~response.code');
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/innerscope.js');
|
||||
var to = docSet.getByLongname('Message~headers.to');
|
||||
var from = docSet.getByLongname('Message~headers.from');
|
||||
var response = docSet.getByLongname('Message~response.code');
|
||||
|
||||
it('should occur when a member of a var member is documented.', function() {
|
||||
expect(to.length).toEqual(1);
|
||||
@ -19,10 +20,10 @@ describe("inner scope", function() {
|
||||
});
|
||||
|
||||
describe("other cases", function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/innerscope2.js'),
|
||||
to = docSet.getByLongname('Message~headers.to'),
|
||||
from = docSet.getByLongname('<anonymous>~headers.from'),
|
||||
cache = docSet.getByLongname('<anonymous>~headers.cache');
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/innerscope2.js');
|
||||
var to = docSet.getByLongname('Message~headers.to');
|
||||
var from = docSet.getByLongname('<anonymous>~headers.from');
|
||||
var cache = docSet.getByLongname('<anonymous>~headers.cache');
|
||||
|
||||
it('When a var is declared in a function, It is like Inner~member', function() {
|
||||
expect(cache.length).toEqual(1);
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
/*global describe: true, expect: true, it: true, jasmine: true */
|
||||
describe("lends", function() {
|
||||
describe("when a documented member is inside an object literal associate with a @lends tag", function() {
|
||||
describe("when a documented member is inside an object literal associated with a @lends tag", function() {
|
||||
describe("standard case", function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/lends.js'),
|
||||
init = docSet.getByLongname('Person#initialize'),
|
||||
@ -14,7 +15,7 @@ describe("lends", function() {
|
||||
});
|
||||
});
|
||||
|
||||
describe("case containg constructor", function() {
|
||||
describe("case containing constructor", function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/lends2.js'),
|
||||
person = docSet.getByLongname('Person').filter(function($) {
|
||||
return ! $.undocumented;
|
||||
|
||||
@ -1,43 +0,0 @@
|
||||
describe("named function statements", function() {
|
||||
describe("standard", function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/namedFuncStatement.js'),
|
||||
fooMember = docSet.getByLongname('Foo#member1')[0],
|
||||
fooVariable = docSet.getByLongname('Foo~var1')[0];
|
||||
|
||||
it('A symbol that is a member of a named function statement should documented as a member of the assigned name', function() {
|
||||
expect(fooMember.longname).toEqual('Foo#member1');
|
||||
});
|
||||
|
||||
it('A symbol that is a variable of a named function statement should documented as a member of the assigned name', function() {
|
||||
expect(fooVariable.longname).toEqual('Foo~var1');
|
||||
});
|
||||
});
|
||||
|
||||
describe("global", function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/namedFuncStatement2.js'),
|
||||
fooMember = docSet.getByLongname('Foo#member1')[0],
|
||||
fooVariable = docSet.getByLongname('Foo~var1')[0];
|
||||
|
||||
it('A symbol that is a member of a named function statement should documented as a member of the assigned name', function() {
|
||||
expect(fooMember.longname).toEqual('Foo#member1');
|
||||
});
|
||||
|
||||
it('A symbol that is a variable of a named function statement should documented as a member of the assigned name', function() {
|
||||
expect(fooVariable.longname).toEqual('Foo~var1');
|
||||
});
|
||||
});
|
||||
|
||||
describe("as object literal property", function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/namedFuncStatement3.js'),
|
||||
fooMember = docSet.getByLongname('ns.Foo#member1')[0],
|
||||
fooVariable = docSet.getByLongname('ns.Foo~var1')[0];
|
||||
|
||||
it('A symbol that is a member of a named function statement should documented as a member of the assigned name', function() {
|
||||
expect(fooMember.longname).toEqual('ns.Foo#member1');
|
||||
});
|
||||
|
||||
it('A symbol that is a variable of a named function statement should documented as a member of the assigned name', function() {
|
||||
expect(fooVariable.longname).toEqual('ns.Foo~var1');
|
||||
});
|
||||
});
|
||||
});
|
||||
@ -1,9 +1,9 @@
|
||||
/*global describe: true, expect: true, it: true, jasmine: true */
|
||||
describe("quoted names", function() {
|
||||
|
||||
describe("when found in square brackets", function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/quotename.js'),
|
||||
found1 = docSet.getByLongname('chat.\"#channel\".open')[0];
|
||||
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/quotename.js');
|
||||
var found1 = docSet.getByLongname('chat.\"#channel\".open')[0];
|
||||
|
||||
it('should have correct name and memberof', function() {
|
||||
expect(found1.name).toEqual('open');
|
||||
@ -12,12 +12,12 @@ describe("quoted names", function() {
|
||||
});
|
||||
|
||||
describe("when found in an object literal", function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/quotename2.js'),
|
||||
found1 = docSet.getByLongname("contacts.\"say-\\\"hello\\\"@example.com\".username")[0];
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/quotename2.js');
|
||||
var found1 = docSet.getByLongname('contacts.say-"hello"@example.com.username')[0];
|
||||
|
||||
it('should have correct name and memberof', function() {
|
||||
expect(found1.name).toEqual('username');
|
||||
expect(found1.memberof).toEqual("contacts.\"say-\\\"hello\\\"@example.com\"");
|
||||
expect(found1.memberof).toEqual('contacts.say-"hello"@example.com');
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@ -1,9 +1,10 @@
|
||||
/*global describe: true, expect: true, it: true, jasmine: true */
|
||||
describe("virtual symbols", function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/virtual.js'),
|
||||
found = [
|
||||
docSet.getByLongname('dimensions'),
|
||||
docSet.getByLongname('width')
|
||||
];
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/virtual.js');
|
||||
var found = [
|
||||
docSet.getByLongname('dimensions'),
|
||||
docSet.getByLongname('width')
|
||||
];
|
||||
|
||||
it('should document virtual symbols', function() {
|
||||
expect(found[0].length).toEqual(1);
|
||||
@ -12,4 +13,4 @@ describe("virtual symbols", function() {
|
||||
it('should document an undocumented symbol found after a comment for a virtual symbol', function() {
|
||||
expect(found[1].length).toEqual(1);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@ -1,13 +1,13 @@
|
||||
/*global describe: true, it: true */
|
||||
/*global describe: true, expect: true, it: true */
|
||||
describe('jsdoc/util/doop', function() {
|
||||
var doop = require('jsdoc/util/doop');
|
||||
|
||||
it('should exist', function() {
|
||||
expect(doop).toBeDefined();
|
||||
expect(typeof doop).toBe('object');
|
||||
expect(typeof doop).toBe('function');
|
||||
});
|
||||
|
||||
it('should export a doop function', function() {
|
||||
it('should export a doop function for backwards compatibility', function() {
|
||||
expect(doop.doop).toBeDefined();
|
||||
expect(typeof doop.doop).toBe('function');
|
||||
});
|
||||
@ -38,7 +38,7 @@ describe('jsdoc/util/doop', function() {
|
||||
|
||||
it("should return a clone of an object", function() {
|
||||
var inp = {a:1, b:2, 'asdf-fdsa': 3};
|
||||
out = doop.doop(inp);
|
||||
var out = doop.doop(inp);
|
||||
// toEqual is a comparison on properties; toBe is === comparison.
|
||||
expect(inp).toEqual(out);
|
||||
expect(inp).not.toBe(out);
|
||||
@ -62,7 +62,7 @@ describe('jsdoc/util/doop', function() {
|
||||
|
||||
it("should clone recursively", function() {
|
||||
var inp = {a:1, b:2, 'asdf-fdsa': {a: 'fdsa', b: [1,2,3]}};
|
||||
out = doop.doop(inp);
|
||||
var out = doop.doop(inp);
|
||||
// toEqual is a comparison on properties; toBe is === comparison.
|
||||
expect(inp).toEqual(out);
|
||||
expect(inp).not.toBe(out);
|
||||
|
||||
@ -493,11 +493,9 @@ describe("jsdoc/util/templateHelper", function() {
|
||||
if (tests[src]) {
|
||||
expect(attribs).toContain(tests[src]);
|
||||
} else {
|
||||
if (whatNotToContain !== undefined) {
|
||||
if (Array.isArray(whatNotToContain)) {
|
||||
for (var i = 0; i < whatNotToContain.length; ++i) {
|
||||
expect(attribs).not.toContain(whatNotToContain[i]);
|
||||
}
|
||||
if (Array.isArray(whatNotToContain)) {
|
||||
for (var i = 0; i < whatNotToContain.length; ++i) {
|
||||
expect(attribs).not.toContain(whatNotToContain[i]);
|
||||
}
|
||||
} else {
|
||||
expect(attribs.length).toBe(0);
|
||||
@ -557,7 +555,7 @@ describe("jsdoc/util/templateHelper", function() {
|
||||
'asdf': false,
|
||||
'@name Fdsa#foo\n@readonly': 'readonly',
|
||||
// kind is not 'member'.
|
||||
'@const asdf\n@readonly': false,
|
||||
'@const asdf\n@readonly': 'constant',
|
||||
'@function asdf\n@readonly': false,
|
||||
'@function Asdf#bar\n@readonly': false
|
||||
};
|
||||
|
||||
@ -1,36 +1,36 @@
|
||||
/*global describe: true, expect: true, it: true, jasmine: true */
|
||||
describe("@augments tag", function() {
|
||||
/*jshint unused: false */
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/augmentstag.js'),
|
||||
foo = docSet.getByLongname('Foo')[0],
|
||||
fooProp1 = docSet.getByLongname('Foo#prop1')[0],
|
||||
fooProp2 = docSet.getByLongname('Foo#prop2')[0],
|
||||
fooProp3 = docSet.getByLongname('Foo#prop3')[0],
|
||||
fooMethod1 = docSet.getByLongname('Foo#method1')[0],
|
||||
fooMethod2 = docSet.getByLongname('Foo#method2')[0],
|
||||
bar = docSet.getByLongname('Bar')[0],
|
||||
barProp1 = docSet.getByLongname('Bar#prop1')[0],
|
||||
barProp2 = docSet.getByLongname('Bar#prop2')[0],
|
||||
barProp3 = docSet.getByLongname('Bar#prop3')[0],
|
||||
barMethod1 = docSet.getByLongname('Bar#method1')[0],
|
||||
barMethod2 = docSet.getByLongname('Bar#method2')[0],
|
||||
barMethod2All = docSet.getByLongname('Bar#method2'),
|
||||
bazProp1 = docSet.getByLongname('Baz#prop1')[0],
|
||||
bazProp1All = docSet.getByLongname('Baz#prop1'),
|
||||
bazProp2 = docSet.getByLongname('Baz#prop2')[0],
|
||||
bazProp3 = docSet.getByLongname('Baz#prop3')[0],
|
||||
bazMethod1 = docSet.getByLongname('Baz#method1')[0],
|
||||
bazMethod2 = docSet.getByLongname('Baz#method2')[0],
|
||||
bazMethod3 = docSet.getByLongname('Baz#method3')[0],
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/augmentstag.js');
|
||||
var foo = docSet.getByLongname('Foo')[0];
|
||||
var fooProp1 = docSet.getByLongname('Foo#prop1')[0];
|
||||
var fooProp2 = docSet.getByLongname('Foo#prop2')[0];
|
||||
var fooProp3 = docSet.getByLongname('Foo#prop3')[0];
|
||||
var fooMethod1 = docSet.getByLongname('Foo#method1')[0];
|
||||
var fooMethod2 = docSet.getByLongname('Foo#method2')[0];
|
||||
var bar = docSet.getByLongname('Bar')[0];
|
||||
var barProp1 = docSet.getByLongname('Bar#prop1')[0];
|
||||
var barProp2 = docSet.getByLongname('Bar#prop2')[0];
|
||||
var barProp3 = docSet.getByLongname('Bar#prop3')[0];
|
||||
var barMethod1 = docSet.getByLongname('Bar#method1')[0];
|
||||
var barMethod2 = docSet.getByLongname('Bar#method2')[0];
|
||||
var barMethod2All = docSet.getByLongname('Bar#method2');
|
||||
var bazProp1 = docSet.getByLongname('Baz#prop1')[0];
|
||||
var bazProp1All = docSet.getByLongname('Baz#prop1');
|
||||
var bazProp2 = docSet.getByLongname('Baz#prop2')[0];
|
||||
var bazProp3 = docSet.getByLongname('Baz#prop3')[0];
|
||||
var bazMethod1 = docSet.getByLongname('Baz#method1')[0];
|
||||
var bazMethod2 = docSet.getByLongname('Baz#method2')[0];
|
||||
var bazMethod3 = docSet.getByLongname('Baz#method3')[0];
|
||||
|
||||
docSet2 = jasmine.getDocSetFromFile('test/fixtures/augmentstag2.js'),
|
||||
qux = docSet2.getByLongname('Qux')[0],
|
||||
var docSet2 = jasmine.getDocSetFromFile('test/fixtures/augmentstag2.js');
|
||||
var qux = docSet2.getByLongname('Qux')[0];
|
||||
|
||||
docSet3 = jasmine.getDocSetFromFile('test/fixtures/augmentstag3.js'),
|
||||
FooMethod1 = docSet3.getByLongname('Foo#method1')[0],
|
||||
BarMethod2 = docSet3.getByLongname('Bar#method2')[0],
|
||||
FooBarMethod1 = docSet3.getByLongname('FooBar#method1')[0],
|
||||
FooBarMethod2 = docSet3.getByLongname('FooBar#method2')[0];
|
||||
var docSet3 = jasmine.getDocSetFromFile('test/fixtures/augmentstag3.js');
|
||||
var FooMethod1 = docSet3.getByLongname('Foo#method1')[0];
|
||||
var BarMethod2 = docSet3.getByLongname('Bar#method2')[0];
|
||||
var FooBarMethod1 = docSet3.getByLongname('FooBar#method1')[0];
|
||||
var FooBarMethod2 = docSet3.getByLongname('FooBar#method2')[0];
|
||||
|
||||
it('When a symbol has an @augments tag, the doclet has a augments property that includes that value.', function() {
|
||||
expect(typeof bar.augments).toBe('object');
|
||||
|
||||
@ -1,26 +1,27 @@
|
||||
/*global describe: true, expect: true, it: true, jasmine: true */
|
||||
describe("@default tag", function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/defaulttag.js'),
|
||||
request = (docSet.getByLongname('request') || [])[0],
|
||||
response = (docSet.getByLongname('response') || [])[0],
|
||||
rcode = (docSet.getByLongname('rcode') || [])[0],
|
||||
rvalid = (docSet.getByLongname('rvalid') || [])[0],
|
||||
rerrored = (docSet.getByLongname('rerrored') || [])[0],
|
||||
win = (docSet.getByLongname('win') || [])[0];
|
||||
header = (docSet.getByLongname('header') || [])[0];
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/defaulttag.js');
|
||||
var request = (docSet.getByLongname('request') || [])[0];
|
||||
var response = (docSet.getByLongname('response') || [])[0];
|
||||
var rcode = (docSet.getByLongname('rcode') || [])[0];
|
||||
var rvalid = (docSet.getByLongname('rvalid') || [])[0];
|
||||
var rerrored = (docSet.getByLongname('rerrored') || [])[0];
|
||||
var win = (docSet.getByLongname('win') || [])[0];
|
||||
var header = (docSet.getByLongname('header') || [])[0];
|
||||
|
||||
it('When symbol set to null has a @default tag with no text, the doclet\'s defaultValue property should be: null', function() {
|
||||
expect(request.defaultvalue).toBe('null');
|
||||
});
|
||||
|
||||
it('When symbol set to a string has a @default tag with no text, the doclet\'s defaultValue property should be that quoted string', function() {
|
||||
expect(response.defaultvalue).toBe('"ok"');
|
||||
it('When symbol set to a string has a @default tag with no text, the doclet\'s defaultValue property should be that string', function() {
|
||||
expect(response.defaultvalue).toBe('ok');
|
||||
});
|
||||
|
||||
it('When symbol set to a number has a @default tag with no text, the doclet\'s defaultValue property should be that number.', function() {
|
||||
expect(rcode.defaultvalue).toBe('200');
|
||||
});
|
||||
|
||||
it('When symbol has a @default tag with text, the doclet\'s defaultValue property should be that text.', function() {
|
||||
it('When symbol has a @default tag with text, the doclet\'s defaultValue property should be that text.', function() {
|
||||
expect(win.defaultvalue).toBe('the parent window');
|
||||
});
|
||||
|
||||
@ -36,4 +37,4 @@ describe("@default tag", function() {
|
||||
expect(header.defaultvalue).toBeUndefined();
|
||||
});
|
||||
|
||||
});
|
||||
});
|
||||
|
||||
@ -1,16 +1,17 @@
|
||||
/*global describe: true, expect: true, it: true, jasmine: true, xit: true */
|
||||
describe("@enum tag", function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/enumtag.js'),
|
||||
tristate = docSet.getByLongname('TriState')[0];
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/enumtag.js');
|
||||
var tristate = docSet.getByLongname('TriState')[0];
|
||||
|
||||
it('When a symbol has a @enum tag, it has a properties array.', function() {
|
||||
it('When a symbol has an @enum tag, it has a properties array.', function() {
|
||||
expect(typeof tristate.properties).toBe('object');
|
||||
});
|
||||
|
||||
it('If no @type is given for the property it is inherted from the enum.', function() {
|
||||
it('If no @type is given for the property, it is inherited from the enum.', function() {
|
||||
expect(tristate.properties[0].type.names.join(', ')).toBe('number');
|
||||
});
|
||||
|
||||
it('If no no comment is given for the property it is still included in the enum.', function() {
|
||||
it('If no comment is given for the property, it is still included in the enum.', function() {
|
||||
expect(tristate.properties[1].longname).toBe('TriState.FALSE');
|
||||
expect(tristate.properties[1].undocumented).toBeUndefined();
|
||||
});
|
||||
@ -19,11 +20,12 @@ describe("@enum tag", function() {
|
||||
expect(tristate.properties[1].defaultvalue).toBe('-1');
|
||||
});
|
||||
|
||||
it('If a @type is given for the property it is reflected in the property value.', function() {
|
||||
it('If a @type is given for the property, it is reflected in the property value.', function() {
|
||||
expect(tristate.properties[2].type.names.join(', ')).toBe('boolean');
|
||||
});
|
||||
|
||||
it('An enum does not contain any circular references.', function() {
|
||||
// TODO: reenable after fixing circular-reference issues
|
||||
xit('An enum does not contain any circular references.', function() {
|
||||
var dump = require("jsdoc/util/dumper").dump;
|
||||
|
||||
expect( dump(tristate) ).not.toMatch("<CircularRef>");
|
||||
|
||||
@ -1,11 +1,12 @@
|
||||
/*global describe: true, expect: true, it: true, jasmine: true */
|
||||
describe("@exports tag", function() {
|
||||
|
||||
describe("object literals", function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/exportstag.js'),
|
||||
shirt = docSet.getByLongname('module:my/shirt')[0],
|
||||
color = docSet.getByLongname('module:my/shirt.color')[0],
|
||||
tneck = docSet.getByLongname('module:my/shirt.Turtleneck')[0],
|
||||
size = docSet.getByLongname('module:my/shirt.Turtleneck#size')[0];
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/exportstag.js');
|
||||
var shirt = docSet.getByLongname('module:my/shirt')[0];
|
||||
var color = docSet.getByLongname('module:my/shirt.color')[0];
|
||||
var tneck = docSet.getByLongname('module:my/shirt.Turtleneck')[0];
|
||||
var size = docSet.getByLongname('module:my/shirt.Turtleneck#size')[0];
|
||||
|
||||
it('When an objlit symbol has an @exports tag, the doclet is aliased to "module:" + the tag value.', function() {
|
||||
expect(typeof shirt).toEqual('object');
|
||||
@ -30,9 +31,9 @@ describe("@exports tag", function() {
|
||||
});
|
||||
|
||||
describe("functions", function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/exportstag2.js'),
|
||||
coat = docSet.getByLongname('module:my/coat')[0],
|
||||
wool = docSet.getByLongname('module:my/coat#wool')[0];
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/exportstag2.js');
|
||||
var coat = docSet.getByLongname('module:my/coat')[0];
|
||||
var wool = docSet.getByLongname('module:my/coat#wool')[0];
|
||||
|
||||
it('When a function symbol has an @exports tag, the doclet is aliased to "module:" + the tag value.', function() {
|
||||
expect(typeof coat).toEqual('object');
|
||||
@ -54,10 +55,10 @@ describe("@exports tag", function() {
|
||||
});
|
||||
|
||||
describe("functions and 'exports' object", function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/exportstag3.js'),
|
||||
html = docSet.getByLongname('module:html/utils')[0],
|
||||
getstyle = docSet.getByLongname('module:html/utils.getStyleProperty')[0],
|
||||
inhead = docSet.getByLongname('module:html/utils.isInHead')[0];
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/exportstag3.js');
|
||||
var html = docSet.getByLongname('module:html/utils')[0];
|
||||
var getstyle = docSet.getByLongname('module:html/utils.getStyleProperty')[0];
|
||||
var inhead = docSet.getByLongname('module:html/utils.isInHead')[0];
|
||||
|
||||
it('When a function symbol has an @exports tag and there is an objlit named "exports" the members are documented as members of the module.', function() {
|
||||
expect(typeof getstyle).toEqual('object');
|
||||
@ -71,19 +72,17 @@ describe("@exports tag", function() {
|
||||
});
|
||||
|
||||
describe("inner classes", function() {
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/exportstag4.js'),
|
||||
module = docSet.getByLongname('module:some/module')[0],
|
||||
innerClass = docSet.getByLongname('module:some/module~myClass')[0],
|
||||
method = docSet.getByLongname('module:some/module~myClass#myMethod')[0];
|
||||
var docSet = jasmine.getDocSetFromFile('test/fixtures/exportstag4.js');
|
||||
var module = docSet.getByLongname('module:some/module')[0];
|
||||
var innerClass = docSet.getByLongname('module:some/module~myClass')[0];
|
||||
var method = docSet.getByLongname('module:some/module~myClass#myMethod')[0];
|
||||
|
||||
it('An inner class declared as a function in a module should be documented.', function() {
|
||||
expect(typeof innerClass).toEqual('object');
|
||||
//expect(getstyle.memberof, 'module:html/utils');
|
||||
});
|
||||
|
||||
it('A method of an inner class declared as a function in a module should be documented.', function() {
|
||||
expect(typeof method).toEqual('object');
|
||||
//expect(inhead.memberof, 'module:html/utils');
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user