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

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
- Defined in src/lib/models/comments/comment.ts:208

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
- Defined in src/lib/models/comments/comment.ts:221

getIdentifiedTag

getIdentifiedTag(identifier: string, tagName: `@${string}`): undefined | CommentTag
Parameters
- identifier: string
- tagName: `@${string}`
Returns undefined | CommentTag
- Defined in src/lib/models/comments/comment.ts:281

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
- Defined in src/lib/models/comments/comment.ts:270

getTags

getTags(tagName: `@${string}`): CommentTag[]
Get all tags with the given tag name.
Parameters
- tagName: `@${string}`
Returns CommentTag[]
- Defined in src/lib/models/comments/comment.ts:277

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
- Defined in src/lib/models/comments/comment.ts:255

hasVisibleComponent

hasVisibleComponent(): boolean
Has this comment a visible component?

Returns
TRUE when this comment has a visible component.

Returns boolean
- Defined in src/lib/models/comments/comment.ts:242

isEmpty

isEmpty(): boolean
Internal
Returns true if this comment is completely empty.

Returns boolean
- Defined in src/lib/models/comments/comment.ts:233

removeModifier

removeModifier(tagName: `@${string}`): void
Parameters
- tagName: `@${string}`
Returns void
- Defined in src/lib/models/comments/comment.ts:259

removeTags

removeTags(tagName: `@${string}`): void
Removes all block tags with the given tag name from the comment.
Parameters
- tagName: `@${string}`
Returns void
- Defined in src/lib/models/comments/comment.ts:291

toObject

toObject(serializer: Serializer): JSONOutput.Comment
Parameters
- serializer: Serializer
Returns JSONOutput.Comment
- Defined in src/lib/models/comments/comment.ts:295

`Static` cloneDisplayParts

cloneDisplayParts(parts: CommentDisplayPart[]): ({
    kind: "text";
    text: string;
} | {
    kind: "code";
    text: string;
} | {
    kind: "inline-tag";
    tag: `@${string}`;
    text: string;
    target?: string | Reflection;
})[]
Helper utility to clone summary or content
Parameters
- parts: CommentDisplayPart[]
Returns ({
    kind: "text";
    text: string;
} | {
    kind: "code";
    text: string;
} | {
    kind: "inline-tag";
    tag: `@${string}`;
    text: string;
    target?: string | Reflection;
})[]
- Defined in src/lib/models/comments/comment.ts:186

`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
- Defined in src/lib/models/comments/comment.ts:102

`Static` displayPartsToMarkdown

displayPartsToMarkdown(parts: readonly CommentDisplayPart[], urlTo: ((ref: Reflection) => string)): 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 CommentDisplayPart[]
- urlTo: ((ref: Reflection) => string)
  - - (ref: Reflection): string
    - Parameters
      
      ref: Reflection
      
      Returns string
Returns string
- Defined in src/lib/models/comments/comment.ts:129

Class Comment

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

summary: CommentDisplayPart[] = []

blockTags: CommentTag[] = []

modifierTags: Set<string> = ...

Returns Comment

Properties

blockTags

modifierTags

summary

Methods

clone

Returns Comment

getIdentifiedTag

Parameters

identifier: string

tagName: `@${string}`

Returns undefined | CommentTag

getTag

Returns

Parameters

tagName: `@${string}`

Returns undefined | CommentTag

getTags

Parameters

tagName: `@${string}`

Returns CommentTag[]

hasModifier

Returns

Parameters

tagName: `@${string}`

Returns boolean

hasVisibleComponent

Returns

Returns boolean

isEmpty

Returns boolean

removeModifier

Parameters

tagName: `@${string}`

Returns void

removeTags

Parameters

tagName: `@${string}`

Returns void

toObject

Parameters

serializer: Serializer

Returns JSONOutput.Comment

Static cloneDisplayParts

Parameters

parts: CommentDisplayPart[]

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

Static combineDisplayParts

Parameters

parts: undefined | readonly CommentDisplayPart[]

Returns string

Static displayPartsToMarkdown

Parameters

parts: readonly CommentDisplayPart[]

urlTo: ((ref: Reflection) => string)

Parameters

ref: Reflection

Returns string

Returns string

Settings

Member Visibility

Theme

`Static` cloneDisplayParts

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

`Static` combineDisplayParts

`Static` displayPartsToMarkdown