Merge branch 'master' into add-more-type-checks-to-valid-types

* master:
  refactor: fix code comment
  docs(require-description, require-example, require-param, require-returns): add reference to potentially applicable settings, removing reference to deprecated items
  docs: make explicit default for setting `ignorePrivate` and clarify setting

Author: brettz9

.README/README.md

@@ -121,7 +121,7 @@ You can then selectively add to or override the recommended rules.
 ### Allow `@private` to disable rules for that comment block
 
 - `settings.jsdoc.ignorePrivate` - Disables all rules for the comment block
-  on which it occurs.
+  on which a `@private` tag occurs. Defaults to `false`.
 
 ### Alias Preference
 

.README/rules/require-description.md

@@ -21,5 +21,6 @@ An options object may have any of the following properties:
 |Tags|`description`|
 |Aliases|`desc`|
 |Options|`contexts`, `exemptedBy`|
+|Settings|`overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`|
 
 <!-- assertions requireDescription -->

.README/rules/require-example.md

@@ -21,5 +21,6 @@ This rule has an object option:
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
 |Tags|`example`|
 |Options|`exemptedBy`, `avoidExampleOnConstructors`|
+|Settings|`overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`|
 
 <!-- assertions requireExample -->

.README/rules/require-param.md

@@ -15,6 +15,6 @@ An options object accepts one optional property:
 |Tags|`param`|
 |Aliases|`arg`, `argument`|
 |Options|`exemptedBy`|
-|Settings|`allowOverrideWithoutParam`, `allowImplementsWithoutParam`, `allowAugmentsExtendsWithoutParam`|
+|Settings|`overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`|
 
 <!-- assertions requireParam -->

.README/rules/require-returns.md

@@ -22,5 +22,6 @@ Requires returns are documented.
 |Tags|`returns`|
 |Aliases|`return`|
 |Options|`exemptedBy`, `forceRequireReturn`, `forceReturnsWithAsync`|
+|Settings|`overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`|
 
 <!-- assertions requireReturns -->

README.md

@@ -164,7 +164,7 @@ You can then selectively add to or override the recommended rules.
 ### Allow <code>@private</code> to disable rules for that comment block
 
 - `settings.jsdoc.ignorePrivate` - Disables all rules for the comment block
-  on which it occurs.
+  on which a `@private` tag occurs. Defaults to `false`.
 
 <a name="eslint-plugin-jsdoc-settings-alias-preference"></a>
 ### Alias Preference
@@ -3721,6 +3721,7 @@ An options object may have any of the following properties:
 |Tags|`description`|
 |Aliases|`desc`|
 |Options|`contexts`, `exemptedBy`|
+|Settings|`overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`|
 
 The following patterns are considered problems:
 
@@ -3915,6 +3916,7 @@ This rule has an object option:
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
 |Tags|`example`|
 |Options|`exemptedBy`, `avoidExampleOnConstructors`|
+|Settings|`overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`|
 
 The following patterns are considered problems:
 
@@ -5204,7 +5206,7 @@ An options object accepts one optional property:
 |Tags|`param`|
 |Aliases|`arg`, `argument`|
 |Options|`exemptedBy`|
-|Settings|`allowOverrideWithoutParam`, `allowImplementsWithoutParam`, `allowAugmentsExtendsWithoutParam`|
+|Settings|`overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`|
 
 The following patterns are considered problems:
 
@@ -6138,6 +6140,7 @@ Requires returns are documented.
 |Tags|`returns`|
 |Aliases|`return`|
 |Options|`exemptedBy`, `forceRequireReturn`, `forceReturnsWithAsync`|
+|Settings|`overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`|
 
 The following patterns are considered problems:
 

src/iterateJsdoc.js

@@ -267,7 +267,7 @@ const getSettings = (context) => {
   // All rules
   settings.ignorePrivate = Boolean(_.get(context, 'settings.jsdoc.ignorePrivate'));
 
-  // `check-tag-names` and many require/param rules
+  // `check-tag-names` and many returns/param rules
   settings.tagNamePreference = _.get(context, 'settings.jsdoc.tagNamePreference') || {};
 
   // `check-types` and `no-undefined-types`