Merge pull request #56 from Adamant-im/eslint-jsdoc

Eslint jsdoc
Adamant-im · Oct 10, 2022 · 9494d6d · 9494d6d
2 parents cdea8af + c92b327
commit 9494d6d
Show file tree

Hide file tree

Showing 21 changed files with 58 additions and 349 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -43,7 +43,59 @@
       "named": "always",
       "asyncArrow": "ignore"
     }],
-    "space-infix-ops": ["error", { "int32Hint": true }]
+    "space-infix-ops": ["error", { "int32Hint": true }],
+    "jsdoc/check-access": 1,
+    "jsdoc/check-alignment": 1,
+    "jsdoc/check-line-alignment": 1,
+    "jsdoc/check-param-names": 1,
+    "jsdoc/check-property-names": 1,
+    "jsdoc/check-tag-names": 1,
+    "jsdoc/check-types": 1,
+    "jsdoc/check-values": 1,
+    "jsdoc/empty-tags": 1,
+    "jsdoc/multiline-blocks": 1,
+    "jsdoc/newline-after-description": 1,
+    "jsdoc/no-multi-asterisks": 1,
+    "jsdoc/require-param": 1,
+    "jsdoc/require-param-name": 1,
+    "jsdoc/require-param-type": 1,
+    "jsdoc/require-property": 1,
+    "jsdoc/require-property-name": 1,
+    "jsdoc/require-property-type": 1,
+    "jsdoc/require-returns-type": 1,
+    "jsdoc/require-yields": 1,
+    "jsdoc/require-yields-check": 1,
+    "jsdoc/tag-lines": 1,
+    "jsdoc/valid-types": 1,
+    "jsdoc/sort-tags": [
+      "warn",
+      {
+        "tagSequence": [
+          "global",
+          "typedef",
+          "var",
+          "name",
+          "namespace",
+          "constructor",
+          "callback",
+          "event",
+          "function",
+          "augments",
+          "lends",
+          "type",
+          "prop",
+          "param",
+          "throws",
+          "fires",
+          "listens",
+          "ingroup",
+          "deprecated",
+          "see",
+          "todo",
+          "ignore"
+        ]
+      }
+    ]
   },
   "globals": {
     "PR": true,
@@ -54,5 +106,7 @@
     "after": true,
     "afterEach": true
   },
-  "plugins": []
+  "plugins": [
+    "jsdoc"
+  ]
 }
diff --git a/docs/adm-nodes.jpeg b/docs/adm-nodes.jpeg
diff --git a/docs/conf.json b/docs/conf.json
diff --git a/docs/intro.md b/docs/intro.md
diff --git a/docs/typedef/components.js b/docs/typedef/components.js
diff --git a/docs/typedef/crypto.js b/docs/typedef/crypto.js
diff --git a/docs/typedef/modules/accounts.js b/docs/typedef/modules/accounts.js
diff --git a/docs/typedef/modules/blocks.js b/docs/typedef/modules/blocks.js
diff --git a/docs/typedef/modules/dapps.js b/docs/typedef/modules/dapps.js
diff --git a/docs/typedef/modules/delegates.js b/docs/typedef/modules/delegates.js
diff --git a/docs/typedef/modules/helpers.js b/docs/typedef/modules/helpers.js
diff --git a/docs/typedef/modules/loader.js b/docs/typedef/modules/loader.js
diff --git a/docs/typedef/modules/multisignatures.js b/docs/typedef/modules/multisignatures.js
diff --git a/docs/typedef/modules/peers.js b/docs/typedef/modules/peers.js