Add support for @returns annotation

kegsay · Jan 21, 2017 · 68470ff · 68470ff
1 parent ab7ec9c
commit 68470ff
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 1 deletion.
diff --git a/index.js b/index.js
@@ -31,7 +31,7 @@ function extractJsdoc(comment) {
     }).map(jsdocTagToFlowTag);
 
     var returnTags = docAst.tags.filter(function(tag) {
-        return tag.title === "return";
+        return tag.title === "return" || tag.title === "returns";
     }).map(jsdocTagToFlowTag);
 
     var propTags = docAst.tags.filter(function(tag) {

diff --git a/tests/expected_output/03-stand-alone-function.js b/tests/expected_output/03-stand-alone-function.js
@@ -5,4 +5,11 @@
  */
 function foo(bar: Array<Foobar>, baz: Function) : number {
     return 42;
+}
+
+/**
+ * @returns {number}
+ */
+function bar() : number {
+    return 42;
 }
diff --git a/tests/input/03-stand-alone-function.js b/tests/input/03-stand-alone-function.js
@@ -5,4 +5,11 @@
  */
 function foo(bar, baz) {
     return 42;
+}
+
+/**
+ * @returns {number}
+ */
+function bar() {
+    return 42;
 }