support the template tag (Closure Compiler only) (#567, #605)

This commit is contained in:
Jeff Williams 2017-07-16 20:05:40 -07:00
parent 7afa146990
commit 25a271e727
3 changed files with 52 additions and 0 deletions

View File

@ -974,6 +974,10 @@ exports.closureTags = {
suppress: {
onTagged: ignore
},
// Closure Compiler only
template: {
onTagged: ignore
},
'this': cloneTagDef(baseTags.this),
throws: cloneTagDef(baseTags.throws),
type: cloneTagDef(baseTags.type, {

6
test/fixtures/templatetag.js vendored Normal file
View File

@ -0,0 +1,6 @@
/**
* @param {T} t
* @constructor
* @template T
*/
function Container(t) {}

View File

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