fix(typescript): descriptions need tag Markdown escaping

Author: brettz9

src/index-cjs.js

@@ -122,7 +122,7 @@ index.rules = {
         message: '@next should have a type',
       },
     ],
-    description: 'Requires a type for @next tags',
+    description: 'Requires a type for `@next` tags',
     url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-next-type.md#repos-sticky-header',
   }),
   'require-param': requireParam,
@@ -147,7 +147,7 @@ index.rules = {
         message: '@throws should have a type',
       },
     ],
-    description: 'Requires a type for @throws tags',
+    description: 'Requires a type for `@throws` tags',
     url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-throws-type.md#repos-sticky-header',
   }),
   'require-yields': requireYields,
@@ -160,7 +160,7 @@ index.rules = {
         message: '@yields should have a type',
       },
     ],
-    description: 'Requires a type for @yields tags',
+    description: 'Requires a type for `@yields` tags',
     url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields-type.md#repos-sticky-header',
   }),
   'sort-tags': sortTags,

src/index.js

@@ -128,7 +128,7 @@ index.rules = {
         message: '@next should have a type',
       },
     ],
-    description: 'Requires a type for @next tags',
+    description: 'Requires a type for `@next` tags',
     url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-next-type.md#repos-sticky-header',
   }),
   'require-param': requireParam,
@@ -153,7 +153,7 @@ index.rules = {
         message: '@throws should have a type',
       },
     ],
-    description: 'Requires a type for @throws tags',
+    description: 'Requires a type for `@throws` tags',
     url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-throws-type.md#repos-sticky-header',
   }),
   'require-yields': requireYields,
@@ -166,7 +166,7 @@ index.rules = {
         message: '@yields should have a type',
       },
     ],
-    description: 'Requires a type for @yields tags',
+    description: 'Requires a type for `@yields` tags',
     url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields-type.md#repos-sticky-header',
   }),
   'sort-tags': sortTags,

src/rules.d.ts

@@ -557,7 +557,7 @@ export interface Rules {
         }
       ];
 
-  /** Requires a type for @next tags */
+  /** Requires a type for `@next` tags */
   "jsdoc/require-next-type": [];
 
   /** Requires that all function parameters are documented. */
@@ -748,7 +748,7 @@ export interface Rules {
         }
       ];
 
-  /** Requires a type for @throws tags */
+  /** Requires a type for `@throws` tags */
   "jsdoc/require-throws-type": [];
 
   /** Requires yields are documented. */
@@ -790,7 +790,7 @@ export interface Rules {
         }
       ];
 
-  /** Requires a type for @yields tags */
+  /** Requires a type for `@yields` tags */
   "jsdoc/require-yields-type": [];
 
   /** Sorts tags by a specified sequence according to tag name. */