checkReturnTypes: add 'class' as valid custom object

Alexej Yaroshevich · Alexej Yaroshevich · commit e794e86a3133 · 2014-11-09T04:24:18.000+04:00
Fixes #32
diff --git a/lib/jsdoc.js b/lib/jsdoc.js
@@ -255,7 +255,7 @@ function jsDocMatchType (variants, argument) {
             }
 
         } else if (argument.type === 'ObjectExpression') {
-            result = result || (type === 'object');
+            result = result || (type === 'object' || type === 'class');
 
         } else if (argument.type === 'ArrayExpression') {
             result = result || (type === 'array');
diff --git a/test/lib/rules/validate-jsdoc/check-return-types.js b/test/lib/rules/validate-jsdoc/check-return-types.js
@@ -245,6 +245,17 @@ describe('rules/validate-jsdoc', function () {
                         }
                     };
                 }
+            }, {
+                it: 'should not report on `@returns {Class}` for {}. issue #32',
+                code: function () {
+                    /**
+                     * @return {Class}
+                     */
+                    Users.prototype.getState = function()
+                    {
+                        return {};
+                    };
+                }
             }
             /* jshint ignore:end */
         ]);

Original file line number	Diff line number	Diff line change
`@@ -255,7 +255,7 @@ function jsDocMatchType (variants, argument) {`
`255`	`255`	`}`
`256`	`256`
`257`	`257`	`} else if (argument.type === 'ObjectExpression') {`
`258`		`- result = result \|\| (type === 'object');`
	`258`	`+ result = result \|\| (type === 'object' \|\| type === 'class');`
`259`	`259`
`260`	`260`	`} else if (argument.type === 'ArrayExpression') {`
`261`	`261`	`result = result \|\| (type === 'array');`
Original file line number	Diff line number	Diff line change
`@@ -245,6 +245,17 @@ describe('rules/validate-jsdoc', function () {`
`245`	`245`	`}`
`246`	`246`	`};`
`247`	`247`	`}`
	`248`	`+ }, {`
	`249`	+ it: 'should not report on `@returns {Class}` for {}. issue #32',
	`250`	`+ code: function () {`
	`251`	`+ /**`
	`252`	`+ * @return {Class}`
	`253`	`+ */`
	`254`	`+ Users.prototype.getState = function()`
	`255`	`+ {`
	`256`	`+ return {};`
	`257`	`+ };`
	`258`	`+ }`
`248`	`259`	`}`
`249`	`260`	`/* jshint ignore:end */`
`250`	`261`	`]);`