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

recognize Closure Compiler-style typedefs (#391)

Browse Source
This commit is contained in:
Jeff Williams 2013-04-16 03:21:30 -07:00
parent bca6cdc5b1
commit 32b2ea5a1d
3 changed files with 42 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
lib/jsdoc/src/parser.js
View File

@ -257,6 +257,11 @@ function aboutNode(node) {
about.node.type = tkn.NAMEDFUNCTIONSTATEMENT;
}
}
else if (node.type === Token.GETPROP) {
about.node = node;
about.name = nodeToString(about.node);
about.type = getTypeName(node);
}
else {
// type 39 (NAME)
var string = nodeToString(node);
@ -441,6 +446,16 @@ exports.Parser.prototype._visitNode = function(comments, node) {
};
e = this._makeEvent(node, comments, extras);
}
else if (node.type === Token.GETPROP) { // like 'obj.prop' in '/** @typedef {string} */ obj.prop;'
// this COULD be a Closure Compiler-style typedef, but it's probably not; to avoid filling
// the parse tree with junk, only fire an event if there's a JSDoc comment attached
extras = {
lineno: node.getLineno()
};
if ( node.getJsDoc() ) {
e = this._makeEvent(node, comments, extras);
}
}
else if (node.type == Token.VAR || node.type == Token.LET || node.type == Token.CONST) {
if (node.variables) {

8
test/fixtures/typedeftag.js vendored
View File

@ -1,5 +1,11 @@
/** @typedef {(string|number)} calc.NumberLike */
/** @typedef {string} */
calc.Operator;
/** @typedef {calc.NumberLike} calc.Result */
calc.Outcome;
/** @param {calc.NumberLike} x A number or a string. */
calc.readNumber = function(x) {
}
};

27
test/specs/tags/typedeftag.js
View File

@ -1,12 +1,15 @@
describe("@typedef tag", function() {
var docSet = jasmine.getDocSetFromFile('test/fixtures/typedeftag.js'),
numberlike = docSet.getByLongname('calc.NumberLike')[0];
/*global describe: true, expect: true, it: true, jasmine: true */
describe('@typedef tag', function() {
var docSet = jasmine.getDocSetFromFile('test/fixtures/typedeftag.js');
var numberlike = docSet.getByLongname('calc.NumberLike')[0];
var operator = docSet.getByLongname('calc.Operator')[0];
var result = docSet.getByLongname('calc.Result')[0];
it('When a symbol has an @typedef tag, the doclet has a kind property set to "typedef".', function() {
it('When a comment has a @typedef tag, the doclet has a kind property set to "typedef".', function() {
expect(numberlike.kind).toBe('typedef');
});
it('When a symbol has an @typedef tag with a type, the doclet has a type property set to that type.', function() {
it('When a comment has a @typedef tag with a type, the doclet has a type property set to that type.', function() {
expect(typeof numberlike.type).toBe('object');
expect(typeof numberlike.type.names).toBe('object');
expect(numberlike.type.names.length).toBe(2);
@ -14,8 +17,18 @@ describe("@typedef tag", function() {
expect(numberlike.type.names[1]).toBe('number');
});
it('When a symbol has an @typedef tag with a name, the doclet has a name property set to that name.', function() {
it('When a comment has a @typedef tag with a name, the doclet has a name property set to that name.', function() {
expect(numberlike.name).toBe('NumberLike');
expect(numberlike.longname).toBe('calc.NumberLike');
});
});
it('When a symbol has a @typedef tag without a name, the doclet has a name property set to the symbol name.', function() {
expect(operator.name).toBe('Operator');
expect(operator.longname).toBe('calc.Operator');
});
it('When a symbol has a @typedef tag with a name, the name in the tag takes precedence over the symbol name.', function() {
expect(result.name).toBe('Result');
expect(result.longname).toBe('calc.Result');
});
});