From e810cb7d0fdcbe40c238a8698e0efba47775fafc Mon Sep 17 00:00:00 2001 From: Jeff Williams Date: Sun, 16 Jul 2017 18:41:44 -0700 Subject: [PATCH] support the `polymerBehavior` tag (Closure Compiler only) (#605) --- lib/jsdoc/tag/dictionary/definitions.js | 4 +++ test/fixtures/polymerbehaviortag.js | 2 ++ test/specs/tags/polymerbehaviortag.js | 42 +++++++++++++++++++++++++ 3 files changed, 48 insertions(+) create mode 100644 test/fixtures/polymerbehaviortag.js create mode 100644 test/specs/tags/polymerbehaviortag.js diff --git a/lib/jsdoc/tag/dictionary/definitions.js b/lib/jsdoc/tag/dictionary/definitions.js index a062870a..5e357ab7 100644 --- a/lib/jsdoc/tag/dictionary/definitions.js +++ b/lib/jsdoc/tag/dictionary/definitions.js @@ -927,6 +927,10 @@ exports.closureTags = { polymer: { onTagged: ignore }, + // Closure Compiler only + polymerBehavior: { + onTagged: ignore + }, private: { canHaveType: true, onTagged: function(doclet, tag) { diff --git a/test/fixtures/polymerbehaviortag.js b/test/fixtures/polymerbehaviortag.js new file mode 100644 index 00000000..37580e32 --- /dev/null +++ b/test/fixtures/polymerbehaviortag.js @@ -0,0 +1,2 @@ +/** @polymerBehavior */ +var MyPolymerBehavior = {}; diff --git a/test/specs/tags/polymerbehaviortag.js b/test/specs/tags/polymerbehaviortag.js new file mode 100644 index 00000000..284fff95 --- /dev/null +++ b/test/specs/tags/polymerbehaviortag.js @@ -0,0 +1,42 @@ +'use strict'; + +describe('@polymerBehavior 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 @polymerBehavior tag', function() { + jasmine.getDocSetFromFile('test/fixtures/polymerbehaviortag.js'); + + expect(logger.error).toHaveBeenCalled(); + }); + }); + + describe('Closure Compiler tags', function() { + beforeEach(function() { + jasmine.replaceTagDictionary('closure'); + }); + + it('should recognize the @polymerBehavior tag', function() { + jasmine.getDocSetFromFile('test/fixtures/polymerbehaviortag.js'); + + expect(logger.error).not.toHaveBeenCalled(); + }); + }); +});