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

This commit is contained in:
Jeff Williams 2017-07-16 18:38:21 -07:00
parent 9c443c7802
commit 5432a2a6b0
3 changed files with 51 additions and 0 deletions

View File

@ -923,6 +923,10 @@ exports.closureTags = {
}
},
param: cloneTagDef(baseTags.param),
// Closure Compiler only
polymer: {
onTagged: ignore
},
private: {
canHaveType: true,
onTagged: function(doclet, tag) {

5
test/fixtures/polymertag.js vendored Normal file
View File

@ -0,0 +1,5 @@
/**
* A Polymer class.
* @polymer
*/
function Foo() {}

View File

@ -0,0 +1,42 @@
'use strict';
describe('@polymer 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 @polymer tag', function() {
jasmine.getDocSetFromFile('test/fixtures/polymertag.js');
expect(logger.error).toHaveBeenCalled();
});
});
describe('Closure Compiler tags', function() {
beforeEach(function() {
jasmine.replaceTagDictionary('closure');
});
it('should recognize the @polymer tag', function() {
jasmine.getDocSetFromFile('test/fixtures/polymertag.js');
expect(logger.error).not.toHaveBeenCalled();
});
});
});