docs: generate docs

Author: brettz9

README.md

@@ -196,16 +196,7 @@ Use `settings.jsdoc.tagNamePreference` to configure a preferred alias name for a
 }
 ```
 
-<<<<<<< HEAD
-<<<<<<< HEAD
 One may also use an object with a `message` and `replacement`.
-=======
-One may also use an object with a `message` and `replacement`, with `{{tagName}}` and `{{preferredType}}` (or its alias `{{replacement}}`) as template variables to be
-=======
-One may also use an object with a `message` and `replacement`, with `{{tagName}}` and `{{preferredTag}}` (or its alias `{{replacement}}`) as template variables to be
->>>>>>> fix var. name in docs
-substituted within `message`.
->>>>>>> feat(check-tag-names): allow rejecting normally valid tag names and/or providing custom error messages when suggesting tags to reject or replace (fixes #108)
 
 The following will report the message `@extends is to be used over @augments as it is more evocative of classes than @augments` upon encountering `@augments`.
 
@@ -216,15 +207,7 @@ The following will report the message `@extends is to be used over @augments as
         "jsdoc": {
             "tagNamePreference": {
                 "augments": {
-<<<<<<< HEAD
-<<<<<<< HEAD
                   "message": "@extends is to be used over @augments as it is more evocative of classes than @augments",
-=======
-                  "message": "@{{replacement}} is to be used over @{{tagName}} as it is more evocative of classes than @augments",
->>>>>>> feat(check-tag-names): allow rejecting normally valid tag names and/or providing custom error messages when suggesting tags to reject or replace (fixes #108)
-=======
-                  "message": "@{{replacement}} is to be used over @{{tagName}} as it is more evocative of classes than @{{tagName}}",
->>>>>>> docs: Make consistent in case not removing templating
                   "replacement": "extends"
                 }
             }
@@ -1381,11 +1364,7 @@ function quux () {
 function quux () {
 
 }
-<<<<<<< HEAD
 // Settings: {"jsdoc":{"tagNamePreference":{"todo":{"message":"Please use x-todo instead of todo","replacement":"x-todo"}}}}
-=======
-// Settings: {"jsdoc":{"tagNamePreference":{"todo":{"message":"Please use {{replacement}} instead of {{tagName}}","replacement":"x-todo"}}}}
->>>>>>> feat(check-tag-names): allow rejecting normally valid tag names and/or providing custom error messages when suggesting tags to reject or replace (fixes #108)
 // Message: Please use x-todo instead of todo
 
 /**
@@ -1394,11 +1373,7 @@ function quux () {
 function quux () {
 
 }
-<<<<<<< HEAD
 // Settings: {"jsdoc":{"tagNamePreference":{"todo":{"message":"Please use x-todo instead of todo","replacement":"x-todo"}}}}
-=======
-// Settings: {"jsdoc":{"tagNamePreference":{"todo":{"message":"Please use {{preferredTagName}} instead of {{tagName}}","replacement":"x-todo"}}}}
->>>>>>> feat(check-tag-names): allow rejecting normally valid tag names and/or providing custom error messages when suggesting tags to reject or replace (fixes #108)
 // Message: Please use x-todo instead of todo
 
 /**
@@ -2496,7 +2471,7 @@ tag should be linted with the `matchDescription` value (or the default).
 }
 ```
 
-<a name="eslint-plugin-jsdoc-rules-match-description-options-1-maindescription"></a>
+<a name="eslint-plugin-jsdoc-rules-match-description-options-2-maindescription"></a>
 ##### <code>mainDescription</code>
 
 If you wish to override the main function description without changing the
@@ -2964,7 +2939,7 @@ const q = {
 
 Enforces a consistent padding of the block description.
 
-<a name="eslint-plugin-jsdoc-rules-newline-after-description-options-2"></a>
+<a name="eslint-plugin-jsdoc-rules-newline-after-description-options-3"></a>
 #### Options
 
 This rule allows one optional string argument. If it is `"always"` then a problem is raised when there is a newline after the description. If it is `"never"` then a problem is raised when there is no newline after the description. The default value is `"always"`.
@@ -3124,7 +3099,7 @@ The following types are always considered defined.
 - `any`, `*`
 - `Array`, `Object`, `RegExp`, `Date`, `Function`
 
-<a name="eslint-plugin-jsdoc-rules-no-undefined-types-options-3"></a>
+<a name="eslint-plugin-jsdoc-rules-no-undefined-types-options-4"></a>
 #### Options
 
 An option object may have the following keys:
@@ -3720,7 +3695,7 @@ Requires that all functions have a description.
 * All functions must have a `@description` tag.
 * Every description tag must have a non-empty description that explains the purpose of the method.
 
-<a name="eslint-plugin-jsdoc-rules-require-description-options-4"></a>
+<a name="eslint-plugin-jsdoc-rules-require-description-options-5"></a>
 #### Options
 
 An options object may have any of the following properties:
@@ -3914,7 +3889,7 @@ Requires that all functions have examples.
 * All functions must have one or more `@example` tags.
 * Every example tag must have a non-empty description that explains the method's usage.
 
-<a name="eslint-plugin-jsdoc-rules-require-example-options-5"></a>
+<a name="eslint-plugin-jsdoc-rules-require-example-options-6"></a>
 #### Options
 
 Has an object option with one optional property:
@@ -4045,7 +4020,7 @@ function quux () {
 
 Requires a hyphen before the `@param` description.
 
-<a name="eslint-plugin-jsdoc-rules-require-hyphen-before-param-description-options-6"></a>
+<a name="eslint-plugin-jsdoc-rules-require-hyphen-before-param-description-options-7"></a>
 #### Options
 
 This rule takes one optional string argument. If it is `"always"` then a problem is raised when there is no hyphen before the description. If it is `"never"` then a problem is raised when there is a hyphen before the description. The default value is `"always"`.
@@ -4151,11 +4126,7 @@ function quux () {
 Checks for presence of jsdoc comments, on class declarations as well as
 functions.
 
-<<<<<<< HEAD
-<a name="eslint-plugin-jsdoc-rules-require-jsdoc-options-7"></a>
-=======
-<a name="eslint-plugin-jsdoc-rules-require-jsdoc-options-6"></a>
->>>>>>> feat(check-tag-names): add `preferredTagsDefined` option to auto-allow tags in `tagNamePreference` setting; add `definedTags` option to replace `additionalTagNames.customTags` setting
+<a name="eslint-plugin-jsdoc-rules-require-jsdoc-options-8"></a>
 #### Options
 
 Accepts one optional options object with the following optional keys.
@@ -5191,11 +5162,7 @@ function quux (foo) {
 
 Requires that all function parameters are documented.
 
-<<<<<<< HEAD
-<a name="eslint-plugin-jsdoc-rules-require-param-options-8"></a>
-=======
-<a name="eslint-plugin-jsdoc-rules-require-param-options-7"></a>
->>>>>>> feat(check-tag-names): add `preferredTagsDefined` option to auto-allow tags in `tagNamePreference` setting; add `definedTags` option to replace `additionalTagNames.customTags` setting
+<a name="eslint-plugin-jsdoc-rules-require-param-options-9"></a>
 #### Options
 
 An options object accepts one optional property:
@@ -6122,11 +6089,7 @@ function quux () {
 
 Requires returns are documented.
 
-<<<<<<< HEAD
-<a name="eslint-plugin-jsdoc-rules-require-returns-options-9"></a>
-=======
-<a name="eslint-plugin-jsdoc-rules-require-returns-options-8"></a>
->>>>>>> feat(check-tag-names): add `preferredTagsDefined` option to auto-allow tags in `tagNamePreference` setting; add `definedTags` option to replace `additionalTagNames.customTags` setting
+<a name="eslint-plugin-jsdoc-rules-require-returns-options-10"></a>
 #### Options
 
 - `exemptedBy` - Array of tags (e.g., `['type']`) whose presence on the document