support the record tag (Closure Compiler only) (jsdoc#605)

ammanvedi · Jul 17, 2017 · 7afa146 · 7afa146
1 parent b13bb67
commit 7afa146
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 1 deletion.
diff --git a/lib/jsdoc/tag/dictionary/definitions.js b/lib/jsdoc/tag/dictionary/definitions.js
@@ -889,7 +889,9 @@ exports.closureTags = {
     inheritdoc: cloneTagDef(baseTags.inheritdoc),
     interface: cloneTagDef(baseTags.interface, {
         canHaveName: false,
-        mustNotHaveValue: true
+        mustNotHaveValue: true,
+        // Closure Compiler only
+        synonyms: ['record']
     }),
     lends: cloneTagDef(baseTags.lends),
     license: cloneTagDef(baseTags.license),

diff --git a/test/fixtures/interfacetag3.js b/test/fixtures/interfacetag3.js
@@ -0,0 +1,6 @@
+/**
+ * My structural interface.
+ *
+ * @record
+ */
+function MyStructuralInterface() {}
diff --git a/test/specs/tags/interfacetag.js b/test/specs/tags/interfacetag.js
@@ -51,4 +51,22 @@ describe('@interface tag', function() {
             expect(virtualInterface).not.toBeDefined();
         });
     });
+
+    describe('Closure Compiler tags', function() {
+        afterEach(function() {
+            jasmine.restoreTagDictionary();
+        });
+
+        it('should support @record as a synonym for @interface', function() {
+            var docSet2;
+            var myStructuralInterface;
+
+            jasmine.replaceTagDictionary('closure');
+
+            docSet2 = jasmine.getDocSetFromFile('test/fixtures/interfacetag3.js');
+            myStructuralInterface = docSet2.getByLongname('MyStructuralInterface')[0];
+
+            expect(myStructuralInterface.kind).toBe('interface');
+        });
+    });
 });