docs: generate docs (fixes #74)

gajus · May 17, 2018 · 83ff68f · 83ff68f
1 parent 6413e7d
commit 83ff68f
Show file tree

Hide file tree

Showing 2 changed files with 322 additions and 16 deletions.
diff --git a/.README/README.md b/.README/README.md
@@ -124,6 +124,21 @@ Use `settings.jsdoc.additionalTagNames` to configure additional, allowed JSDoc t
 }
 ```
 
+### Allow `@override` Without Accompanying `@param` Tags
+
+Use `settings.jsdoc.allowOverrideWithoutParam` to indicate whether the `@override` tag can be used without accompanying `@param` tag(s). The default value is `false`. The format of the configuration is as follows:
+
+```json
+{
+    "rules": {},
+    "settings": {
+        "jsdoc": {
+            "allowOverrideWithoutParam": true
+        }
+    }
+}
+```
+
 ## Rules
 
 {"gitdown": "include", "file": "./rules/check-param-names.md"}