Class Comment

constructor

• new Comment(summary?, blockTags?, modifierTags?): Models.Comment

• Creates a new Comment instance.

  Parameters

  • summary: Models.CommentDisplayPart[] = []
  • blockTags: Models.CommentTag[] = []
  • modifierTags: Set<`@${string}`> = ...

  Returns Models.Comment

blockTags

modifierTags

summary

Optional label

clone

• clone(): Models.Comment

• Create a deep clone of this comment.

  Returns Models.Comment

fromObject

• fromObject(de, obj): void

• Parameters

  • de: Deserializer
  • obj: JSONOutput.Comment

  Returns void

getIdentifiedTag

• getIdentifiedTag(identifier, tagName): undefined | Models.CommentTag

• Parameters

  • identifier: string
  • tagName: `@${string}`

  Returns undefined | Models.CommentTag

getTag

• getTag(tagName): undefined | Models.CommentTag

• Return the first tag with the given name.

  Parameters

  • tagName: `@${string}`

    The name of the tag to look for.

  Returns undefined | Models.CommentTag

  The found tag or undefined.

getTags

• getTags(tagName): Models.CommentTag[]

• Get all tags with the given tag name.

  Parameters

  • tagName: `@${string}`

  Returns Models.CommentTag[]

hasModifier

• hasModifier(tagName): boolean

• Test whether this comment contains a tag with the given name.

  Parameters

  • tagName: `@${string}`

    The name of the tag to look for.

  Returns boolean

  TRUE when this comment contains a tag with the given name, otherwise FALSE.

hasVisibleComponent

• hasVisibleComponent(): boolean

• Has this comment a visible component?

  Returns boolean

  TRUE when this comment has a visible component.

isEmpty

• isEmpty(): boolean
• Internal

  Returns true if this comment is completely empty.

  Returns boolean

removeModifier

• removeModifier(tagName): void

• Parameters

  • tagName: `@${string}`

  Returns void

removeTags

• removeTags(tagName): void

• Removes all block tags with the given tag name from the comment.

  Parameters

  • tagName: `@${string}`

  Returns void

toObject

• toObject(serializer): JSONOutput.Comment

• Parameters

  • serializer: Serializer

  Returns JSONOutput.Comment

Static cloneDisplayParts

• cloneDisplayParts(parts): ({
      kind: "text";
      text: string;
  } | {
      kind: "code";
      text: string;
  } | {
      kind: "inline-tag";
      tag: `@${string}`;
      text: string;
      target?: string | Models.Reflection | Models.ReflectionSymbolId;
      tsLinkText?: string;
  })[]

• Helper utility to clone Comment.summary or CommentTag.content

  Parameters

  • parts: readonly Models.CommentDisplayPart[]

  Returns ({
      kind: "text";
      text: string;
  } | {
      kind: "code";
      text: string;
  } | {
      kind: "inline-tag";
      tag: `@${string}`;
      text: string;
      target?: string | Models.Reflection | Models.ReflectionSymbolId;
      tsLinkText?: string;
  })[]

Static combineDisplayParts

• combineDisplayParts(parts): string

• Debugging utility for combining parts into a simple string. Not suitable for rendering, but can be useful in tests.

  Parameters

  • parts: undefined | readonly Models.CommentDisplayPart[]

  Returns string

Static deserializeDisplayParts

• deserializeDisplayParts(de, parts): Models.CommentDisplayPart[]

• Parameters

  • de: Deserializer
  • parts: JSONOutput.CommentDisplayPart[]

  Returns Models.CommentDisplayPart[]

Static displayPartsToMarkdown

• displayPartsToMarkdown(parts, urlTo): string

• Helper function to convert an array of comment display parts into markdown suitable for passing into Marked. urlTo will be used to resolve urls to any reflections linked to with @link tags.

  Parameters

  • parts: readonly Models.CommentDisplayPart[]
  • urlTo: ((ref) => string)
    • • (ref): string

      • Parameters

        • ref: Models.Reflection

        Returns string

  Returns string

Static serializeDisplayParts

• serializeDisplayParts(serializer, parts): JSONOutput.CommentDisplayPart[]

• Parameters

  • serializer: Serializer
  • parts: Models.CommentDisplayPart[]

  Returns JSONOutput.CommentDisplayPart[]

Static splitPartsToHeaderAndBody

• splitPartsToHeaderAndBody(parts): {
      body: Models.CommentDisplayPart[];
      header: string;
  }

• Splits the provided parts into a header (first line, as a string) and body (remaining lines). If the header line contains inline tags they will be serialized to a string.

  Parameters

  • parts: readonly Models.CommentDisplayPart[]

  Returns {
      body: Models.CommentDisplayPart[];
      header: string;
  }

  • body: Models.CommentDisplayPart[]

  • header: string