Fix TSDoc issues identified by API Extractor

Author: octogonz

tsdoc/etc/tsdoc.api.md

@@ -44,7 +44,7 @@ export interface ITSDocTagDefinitionInternalParameters extends ITSDocTagDefiniti
  */
 export class TSDocTagDefinition {
   /**
-   * The TSDoc tag name.  TSDoc tag names start with an at-sign ("@") followed
+   * The TSDoc tag name.  TSDoc tag names start with an at-sign (`@`) followed
    * by ASCII letters using "camelCase" capitalization.
    */
   public readonly tagName: string;

tsdoc/src/configuration/TSDocTagDefinition.ts

@@ -52,7 +52,7 @@ export class DocBlockTag extends DocNode {
   }
 
   /**
-   * The TSDoc tag name.  TSDoc tag names start with an at-sign ("@") followed
+   * The TSDoc tag name.  TSDoc tag names start with an at-sign (`@`) followed
    * by ASCII letters using "camelCase" capitalization.
    */
   public get tagName(): string {

tsdoc/src/nodes/DocBlockTag.ts

@@ -171,7 +171,7 @@ export class DocComment extends DocNode {
    * manually.
    *
    * This method is provided as convenience for simple use cases.  To customize the output, or if you need
-   * to render into a `StringBuilder, use the {@link TSDocEmitter} class instead.
+   * to render into a `StringBuilder`, use the {@link TSDocEmitter} class instead.
    */
   public emitAsTsdoc(): string {
     const stringBuilder: StringBuilder = new StringBuilder();

tsdoc/src/nodes/DocComment.ts

@@ -121,7 +121,7 @@ export class DocHtmlStartTag extends DocNode {
   }
 
   /**
-   * If true, then the HTML tag ends with "/>" instead of ">".
+   * If true, then the HTML tag ends with `/>` instead of `>`.
    */
   public get selfClosingTag(): boolean {
     return this._selfClosingTag;

tsdoc/src/nodes/DocHtmlStartTag.ts

@@ -24,7 +24,7 @@ export interface IDocInlineTagBaseParsedParameters extends IDocNodeParsedParamet
 }
 
 /**
- * The abstract base class for {@link DocInlineTag}, {@link DocLink}, and {@link DocInheritDoc}.
+ * The abstract base class for {@link DocInlineTag}, {@link DocLinkTag}, and {@link DocInheritDocTag}.
  */
 export abstract class DocInlineTagBase extends DocNode {
   private readonly _openingDelimiterExcerpt: DocExcerpt | undefined;
@@ -78,7 +78,7 @@ export abstract class DocInlineTagBase extends DocNode {
   }
 
   /**
-   * The TSDoc tag name.  TSDoc tag names start with an at-sign ("@") followed
+   * The TSDoc tag name.  TSDoc tag names start with an at-sign (`@`) followed
    * by ASCII letters using "camelCase" capitalization.
    *
    * @remarks

tsdoc/src/nodes/DocInlineTagBase.ts

@@ -166,7 +166,7 @@ export const enum TSDocMessageId {
   MissingTag = 'tsdoc-missing-tag',
 
   /**
-   * The "@" character looks like part of a TSDoc tag; use a backslash to escape it.
+   * The `@` character looks like part of a TSDoc tag; use a backslash to escape it.
    */
   AtSignInWord = 'tsdoc-at-sign-in-word',
 

tsdoc/src/parser/TSDocMessageId.ts

@@ -8,7 +8,7 @@ export class DocNodeTransforms {
   /**
    * trimSpacesInParagraphNodes() collapses extra spacing characters from plain text nodes.
    *
-   * @remark
+   * @remarks
    * This is useful when emitting HTML, where any number of spaces are equivalent
    * to a single space.  It's also useful when emitting Markdown, where spaces
    * can be misinterpreted as an indented code block.