fix: Allow lines between apiDoc tags (#38)

* fix: Allow blank lines between apiDoc tags * Fix jsdoc/check-types warnings
comicrelief · Aug 11, 2022 · 2f8d8e8 · 2f8d8e8
1 parent c3040f6
commit 2f8d8e8
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/mixins/apiDoc.js b/mixins/apiDoc.js
@@ -31,5 +31,7 @@ module.exports = {
         ],
       },
     ],
+    // Allow blank lines between tags
+    "jsdoc/tag-lines": "off",
   },
 };
diff --git a/tests/apidoc/index.js b/tests/apidoc/index.js
@@ -5,10 +5,10 @@
  * @apiName GetUser
  * @apiGroup User
  *
- * @apiParam {Number} id Users unique ID.
+ * @apiParam {number} id Users unique ID.
  *
- * @apiSuccess {String} firstname Firstname of the User.
- * @apiSuccess {String} lastname  Lastname of the User.
+ * @apiSuccess {string} firstname Firstname of the User.
+ * @apiSuccess {string} lastname  Lastname of the User.
  *
  * @apiSuccessExample Success-Response:
  *     HTTP/1.1 200 OK
-Original file line number
+Diff line change
@@ Expand Up / @@ -31,5 +31,7 @@ module.exports = { @@
             ],
           },
         ],
+        // Allow blank lines between tags
+        "jsdoc/tag-lines": "off",
       },
     };