eslint-plugin-jsdoc 44.2.3 → 44.2.5

package/docs/rules/require-description.md

@@ -1,820 +1,584 @@
-<a name="user-content-require-description-complete-sentence"></a>
-<a name="require-description-complete-sentence"></a>
-# <code>require-description-complete-sentence</code>
-
-* [Fixer](#user-content-require-description-complete-sentence-fixer)
-* [Options](#user-content-require-description-complete-sentence-options)
-    * [`tags`](#user-content-require-description-complete-sentence-options-tags)
-    * [`abbreviations`](#user-content-require-description-complete-sentence-options-abbreviations)
-    * [`newlineBeforeCapsAssumesBadSentenceEnd`](#user-content-require-description-complete-sentence-options-newlinebeforecapsassumesbadsentenceend)
-* [Context and settings](#user-content-require-description-complete-sentence-context-and-settings)
-* [Failing examples](#user-content-require-description-complete-sentence-failing-examples)
-* [Passing examples](#user-content-require-description-complete-sentence-passing-examples)
-
-
-Requires that block description, explicit `@description`, and
-`@param`/`@returns` tag descriptions are written in complete sentences, i.e.,
-
-* Description must start with an uppercase alphabetical character.
-* Paragraphs must start with an uppercase alphabetical character.
-* Sentences must end with a period, question mark, exclamation mark, or triple backticks.
-* Every line in a paragraph (except the first) which starts with an uppercase
-  character must be preceded by a line ending with a period.
-* A colon or semi-colon followed by two line breaks is still part of the
-  containing paragraph (unlike normal dual line breaks).
-* Text within inline tags `{...}` or within triple backticks are not checked for sentence divisions.
-* Periods after items within the `abbreviations` option array are not treated
-  as sentence endings.
-
-<a name="user-content-require-description-complete-sentence-fixer"></a>
-<a name="require-description-complete-sentence-fixer"></a>
-## Fixer
-
-If sentences do not end with terminal punctuation, a period will be added.
-
-If sentences do not start with an uppercase character, the initial
-letter will be capitalized.
-
-<a name="user-content-require-description-complete-sentence-options"></a>
-<a name="require-description-complete-sentence-options"></a>
-## Options
-
-<a name="user-content-require-description-complete-sentence-options-tags"></a>
-<a name="require-description-complete-sentence-options-tags"></a>
-### <code>tags</code>
-
-If you want additional tags to be checked for their descriptions, you may
-add them within this option.
-
-```js
-{
-  'jsdoc/require-description-complete-sentence': ['error', {
-    tags: ['see', 'copyright']
-  }]
-}
-```
-
-The tags `@param`/`@arg`/`@argument` and `@property`/`@prop` will be properly
-parsed to ensure that the checked "description" text includes only the text
-after the name.
+<a name="user-content-require-description"></a>
+<a name="require-description"></a>
+# <code>require-description</code>
 
-All other tags will treat the text following the tag name, a space, and
-an optional curly-bracketed type expression (and another space) as part of
-its "description" (e.g., for `@returns {someType} some description`, the
-description is `some description` while for `@some-tag xyz`, the description
-is `xyz`).
+* [Options](#user-content-require-description-options)
+* [Context and settings](#user-content-require-description-context-and-settings)
+* [Failing examples](#user-content-require-description-failing-examples)
+* [Passing examples](#user-content-require-description-passing-examples)
 
-<a name="user-content-require-description-complete-sentence-options-abbreviations"></a>
-<a name="require-description-complete-sentence-options-abbreviations"></a>
-### <code>abbreviations</code>
 
-You can provide an `abbreviations` options array to avoid such strings of text
-being treated as sentence endings when followed by dots. The `.` is not
-necessary at the end of the array items.
+Requires that all functions have a description.
 
-<a name="user-content-require-description-complete-sentence-options-newlinebeforecapsassumesbadsentenceend"></a>
-<a name="require-description-complete-sentence-options-newlinebeforecapsassumesbadsentenceend"></a>
-### <code>newlineBeforeCapsAssumesBadSentenceEnd</code>
+* All functions must have an implicit description (e.g., text above tags) or
+  have the option `descriptionStyle` set to `tag` (requiring `@description`
+  (or `@desc` if that is set as your preferred tag name)).
+* Every jsdoc block description (or `@description` tag if `descriptionStyle`
+  is `"tag"`) must have a non-empty description that explains the purpose of
+  the method.
 
-When `false` (the new default), we will not assume capital letters after
-newlines are an incorrect way to end the sentence (they may be proper
-nouns, for example).
+<a name="user-content-require-description-options"></a>
+<a name="require-description-options"></a>
+## Options
 
-<a name="user-content-require-description-complete-sentence-context-and-settings"></a>
-<a name="require-description-complete-sentence-context-and-settings"></a>
+An options object may have any of the following properties:
+
+- `contexts` - Set to an array of strings representing the AST context
+  where you wish the rule to be applied (e.g., `ClassDeclaration` for ES6
+  classes). Overrides the default contexts (see below).  Set to `"any"` if
+  you want the rule to apply to any jsdoc block throughout your files.
+- `exemptedBy` - Array of tags (e.g., `['type']`) whose presence on the
+    document block avoids the need for a `@description`. Defaults to an
+    array with `inheritdoc`. If you set this array, it will overwrite the
+    default, so be sure to add back `inheritdoc` if you wish its presence
+    to cause exemption of the rule.
+- `descriptionStyle` - Whether to accept implicit descriptions (`"body"`) or
+    `@description` tags (`"tag"`) as satisfying the rule. Set to `"any"` to
+    accept either style. Defaults to `"body"`.
+- `checkConstructors` - A value indicating whether `constructor`s should be
+    checked. Defaults to `true`.
+- `checkGetters` - A value indicating whether getters should be checked.
+    Defaults to `true`.
+- `checkSetters` - A value indicating whether setters should be checked.
+    Defaults to `true`.
+
+<a name="user-content-require-description-context-and-settings"></a>
+<a name="require-description-context-and-settings"></a>
 ## Context and settings
 
-|||
-|---|---|
-|Context|everywhere|
-|Tags|doc block, `param`, `returns`, `description`, `property`, `summary`, `file`, `classdesc`, `todo`, `deprecated`, `throws`, 'yields' and others added by `tags`|
-|Aliases|`arg`, `argument`, `return`, `desc`, `prop`, `fileoverview`, `overview`, `exception`, `yield`|
-|Recommended|false|
-|Options|`tags`, `abbreviations`, `newlineBeforeCapsAssumesBadSentenceEnd`|
-
-<a name="user-content-require-description-complete-sentence-failing-examples"></a>
-<a name="require-description-complete-sentence-failing-examples"></a>
+| | |
+| -------- | ---------------------- |
+| Context  | `ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled |
+| Tags     | `description` or jsdoc block |
+| Aliases  | `desc` |
+| Recommended | false |
+| Options  | `contexts`, `exemptedBy`, `descriptionStyle`, `checkConstructors`, `checkGetters`, `checkSetters` |
+| Settings | `ignoreReplacesDocs`, `overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs` |
+
+<a name="user-content-require-description-failing-examples"></a>
+<a name="require-description-failing-examples"></a>
 ## Failing examples
 
 The following patterns are considered problems:
 
 ````js
 /**
- * foo.
- */
-function quux () {
-
-}
-// Message: Sentences should start with an uppercase character.
-
-/**
- * foo?
- */
-function quux () {
-
-}
-// Message: Sentences should start with an uppercase character.
-
-/**
- * @description foo.
- */
-function quux () {
-
-}
-// Message: Sentences should start with an uppercase character.
-
-/**
- * Foo)
+ *
  */
 function quux () {
 
 }
-// Message: Sentences must end with a period.
+// "jsdoc/require-description": ["error"|"warn", {"descriptionStyle":"tag"}]
+// Message: Missing JSDoc @description declaration.
 
 /**
- * `foo` is a variable
+ *
  */
 function quux () {
 
 }
-// Message: Sentences must end with a period.
+// "jsdoc/require-description": ["error"|"warn", {"descriptionStyle":"any"}]
+// Message: Missing JSDoc block description or @description declaration.
 
 /**
- * Foo.
  *
- * foo.
  */
 function quux () {
 
 }
-// Message: Sentences should start with an uppercase character.
+// "jsdoc/require-description": ["error"|"warn", {"descriptionStyle":"body"}]
+// Message: Missing JSDoc block description.
 
 /**
- * тест.
+ * @desc Not a blank description
  */
 function quux () {
 
 }
-// Message: Sentences should start with an uppercase character.
+// "jsdoc/require-description": ["error"|"warn", {"descriptionStyle":"body"}]
+// Message: Remove the @desc tag to leave a plain block description or add additional description text above the @desc line.
 
 /**
- * Foo
+ * @description Not a blank description
  */
 function quux () {
 
 }
-// Message: Sentences must end with a period.
+// "jsdoc/require-description": ["error"|"warn", {"descriptionStyle":"body"}]
+// Message: Remove the @description tag to leave a plain block description or add additional description text above the @description line.
 
 /**
- * Foo
  *
- * @param x
  */
-function quux () {
+class quux {
 
 }
-// Message: Sentences must end with a period.
+// "jsdoc/require-description": ["error"|"warn", {"contexts":["ClassDeclaration"],"descriptionStyle":"tag"}]
+// Message: Missing JSDoc @description declaration.
 
 /**
- * Foo
- * Bar.
- */
-function quux () {
-
-}
-// "jsdoc/require-description-complete-sentence": ["error"|"warn", {"newlineBeforeCapsAssumesBadSentenceEnd":true}]
-// Message: A line of text is started with an uppercase character, but the preceding line does not end the sentence.
-
-/**
- * Foo.
  *
- * @param foo foo.
  */
-function quux (foo) {
+class quux {
 
 }
-// Message: Sentences should start with an uppercase character.
+// Settings: {"jsdoc":{"contexts":["ClassDeclaration"]}}
+// "jsdoc/require-description": ["error"|"warn", {"descriptionStyle":"tag"}]
+// Message: Missing JSDoc @description declaration.
 
 /**
- * Foo.
  *
- * @param foo bar
  */
-function quux (foo) {
-
-}
-// Message: Sentences should start with an uppercase character.
+// "jsdoc/require-description": ["error"|"warn", {"contexts":["any"],"descriptionStyle":"tag"}]
+// Message: Missing JSDoc @description declaration.
 
 /**
- * {@see Foo.bar} buz
- */
-function quux (foo) {
-
-}
-// Message: Sentences should start with an uppercase character.
-
-/**
- * Foo.
  *
- * @returns {number} foo
  */
-function quux (foo) {
+class quux {
 
 }
-// Message: Sentences should start with an uppercase character.
+// "jsdoc/require-description": ["error"|"warn", {"contexts":["ClassDeclaration"],"descriptionStyle":"tag"}]
+// Message: Missing JSDoc @description declaration.
 
 /**
- * Foo.
  *
- * @returns foo.
  */
-function quux (foo) {
+class quux {
 
 }
-// Message: Sentences should start with an uppercase character.
+// "jsdoc/require-description": ["error"|"warn", {"contexts":["ClassDeclaration"],"descriptionStyle":"tag"}]
+// Message: Missing JSDoc @description declaration.
 
 /**
- * lorem ipsum dolor sit amet, consectetur adipiscing elit. pellentesque elit diam,
- * iaculis eu dignissim sed, ultrices sed nisi. nulla at ligula auctor, consectetur neque sed,
- * tincidunt nibh. vivamus sit amet vulputate ligula. vivamus interdum elementum nisl,
- * vitae rutrum tortor semper ut. morbi porta ante vitae dictum fermentum.
- * proin ut nulla at quam convallis gravida in id elit. sed dolor mauris, blandit quis ante at,
- * consequat auctor magna. duis pharetra purus in porttitor mollis.
+ * @description
  */
-function longDescription (foo) {
-
-}
-// Message: Sentences should start with an uppercase character.
-
-/**
- * @arg {number} foo - Foo
- */
-function quux (foo) {
+function quux () {
 
 }
-// Message: Sentences must end with a period.
+// "jsdoc/require-description": ["error"|"warn", {"descriptionStyle":"tag"}]
+// Message: Missing JSDoc @description description.
 
 /**
- * @argument {number} foo - Foo
+ *
  */
-function quux (foo) {
+interface quux {
 
 }
-// Message: Sentences must end with a period.
+// "jsdoc/require-description": ["error"|"warn", {"contexts":["TSInterfaceDeclaration"],"descriptionStyle":"tag"}]
+// Message: Missing JSDoc @description declaration.
 
 /**
- * @return {number} foo
+ *
  */
-function quux (foo) {
+var quux = class {
 
-}
-// Message: Sentences should start with an uppercase character.
+};
+// "jsdoc/require-description": ["error"|"warn", {"contexts":["ClassExpression"],"descriptionStyle":"tag"}]
+// Message: Missing JSDoc @description declaration.
 
 /**
- * Returns bar.
  *
- * @return {number} bar
  */
-function quux (foo) {
-
-}
-// Message: Sentences should start with an uppercase character.
+var quux = {
 
-/**
- * @throws {object} Hello World
- * hello world
-*/
-// Message: Sentences must end with a period.
+};
+// "jsdoc/require-description": ["error"|"warn", {"contexts":["ObjectExpression"],"descriptionStyle":"tag"}]
+// Message: Missing JSDoc @description declaration.
 
 /**
- * @summary Foo
+ * @someDesc
  */
 function quux () {
 
 }
-// Message: Sentences must end with a period.
+// Settings: {"jsdoc":{"tagNamePreference":{"description":{"message":"Please avoid `{{tagName}}`; use `{{replacement}}` instead","replacement":"someDesc"}}}}
+// "jsdoc/require-description": ["error"|"warn", {"descriptionStyle":"tag"}]
+// Message: Missing JSDoc @someDesc description.
 
 /**
- * @throws {SomeType} Foo
+ * @description
  */
 function quux () {
 
 }
-// Message: Sentences must end with a period.
+// Settings: {"jsdoc":{"tagNamePreference":{"description":false}}}
+// "jsdoc/require-description": ["error"|"warn", {"descriptionStyle":"tag"}]
+// Message: Unexpected tag `@description`
 
 /**
- * @see Foo
+ * @description
  */
 function quux () {
 
-}
-// "jsdoc/require-description-complete-sentence": ["error"|"warn", {"tags":["see"]}]
-// Message: Sentences must end with a period.
-
-/**
- * @param foo Foo bar
- */
-function quux (foo) {
-
 }
 // Settings: {"jsdoc":{"tagNamePreference":{"description":false}}}
-// "jsdoc/require-description-complete-sentence": ["error"|"warn", {"tags":["param"]}]
-// Message: Sentences must end with a period.
+// "jsdoc/require-description": ["error"|"warn", {"descriptionStyle":"any"}]
+// Message: Missing JSDoc block description or @description declaration.
 
 /**
- * Sorry, but this isn't a complete sentence, Mr.
+ *
  */
 function quux () {
-
 }
-// "jsdoc/require-description-complete-sentence": ["error"|"warn", {"abbreviations":["Mr"]}]
-// Message: Sentences must end with a period.
+// "jsdoc/require-description": ["error"|"warn", {"exemptedBy":["notPresent"]}]
+// Message: Missing JSDoc block description.
 
-/**
- * Sorry, but this isn't a complete sentence Mr.
- */
-function quux () {
+class TestClass {
+  /**
+   *
+   */
+  constructor() { }
+}
+// Message: Missing JSDoc block description.
 
+class TestClass {
+  /**
+   *
+   */
+  constructor() { }
 }
-// "jsdoc/require-description-complete-sentence": ["error"|"warn", {"abbreviations":["Mr."]}]
-// Message: Sentences must end with a period.
+// "jsdoc/require-description": ["error"|"warn", {"checkConstructors":true}]
+// Message: Missing JSDoc block description.
 
-/**
- * Sorry, but this isn't a complete sentence Mr. 
- */
-function quux () {
+class TestClass {
+  /**
+   *
+   */
+  get Test() { }
+}
+// Message: Missing JSDoc block description.
 
+class TestClass {
+  /**
+   *
+   */
+  get Test() { }
 }
-// "jsdoc/require-description-complete-sentence": ["error"|"warn", {"abbreviations":["Mr"]}]
-// Message: Sentences must end with a period.
+// "jsdoc/require-description": ["error"|"warn", {"checkGetters":true}]
+// Message: Missing JSDoc block description.
 
-/**
- * Sorry, but this isn't a complete sentence Mr. and Mrs.
- */
-function quux () {
+class TestClass {
+  /**
+   *
+   */
+  set Test(value) { }
+}
+// Message: Missing JSDoc block description.
 
+class TestClass {
+  /**
+   *
+   */
+  set Test(value) { }
 }
-// "jsdoc/require-description-complete-sentence": ["error"|"warn", {"abbreviations":["Mr","Mrs"]}]
-// Message: Sentences must end with a period.
+// "jsdoc/require-description": ["error"|"warn", {"checkSetters":true}]
+// Message: Missing JSDoc block description.
 
 /**
- * This is a complete sentence. But this isn't, Mr.
+ *
  */
-function quux () {
+class Foo {
+    /**
+     *
+     */
+    constructor() {}
 
+    /**
+     *
+     */
+    bar() {}
 }
-// "jsdoc/require-description-complete-sentence": ["error"|"warn", {"abbreviations":["Mr"]}]
-// Message: Sentences must end with a period.
+// "jsdoc/require-description": ["error"|"warn", {"checkConstructors":false,"contexts":["MethodDefinition"]}]
+// Message: Missing JSDoc block description.
 
 /**
- * This is a complete Mr. sentence. But this isn't, Mr.
+ * @implements {Bar}
  */
-function quux () {
+class quux {
 
 }
-// "jsdoc/require-description-complete-sentence": ["error"|"warn", {"abbreviations":["Mr"]}]
-// Message: Sentences must end with a period.
+// Settings: {"jsdoc":{"implementsReplacesDocs":false}}
+// "jsdoc/require-description": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[postDelimiter=\"\"]:has(JsdocTag[rawType=\"Bar\"])","context":"ClassDeclaration"}],"descriptionStyle":"tag"}]
+// Message: Missing JSDoc @description declaration.
 
 /**
- * This is a complete Mr. sentence.
+ * Has some
+ *   description already.
+ * @implements {Bar}
  */
-function quux () {
+class quux {
 
 }
-// Message: Sentences should start with an uppercase character.
+// Settings: {"jsdoc":{"implementsReplacesDocs":false}}
+// "jsdoc/require-description": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[postDelimiter=\"\"]:has(JsdocTag[rawType=\"Bar\"])","context":"ClassDeclaration"}],"descriptionStyle":"tag"}]
+// Message: Missing JSDoc @description declaration.
 
 /**
- * This is fun, i.e. enjoyable, but not superlatively so, e.g. not
- * super, wonderful, etc..
+ * @implements {Bar
+ *   | Foo}
  */
-function quux () {
+class quux {
 
 }
-// Message: Sentences should start with an uppercase character.
+// Settings: {"jsdoc":{"implementsReplacesDocs":false}}
+// "jsdoc/require-description": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[postDelimiter=\"\"]:has(JsdocTypeUnion > JsdocTypeName[value=\"Bar\"]:nth-child(1))","context":"ClassDeclaration"}],"descriptionStyle":"tag"}]
+// Message: Missing JSDoc @description declaration.
 
 /**
- * Do not have dynamic content; e.g. homepage. Here a simple unique id
- * suffices.
+ * @implements {Bar}
  */
- function quux () {
-
- }
-// Message: Sentences should start with an uppercase character.
+class quux {
 
-/**
- * Implements support for the
- * Swahili voice synthesizer.
- */
-function speak() {
 }
-// "jsdoc/require-description-complete-sentence": ["error"|"warn", {"newlineBeforeCapsAssumesBadSentenceEnd":true}]
-// Message: A line of text is started with an uppercase character, but the preceding line does not end the sentence.
+// Settings: {"jsdoc":{"implementsReplacesDocs":false}}
+// "jsdoc/require-description": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[postDelimiter=\"\"]:has(JsdocTag[tag=\"implements\"])","context":"ClassDeclaration"}],"descriptionStyle":"tag"}]
+// Message: Missing JSDoc @description declaration.
 
 /**
- * Foo.
- *
- * @template TempA, TempB foo.
+ * @implements {Bar}
  */
-function quux (foo) {
+class quux {
 
 }
-// "jsdoc/require-description-complete-sentence": ["error"|"warn", {"tags":["template"]}]
-// Message: Sentences should start with an uppercase character.
-
-/**
- * Just a component.
- * @param {Object} props Свойства.
- * @return {ReactElement}.
- */
-function quux () {}
-// Message: Sentences must be more than punctuation.
+// Settings: {"jsdoc":{"implementsReplacesDocs":false}}
+// "jsdoc/require-description": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[postDelimiter=\"\"]:has(JsdocTag[tag=\"implements\"])","context":"any"}],"descriptionStyle":"tag"}]
+// Message: Missing JSDoc @description declaration.
 ````
 
 
 
-<a name="user-content-require-description-complete-sentence-passing-examples"></a>
-<a name="require-description-complete-sentence-passing-examples"></a>
+<a name="user-content-require-description-passing-examples"></a>
+<a name="require-description-passing-examples"></a>
 ## Passing examples
 
 The following patterns are not considered problems:
 
 ````js
 /**
- * @param foo - Foo.
- */
-function quux () {
-
-}
-
-/**
- * Foo.
- */
-function quux () {
-
-}
-
-/**
- * Foo.
- * Bar.
- */
-function quux () {
-
-}
-
-/**
- * Foo.
  *
- * Bar.
- */
-function quux () {
-
-}
-
-/**
- * Тест.
  */
-function quux () {
-
-}
-
-/**
- * Foo
- * bar.
- */
-function quux () {
-
-}
 
 /**
- * @returns Foo bar.
+ * @description
+ * // arbitrary description content
  */
 function quux () {
 
 }
+// "jsdoc/require-description": ["error"|"warn", {"descriptionStyle":"tag"}]
 
 /**
- * Foo {@see Math.sin}.
+ * @description
+ * quux(); // does something useful
  */
 function quux () {
 
 }
+// "jsdoc/require-description": ["error"|"warn", {"descriptionStyle":"tag"}]
 
 /**
- * Foo {@see Math.sin} bar.
+ * @description <caption>Valid usage</caption>
+ * quux(); // does something useful
+ *
+ * @description <caption>Invalid usage</caption>
+ * quux('random unwanted arg'); // results in an error
  */
 function quux () {
 
 }
+// "jsdoc/require-description": ["error"|"warn", {"descriptionStyle":"tag"}]
 
 /**
- * Foo?
- *
- * Bar!
  *
- * Baz:
- *   1. Foo.
- *   2. Bar.
  */
-function quux () {
+class quux {
 
 }
+// "jsdoc/require-description": ["error"|"warn", {"descriptionStyle":"tag"}]
 
 /**
- * Hello:
- * World.
+ *
  */
 function quux () {
 
 }
+// "jsdoc/require-description": ["error"|"warn", {"contexts":["ClassDeclaration"]}]
 
 /**
- * Hello: world.
+ * @type {MyCallback}
  */
 function quux () {
 
 }
+// "jsdoc/require-description": ["error"|"warn", {"exemptedBy":["type"]}]
 
 /**
  *
  */
-function quux () {
+interface quux {
 
 }
+// "jsdoc/require-description": ["error"|"warn", {"descriptionStyle":"tag"}]
 
-/**
- * @description Foo.
- */
-function quux () {
-
-}
-
-/**
- * `foo` is a variable.
- */
-function quux () {
-
+interface quux {
+  /**
+   * If the thing should be checked.
+   */
+  checked?: boolean
 }
+// "jsdoc/require-description": ["error"|"warn", {"contexts":["TSPropertySignature"]}]
 
 /**
- * Foo.
  *
- * `foo`.
  */
-function quux () {
+var quux = class {
 
-}
+};
+// "jsdoc/require-description": ["error"|"warn", {"descriptionStyle":"tag"}]
 
 /**
- * @param foo - `bar`.
+ *
  */
-function quux () {
+var quux = {
 
-}
+};
+// "jsdoc/require-description": ["error"|"warn", {"descriptionStyle":"tag"}]
 
 /**
- * @returns {number} `foo`.
+ * Has an implicit description
  */
 function quux () {
 
 }
+// "jsdoc/require-description": ["error"|"warn", {"descriptionStyle":"body"}]
 
 /**
- * Foo
- * `bar`.
+ * Has an implicit description
  */
 function quux () {
 
 }
 
 /**
- * @example Foo
+ * Has an implicit description
  */
 function quux () {
 
 }
+// "jsdoc/require-description": ["error"|"warn", {"descriptionStyle":"any"}]
 
 /**
- * @see Foo
+ * @description Has an explicit description
  */
 function quux () {
 
 }
+// "jsdoc/require-description": ["error"|"warn", {"descriptionStyle":"any"}]
 
 /**
- * Foo.
  *
- * @param foo Foo.
- */
-function quux (foo) {
-
-}
-
-/**
- * Foo.
- *
- * @param foo Foo.
- */
-function quux (foo) {
-
-}
-// "jsdoc/require-description-complete-sentence": ["error"|"warn", {"tags":["param"]}]
-
-/**
- * @param foo Foo bar.
- */
-function quux (foo) {
-
-}
-// Settings: {"jsdoc":{"tagNamePreference":{"description":false}}}
-// "jsdoc/require-description-complete-sentence": ["error"|"warn", {"tags":["param"]}]
-
-/**
- *
- */
-function quux (foo) {
-
-}
-// Settings: {"jsdoc":{"tagNamePreference":{"description":false}}}
-
-/**
-* We stop loading Items when we have loaded:
-*
-* 1) The main Item;
-* 2) All its variants.
-*/
-
-/**
- * This method is working on 2 steps.
- *
- * | Step | Comment     |
- * |------|-------------|
- * |   1  | do it       |
- * |   2  | do it again |
- */
-
-/**
- * This is something that
- * I want to test.
  */
 function quux () {
 
 }
+// Settings: {"jsdoc":{"tagNamePreference":{"description":false}}}
 
-/**
- * When making HTTP requests, the
- * URL is super important.
- */
-function quux () {
-
-}
-
-/**
- * Sorry, but this isn't a complete sentence, Mr.
- */
-function quux () {
-
+class TestClass {
+  /**
+   * Test.
+   */
+  constructor() { }
 }
 
-/**
- * Sorry, but this isn't a complete sentence Mr..
- */
-function quux () {
-
+class TestClass {
+  /**
+   *
+   */
+  constructor() { }
 }
-// "jsdoc/require-description-complete-sentence": ["error"|"warn", {"abbreviations":["Mr."]}]
-
-/**
- * Sorry, but this isn't a complete sentence Mr. 
- */
-function quux () {
+// "jsdoc/require-description": ["error"|"warn", {"checkConstructors":false}]
 
+class TestClass {
+  /**
+   * Test.
+   */
+  get Test() { }
 }
 
-/**
- * Sorry, but this isn't a complete sentence Mr. and Mrs..
- */
-function quux () {
-
-}
-// "jsdoc/require-description-complete-sentence": ["error"|"warn", {"abbreviations":["Mr","Mrs"]}]
-
-/**
- * This is a complete sentence aMr.
- */
-function quux () {
-
+class TestClass {
+  /**
+   *
+   */
+  get Test() { }
 }
-// "jsdoc/require-description-complete-sentence": ["error"|"warn", {"abbreviations":["Mr"]}]
-
-/**
- * This is a complete sentence. But this isn't, Mr.
- */
-function quux () {
+// "jsdoc/require-description": ["error"|"warn", {"checkGetters":false}]
 
+class TestClass {
+  /**
+   * Test.
+   */
+  set Test(value) { }
 }
 
-/**
- * This is a complete Mr. Sentence. But this isn't, Mr.
- */
-function quux () {
-
+class TestClass {
+  /**
+   *
+   */
+  set Test(value) { }
 }
+// "jsdoc/require-description": ["error"|"warn", {"checkSetters":false}]
 
 /**
- * This is a complete Mr. sentence.
+ * Multi
+ * line
  */
 function quux () {
 
 }
-// "jsdoc/require-description-complete-sentence": ["error"|"warn", {"abbreviations":["Mr"]}]
 
-/**
- * This is fun, i.e. enjoyable, but not superlatively so, e.g. not
- * super, wonderful, etc..
- */
+/** Single line */
 function quux () {
 
 }
-// "jsdoc/require-description-complete-sentence": ["error"|"warn", {"abbreviations":["etc","e.g.","i.e."]}]
-
 
-**
-* Do not have dynamic content; e.g. homepage. Here a simple unique id
-* suffices.
-*/
+/** @description something */
 function quux () {
 
 }
-// "jsdoc/require-description-complete-sentence": ["error"|"warn", {"abbreviations":["etc","e.g.","i.e."]}]
+// "jsdoc/require-description": ["error"|"warn", {"descriptionStyle":"tag"}]
 
 /**
- * Implements support for the
- * Swahili voice synthesizer.
+ * @implements {Bar}
  */
-function speak() {
-}
+class quux {
 
-/**
- * @param foo
- *
- * @returns {void}
- */
-export default (foo) => {
-  foo()
 }
-
-/** @file To learn more,
- * see: https://github.com/d3/d3-ease. */
-
-/** To learn more,
- * see: https://github.com/d3/d3-ease. */
+// Settings: {"jsdoc":{"implementsReplacesDocs":false}}
+// "jsdoc/require-description": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[postDelimiter=/\\s{4}/]:has(JsdocTag[rawType=\"class\"])","context":"ClassDeclaration"}],"descriptionStyle":"tag"}]
 
 /**
- * This is a complete sentence...
+ * Has some
+ *   description already.
  */
-function quux () {
+class quux {
 
 }
+// "jsdoc/require-description": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[postDelimiter=\"\"]:has(JsdocTag[rawType=\"{Bar}\"])","context":"ClassDeclaration"}],"descriptionStyle":"tag"}]
 
 /**
- * He wanted a few items: a jacket and shirt...
+ * Has some
+ *   description already.
  */
-function quux () {
+class quux {
 
 }
+// "jsdoc/require-description": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[postDelimiter=\"\"]:has(JsdocTag[rawType=\"{Bar}\"])","context":"any"}],"descriptionStyle":"tag"}]
 
 /**
- * The code in question was...
- * ```
- * alert('hello');
- * ```
+ * Has some
+ *   description already.
  */
-function quux () {
-
-}
-
-/**
- * @param {number|string|Date|Object|OverType|WhateverElse} multiType -
- * Nice long explanation...
- */
-function test (multiType) {
-}
-
-/**
- * Any kind of fowl (e.g., a duck).
- */
-function quux () {}
-
-/**
- * The code in question was...
- * ```
- * do something
- *
- * interesting
- * ```
- */
-function quux () {
-
-}
+// "jsdoc/require-description": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[postDelimiter=\"\"]:has(JsdocTag[rawType=\"{Bar}\"])","context":"any"}],"descriptionStyle":"tag"}]
 ````