Class Comment

constructor

• new Comment(
      summary?: Models.CommentDisplayPart[],
      blockTags?: Models.CommentTag[],
      modifierTags?: Set<`@${string}`>,
  ): Models.Comment

• Creates a new Comment instance.

  Parameters

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

  Returns Models.Comment

clone

• clone(): Models.Comment

• Create a deep clone of this comment.

  Returns Models.Comment

fromObject

• fromObject(de: Deserializer, obj: JSONOutput.Comment): void

• Parameters

  • de: Deserializer
  • obj: JSONOutput.Comment

  Returns void

getIdentifiedTag

• getIdentifiedTag(
      identifier: string,
      tagName: `@${string}`,
  ): undefined | Models.CommentTag

• Parameters

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

  Returns undefined | Models.CommentTag

getShortSummary

• getShortSummary(
      useFirstParagraph: boolean,
  ): readonly Models.CommentDisplayPart[]

• Gets either the @summary tag, or a short version of the comment summary section for rendering in module/namespace pages.

  Parameters

  • useFirstParagraph: boolean

  Returns readonly Models.CommentDisplayPart[]

getTag

• getTag(tagName: `@${string}`): 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: `@${string}`): Models.CommentTag[]

• Get all tags with the given tag name.

  Parameters

  • tagName: `@${string}`

  Returns Models.CommentTag[]

hasModifier

• hasModifier(tagName: `@${string}`): 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: `@${string}`): void

• Parameters

  • tagName: `@${string}`

  Returns void

removeTags

• removeTags(tagName: `@${string}`): void

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

  Parameters

  • tagName: `@${string}`

  Returns void

similarTo

• similarTo(other: Models.Comment): boolean

• Checks if this comment is roughly equal to the other comment. This isn't exactly equal, but just "roughly equal" by the comment text.

  Parameters

  • other: Models.Comment

  Returns boolean

toObject

• toObject(serializer: Serializer): JSONOutput.Comment

• Parameters

  • serializer: Serializer

  Returns JSONOutput.Comment

StaticcloneDisplayParts

• cloneDisplayParts(
      parts: readonly Models.CommentDisplayPart[],
  ): Models.CommentDisplayPart[]

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

  Parameters

  • parts: readonly Models.CommentDisplayPart[]

  Returns Models.CommentDisplayPart[]

StaticcombineDisplayParts

• combineDisplayParts(
      parts: undefined | readonly Models.CommentDisplayPart[],
  ): 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

StaticdeserializeDisplayParts

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

• Parameters

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

  Returns Models.CommentDisplayPart[]

StaticserializeDisplayParts

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

• Parameters

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

  Returns JSONOutput.CommentDisplayPart[]

StaticsplitPartsToHeaderAndBody

• splitPartsToHeaderAndBody(
      parts: readonly Models.CommentDisplayPart[],
  ): { 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 }

blockTags

modifierTags

summary

OptionalinheritedFromParentDeclaration

Optionallabel

OptionalsourcePath