support the nocollapse tag (Closure Compiler only) (#605)

This commit is contained in:
Jeff Williams 2017-07-16 18:31:08 -07:00
parent 157255f7f7
commit 21583fe8a1
3 changed files with 54 additions and 0 deletions

View File

@ -898,6 +898,10 @@ exports.closureTags = {
onTagged: ignore
},
// Closure Compiler only
nocollapse: {
onTagged: ignore
},
// Closure Compiler only
override: {
mustNotHaveValue: true,
onTagged: function(doclet) {

8
test/fixtures/nocollapsetag.js vendored Normal file
View File

@ -0,0 +1,8 @@
/**
* A namespace.
* @const
*/
var foo = {};
/** @nocollapse */
foo.bar = true;

View File

@ -0,0 +1,42 @@
'use strict';
describe('@nocollapse tag', function() {
var env = require('jsdoc/env');
var logger = require('jsdoc/util/logger');
var allowUnknownTags = Boolean(env.conf.tags.allowUnknownTags);
beforeEach(function() {
env.conf.tags.allowUnknownTags = false;
spyOn(logger, 'error');
});
afterEach(function() {
jasmine.restoreTagDictionary();
env.conf.tags.allowUnknownTags = allowUnknownTags;
});
describe('JSDoc tags', function() {
beforeEach(function() {
jasmine.replaceTagDictionary('jsdoc');
});
it('should not recognize the @nocollapse tag', function() {
jasmine.getDocSetFromFile('test/fixtures/nocollapsetag.js');
expect(logger.error).toHaveBeenCalled();
});
});
describe('Closure Compiler tags', function() {
beforeEach(function() {
jasmine.replaceTagDictionary('closure');
});
it('should recognize the @nocollapse tag', function() {
jasmine.getDocSetFromFile('test/fixtures/nocollapsetag.js');
expect(logger.error).not.toHaveBeenCalled();
});
});
});