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

automatically treat const declarations as constants (#555)

Browse Source
This commit is contained in:
Jeff Williams 2015-01-30 07:58:36 -08:00
parent 2e1a209815
commit 62f563d730
4 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
lib/jsdoc/src/handlers.js
View File

@ -281,6 +281,11 @@ function newSymbolDoclet(parser, docletSrc, e) {
newDoclet.scope = SCOPE_NAMES.GLOBAL;
}
// handle cases where the doclet kind is auto-detected from the node type
if (e.code.kind) {
newDoclet.kind = e.code.kind;
}
addDoclet(parser, newDoclet);
e.doclet = newDoclet;
}

4
lib/jsdoc/src/visitor.js
View File

@ -388,6 +388,10 @@ Visitor.prototype.makeSymbolFoundEvent = function(node, parser, filename) {
trackVars(parser, node, e);
basename = parser.getBasename(e.code.name);
// auto-detect constants
if (node.parent.kind === 'const') {
e.code.kind = 'constant';
}
break;

3
test/fixtures/constanttag.js vendored
View File

@ -13,3 +13,6 @@ var mySocket;
/** @const ROCKET */
var myRocket;
/** auto-detected const */
const myPocket = 1;

10
test/specs/documentation/const.js Normal file
View File

@ -0,0 +1,10 @@
'use strict';
describe('const declarations', function() {
it('should automatically set the doclet.kind to "constant" for const declarations', function() {
var docSet = jasmine.getDocSetFromFile('test/fixtures/constanttag.js');
var myPocket = docSet.getByLongname('myPocket')[0];
expect(myPocket.kind).toBe('constant');
});
});