Remove unnecessary @returns

Author: jfirebaugh

test/lib/infer/kind.js

@@ -24,24 +24,24 @@ test('inferKind', function (t) {
     });
 
   t.equal(inferKind(toComment(function () {
-    /** @returns {number} two */
+    /** function */
     function foo() { }
     foo();
   })).kind, 'function', 'inferred function');
 
   t.equal(inferKind(toComment(function () {
-    /** @returns {number} two */
+    /** function */
     var foo = function () { };
     foo();
   })).kind, 'function', 'inferred var function');
 
   t.equal(inferKind(toComment(function () {
-    /** @returns {number} two */
+    /** class */
     function Foo() { }
   })).kind, 'class', 'class via uppercase');
 
   t.equal(inferKind(toComment(function () {
-    /** @returns {number} two */
+    /** undefined */
   })).kind, undefined, 'undetectable');
 
   t.equal(inferKind(toComment(

test/lib/infer/membership.js

@@ -85,7 +85,6 @@ test('inferMembership - explicit', function (t) {
     Foo.prototype = {
       /**
        * Test
-       * @returns {undefined} bar
        */
       bar: function () {}
     };
@@ -107,8 +106,7 @@ test('inferMembership - explicit', function (t) {
 
   t.deepEqual(_.pick(evaluate(function () {
     var Foo = {
-      /** Test
-      * @returns {undefined} bar */
+      /** Test */
       baz: function () {}
     };
     return Foo;
@@ -118,8 +116,7 @@ test('inferMembership - explicit', function (t) {
   }, 'variable object assignment, function');
 
   t.deepEqual(_.pick(evaluate(function () {
-    /** Test
-    * @returns {undefined} bar */
+    /** Test */
     module.exports = function () {};
   })[0], ['memberof', 'scope']), {
     memberof: 'module',
@@ -138,10 +135,7 @@ test('inferMembership - explicit', function (t) {
 
   t.deepEqual(_.pick(evaluate(function () {
     lend(/** @lends Foo */{
-      /**
-       * Test
-       * @returns {undefined} nothing
-       */
+      /** Test */
       bar: function () {}
     });
   })[1], ['memberof', 'scope']), {
@@ -161,10 +155,7 @@ test('inferMembership - explicit', function (t) {
 
   t.deepEqual(_.pick(evaluate(function () {
     lend(/** @lends Foo.prototype */{
-      /**
-       * Test
-       * @returns {number} nothing
-       */
+      /** Test */
       bar: function () {}
     });
   })[1], ['memberof', 'scope']), {
@@ -193,7 +184,7 @@ test('inferMembership - exports', function (t) {
 
   t.equal(evaluate(function () {
     /** @module mod */
-    /** @returns {undefined} foo */
+    /** foo */
     exports.foo = function () {};
   })[1].memberof, 'mod');
 
@@ -214,21 +205,21 @@ test('inferMembership - exports', function (t) {
   t.equal(evaluate(function () {
     /** @module mod */
     exports.foo = {
-      /** @returns {undefined} bar */
+      /** bar */
       bar: function () {}
     };
   })[1].memberof, 'mod.foo');
 
   t.equal(evaluate(function () {
     /** @module mod */
-    /** @returns {undefined} bar */
+    /** bar */
     exports.foo.prototype.bar = function () {};
   })[1].memberof, 'mod.foo');
 
   t.equal(evaluate(function () {
     /** @module mod */
     exports.foo.prototype = {
-      /** @returns {undefined} bar */
+      /** bar */
       bar: function () {}
     };
   })[1].memberof, 'mod.foo');
@@ -245,7 +236,7 @@ test('inferMembership - module.exports', function (t) {
 
   t.equal(evaluate(function () {
     /** @module mod */
-    /** @returns {undefined} foo */
+    /** foo */
     module.exports.foo = function () {};
   })[1].memberof, 'mod');
 
@@ -266,21 +257,21 @@ test('inferMembership - module.exports', function (t) {
   t.equal(evaluate(function () {
     /** @module mod */
     module.exports.foo = {
-      /** @returns {undefined} bar */
+      /** bar */
       bar: function () {}
     };
   })[1].memberof, 'mod.foo');
 
   t.equal(evaluate(function () {
     /** @module mod */
-    /** @returns {undefined} bar */
+    /** bar */
     module.exports.prototype.bar = function () {};
   })[1].memberof, 'mod');
 
   t.equal(evaluate(function () {
     /** @module mod */
     module.exports.prototype = {
-      /** @returns {undefined} bar */
+      /** bar */
       bar: function () {}
     };
   })[1].memberof, 'mod');
@@ -297,7 +288,6 @@ test('inferMembership - module.exports', function (t) {
     /**
      * @module mod
      * @name exports
-     * @returns {undefined} bar
      */
     module.exports = function () {};
   })[0].memberof, undefined);

test/lib/infer/name.js

@@ -30,10 +30,7 @@ test('inferName', function (t) {
     //   AssignmentExpression
     //     MemberExpression (comment attached here)
     //     FunctionExpression
-    /**
-     * Test
-     * @returns {undefined} bar
-     */
+    /** Test */
     exports.name = function () {};
   }).name, 'name', 'expression statement, function');
 
@@ -52,37 +49,25 @@ test('inferName', function (t) {
       // Property
       //   Identifier (comment attached here)
       //   FunctionExpression
-      /**
-       * Test
-       * @returns {undefined} bar
-       */
+      /** Test */
       name: function () {}
     };
   }).name, 'name', 'property, function');
 
   t.equal(evaluate(function () {
-    /**
-     * Test
-     * @returns {undefined} bar
-     */
+    /** Test */
     function name() {}
     return name;
   }).name, 'name', 'function declaration');
 
   t.equal(evaluate(function () {
-    /**
-     * Test
-     * @returns {undefined} bar
-     */
+    /** Test */
     var name = function () {};
     return name;
   }).name, 'name', 'anonymous function expression');
 
   t.equal(evaluate(function () {
-    /**
-     * Test
-     * @returns {undefined} bar
-     */
+    /** Test */
     var name = function name2() {};
     return name;
   }).name, 'name', 'named function expression');
@@ -91,7 +76,6 @@ test('inferName', function (t) {
     /**
      * Test
      * @name explicitName
-     * @returns {undefined} bar
      */
     function implicitName() {}
     return implicitName;
@@ -112,7 +96,6 @@ test('inferName', function (t) {
   t.equal(evaluate(function () {
     /**
      * @event explicitEvent
-     * @returns {undefined} bar
      */
     function implicitName() {}
     return implicitName;
@@ -121,7 +104,6 @@ test('inferName', function (t) {
   t.equal(evaluate(function () {
     /**
      * @typedef {Object} ExplicitTypedef
-     * @returns {undefined} bar
      */
     function implicitName() {}
     return implicitName;
@@ -130,7 +112,6 @@ test('inferName', function (t) {
   t.equal(evaluate(function () {
     /**
      * @callback explicitCallback
-     * @returns {undefined} baz
      */
     function implicitName() {}
     return implicitName;
@@ -139,7 +120,6 @@ test('inferName', function (t) {
   t.equal(evaluate(function () {
     /**
      * @module explicitModule
-     * @returns {undefined} baz
      */
     function implicitName() {}
     return implicitName;
@@ -148,7 +128,6 @@ test('inferName', function (t) {
   t.equal(evaluate(function () {
     /**
      * @module {Function} explicitModule
-     * @returns {undefined} baz
      */
     function implicitName() {}
     return implicitName;
@@ -157,7 +136,6 @@ test('inferName', function (t) {
   t.equal(evaluate(function () {
     /**
      * @module
-     * @returns {undefined} baz
      */
     function implicitName() {}
     return implicitName;