Class Comment

A model that represents a comment.

Instances of this model are created by the CommentPlugin. You can retrieve comments through the comment property.

Hierarchy

Comment

Index

Constructors

Properties

blockTags modifierTags summary

Methods

clone getIdentifiedTag getTag getTags hasModifier hasVisibleComponent isEmpty removeModifier removeTags toObject cloneDisplayParts combineDisplayParts

Constructors

constructor

new Comment(summary?: CommentDisplayPart[], blockTags?: CommentTag[], modifierTags?: Set<string>): Comment

Creates a new Comment instance.
Parameters
- summary: CommentDisplayPart[] = []
- blockTags: CommentTag[] = []
- modifierTags: Set<string> = ...
Returns Comment

Properties

blockTags

blockTags: CommentTag[] = []

All associated block level tags.

modifierTags

modifierTags: Set<string> = ...

All modifier tags present on the comment, e.g. @alpha, @beta.

summary

summary: CommentDisplayPart[]

The content of the comment which is not associated with a block tag.

Methods

clone

clone(): Comment

Create a deep clone of this comment.

Returns Comment

getIdentifiedTag

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

Parameters
- identifier: string
- tagName: `@${string}`
Returns undefined | CommentTag

getTag

getTag(tagName: `@${string}`): undefined | CommentTag

Return the first tag with the given name.

Returns
The found tag or undefined.
Parameters
- tagName: `@${string}`
  
  The name of the tag to look for.
Returns undefined | CommentTag

getTags

getTags(tagName: `@${string}`): CommentTag[]

Get all tags with the given tag name.
Parameters
- tagName: `@${string}`
Returns CommentTag[]

hasModifier

hasModifier(tagName: `@${string}`): boolean

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

Returns
TRUE when this comment contains a tag with the given name, otherwise FALSE.
Parameters
- tagName: `@${string}`
  
  The name of the tag to look for.
Returns boolean

hasVisibleComponent

hasVisibleComponent(): boolean

Has this comment a visible component?

Returns
TRUE when this comment has a visible component.

Returns boolean

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

toObject

toObject(serializer: Serializer): JSONOutput.Comment

Parameters
- serializer: Serializer
Returns JSONOutput.Comment

`Static` cloneDisplayParts

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

Helper utility to clone summary or content
Parameters
- parts: CommentDisplayPart[]
Returns ({ kind: "text"; text: string } | { kind: "code"; text: string } | { kind: "inline-tag"; tag: `@${string}`; target?: string | Reflection; text: string })[]

`Static` combineDisplayParts

combineDisplayParts(parts: undefined | readonly 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 CommentDisplayPart[]
Returns string

Generated using TypeDoc