[Restore] README.md

Author: ptkdev

README.md

@@ -33,7 +33,6 @@ JSDoc linting rules for ESLint.
         * [`require-param`](#eslint-plugin-jsdoc-rules-require-param)
         * [`require-returns-description`](#eslint-plugin-jsdoc-rules-require-returns-description)
         * [`require-returns-type`](#eslint-plugin-jsdoc-rules-require-returns-type)
-        * [`require-returns-check`](#eslint-plugin-jsdoc-rules-require-returns-check)
         * [`require-returns`](#eslint-plugin-jsdoc-rules-require-returns)
         * [`valid-types`](#eslint-plugin-jsdoc-rules-valid-types)
 
@@ -59,7 +58,6 @@ This table maps the rules between `eslint-plugin-jsdoc` and `jscs-jsdoc`.
 | [`require-param-name`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param-name) | N/A |
 | [`require-param-type`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param-type) | [`requireParamTypes`](https://github.com/jscs-dev/jscs-jsdoc#requireparamtypes) |
 | [`require-returns`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns) | [`requireReturn`](https://github.com/jscs-dev/jscs-jsdoc#requirereturn) |
-| [`require-returns-check`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns-check) | [`requireReturn`](https://github.com/jscs-dev/jscs-jsdoc#requirereturncheck) |
 | [`require-returns-description`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns-description) | [`requireReturnDescription`](https://github.com/jscs-dev/jscs-jsdoc#requirereturndescription) |
 | [`require-returns-type`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns-type) | [`requireReturnTypes`](https://github.com/jscs-dev/jscs-jsdoc#requirereturntypes) |
 | [`valid-types`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-valid-types) | N/A |
@@ -119,7 +117,6 @@ Finally, enable all of the rules that you would like to use.
         "jsdoc/require-param-name": 1,
         "jsdoc/require-param-type": 1,
         "jsdoc/require-returns": 1,
-        "jsdoc/require-returns-check": 1,
         "jsdoc/require-returns-description": 1,
         "jsdoc/require-returns-type": 1,
         "jsdoc/valid-types": 1
@@ -379,7 +376,7 @@ function quux () {
 
 }
 // Settings: {"jsdoc":{"baseConfig":{"rules":{"no-undef":["error"]}},"eslintrcForExamples":false,"noDefaultExampleRules":true}}
-// Message: @example error (no-undef): 'quux' is not defined.
+// Message: @example error (semi): Extra semicolon.
 
 /**
  * @example <caption>Valid usage</caption>
@@ -2200,10 +2197,10 @@ function quux () {
 ````
 
 
-<a name="eslint-plugin-jsdoc-rules-require-returns-check"></a>
-### <code>require-returns-check</code>
+<a name="eslint-plugin-jsdoc-rules-require-returns"></a>
+### <code>require-returns</code>
 
-Check if exist return expression in function and in comment. Need exist both.
+Requires returns are documented.
 
 |||
 |---|---|
@@ -2214,106 +2211,302 @@ The following patterns are considered problems:
 
 ````js
 /**
- * @returns
+ *
  */
 function quux (foo) {
 
 }
-// Message: Present JSDoc @returns declaration but not available return expression in function.
+// Message: Missing JSDoc @param "foo" declaration.
 
 /**
- * @return
+ *
  */
 function quux (foo) {
 
 }
-// Settings: {"jsdoc":{"tagNamePreference":{"returns":"return"}}}
-// Message: Present JSDoc @return declaration but not available return expression in function.
+// Settings: {"jsdoc":{"tagNamePreference":{"param":"arg"}}}
+// Message: Missing JSDoc @arg "foo" declaration.
+
+/**
+ * @param foo
+ */
+function quux (foo, bar) {
+
+}
+// Message: Missing JSDoc @param "bar" declaration.
+
+/**
+ * @override
+ */
+function quux (foo) {
+
+}
+// Message: Missing JSDoc @param "foo" declaration.
+
+/**
+ * @implements
+ */
+function quux (foo) {
+
+}
+// Message: Missing JSDoc @param "foo" declaration.
+
+/**
+ * @augments
+ */
+function quux (foo) {
+
+}
+// Message: Missing JSDoc @param "foo" declaration.
+
+/**
+ * @extends
+ */
+function quux (foo) {
+
+}
+// Message: Missing JSDoc @param "foo" declaration.
+
+/**
+ * @override
+ */
+class A {
+  /**
+    *
+    */
+  quux (foo) {
+
+  }
+}
+// Message: Missing JSDoc @param "foo" declaration.
+
+/**
+ * @implements
+ */
+class A {
+  /**
+   *
+   */
+  quux (foo) {
+
+  }
+}
+// Message: Missing JSDoc @param "foo" declaration.
+
+/**
+ * @augments
+ */
+class A {
+  /**
+   *
+   */
+  quux (foo) {
+
+  }
+}
+// Message: Missing JSDoc @param "foo" declaration.
+
+/**
+ * @extends
+ */
+class A {
+  /**
+   *
+   */
+  quux (foo) {
+
+  }
+}
+// Message: Missing JSDoc @param "foo" declaration.
 ````
 
 The following patterns are not considered problems:
 
 ````js
 /**
- * @returns Foo.
+ * @param foo
  */
-function quux () {
+function quux (foo) {
 
-  return foo;
 }
 
 /**
- * @returns {void} Foo.
+ * @inheritdoc
  */
-function quux () {
+function quux (foo) {
 
-  return foo;
 }
 
 /**
- * @returns {undefined} Foo.
+ * @arg foo
  */
-function quux () {
+function quux (foo) {
 
-  return foo;
 }
+// Settings: {"jsdoc":{"tagNamePreference":{"param":"arg"}}}
 
 /**
- *
+ * @override
+ * @param foo
  */
-function quux () {
+function quux (foo) {
+
 }
-````
 
+/**
+ * @override
+ */
+function quux (foo) {
 
-<a name="eslint-plugin-jsdoc-rules-require-returns"></a>
-### <code>require-returns</code>
+}
+// Settings: {"jsdoc":{"allowOverrideWithoutParam":true}}
 
-Requires returns are documented.
+/**
+ * @implements
+ */
+function quux (foo) {
 
-|||
-|---|---|
-|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
-|Tags|`returns`|
+}
+// Settings: {"jsdoc":{"allowImplementsWithoutParam":true}}
 
-The following patterns are considered problems:
+/**
+ * @implements
+ * @param foo
+ */
+function quux (foo) {
+
+}
 
-````js
 /**
- *
+ * @augments
  */
 function quux (foo) {
 
-  return foo;
 }
-// Message: Missing JSDoc @returns declaration.
+// Settings: {"jsdoc":{"allowAugmentsExtendsWithoutParam":true}}
 
 /**
- *
+ * @augments
+ * @param foo
  */
 function quux (foo) {
 
-  return foo;
 }
-// Settings: {"jsdoc":{"tagNamePreference":{"returns":"return"}}}
-// Message: Missing JSDoc @return declaration.
-````
 
-The following patterns are not considered problems:
+/**
+ * @extends
+ */
+function quux (foo) {
+
+}
+// Settings: {"jsdoc":{"allowAugmentsExtendsWithoutParam":true}}
 
-````js
 /**
- * @returns Foo.
+ * @extends
+ * @param foo
  */
-function quux () {
+function quux (foo) {
 
-  return foo;
 }
 
 /**
- *
+ * @override
  */
-function quux () {
+class A {
+  /**
+  * @param foo
+  */
+  quux (foo) {
+
+  }
+}
+
+/**
+ * @override
+ */
+class A {
+  /**
+   *
+   */
+  quux (foo) {
+
+  }
+}
+// Settings: {"jsdoc":{"allowOverrideWithoutParam":true}}
+
+/**
+ * @implements
+ */
+class A {
+  /**
+   *
+   */
+  quux (foo) {
+
+  }
+}
+// Settings: {"jsdoc":{"allowImplementsWithoutParam":true}}
+
+/**
+ * @implements
+ */
+class A {
+  /**
+   * @param foo
+   */
+  quux (foo) {
+
+  }
+}
+
+/**
+ * @augments
+ */
+class A {
+  /**
+   *
+   */
+  quux (foo) {
+
+  }
+}
+// Settings: {"jsdoc":{"allowAugmentsExtendsWithoutParam":true}}
+
+/**
+ * @augments
+ */
+class A {
+  /**
+   * @param foo
+   */
+  quux (foo) {
+
+  }
+}
+
+/**
+ * @extends
+ */
+class A {
+  /**
+   *
+   */
+  quux (foo) {
+
+  }
+}
+// Settings: {"jsdoc":{"allowAugmentsExtendsWithoutParam":true}}
+
+/**
+ * @extends
+ */
+class A {
+  /**
+   * @param foo
+   */
+  quux (foo) {
+
+  }
 }
 ````
 
@@ -2365,4 +2558,3 @@ function quux() {
 }
 ````
 
-