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

make the exports tag work correctly when combined with the enum tag (#970)

Browse Source
This commit is contained in:
Jeff Williams 2017-07-22 20:29:56 -07:00
parent 599a376cb5
commit 1c99ec39eb
3 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lib/jsdoc/tag/dictionary/definitions.js
View File

@ -415,7 +415,7 @@ var baseTags = exports.baseTags = {
enum: {
canHaveType: true,
onTagged: function(doclet, tag) {
doclet.kind = 'member';
doclet.kind = doclet.kind || 'member';
doclet.isEnum = true;
setDocletTypeToValueType(doclet, tag);
}

11
test/fixtures/enumtag3.js vendored Normal file
View File

@ -0,0 +1,11 @@
define(function () {
/**
* @exports mymodule
* @enum {string}
*/
var exports = {
A: 'abc'
};
return exports;
});

9
test/specs/tags/enumtag.js
View File

@ -59,4 +59,13 @@ describe('@enum tag', function() {
expect(pentaState.properties.length).toBe(5);
});
});
describe('combined with @exports tag', function() {
var docSet3 = jasmine.getDocSetFromFile('test/fixtures/enumtag3.js');
var mymodule = docSet3.getByLongname('module:mymodule')[0];
it('When a symbol has both an @exports tag and an @enum tag, its kind is set to `module`', function() {
expect(mymodule.kind).toBe('module');
});
});
});