dots.vscode.comment
A comment is displayed within the editor or the Comments Panel, depending on how it is provided.
A comment is displayed within the editor or the Comments Panel, depending on how it is provided.
authorcljs
(author comment)The {@link CommentAuthorInformation author information} of the comment
Returns: CommentAuthorInformation
The {@link CommentAuthorInformation author information} of the comment
**Returns:** `CommentAuthorInformation`bodycljs
(body comment)The human-readable comment body
Returns: string | MarkdownString
The human-readable comment body **Returns:** `string | MarkdownString`
context-valuecljs
(context-value comment)Context value of the comment. This can be used to contribute comment specific actions.
For example, a comment is given a context value as editable. When contributing actions to comments/comment/title
using menus extension point, you can specify context value for key comment in when expression like comment == editable.
"contributes": {
"menus": {
"comments/comment/title": [
{
"command": "extension.deleteComment",
"when": "comment == editable"
}
]
}
}
This will show action extension.deleteComment only for comments with contextValue is editable.
Returns: string | undefined
Context value of the comment. This can be used to contribute comment specific actions.
For example, a comment is given a context value as `editable`. When contributing actions to `comments/comment/title`
using `menus` extension point, you can specify context value for key `comment` in `when` expression like `comment == editable`.
```json
"contributes": {
"menus": {
"comments/comment/title": [
{
"command": "extension.deleteComment",
"when": "comment == editable"
}
]
}
}
```
This will show action `extension.deleteComment` only for comments with `contextValue` is `editable`.
**Returns:** `string | undefined`labelcljs
(label comment)Optional label describing the {@link Comment } Label will be rendered next to authorName if exists.
Returns: string | undefined
Optional label describing the {@link Comment }
Label will be rendered next to authorName if exists.
**Returns:** `string | undefined`modecljs
(mode comment){@link CommentMode Comment mode} of the comment
Returns: CommentMode
{@link CommentMode Comment mode} of the comment
**Returns:** `CommentMode`reactionscljs
(reactions comment)Optional reactions of the {@link Comment }
Returns: CommentReaction[] | undefined
Optional reactions of the {@link Comment }
**Returns:** `CommentReaction[] | undefined`set-author!cljs
(set-author! comment value)The {@link CommentAuthorInformation author information} of the comment
The {@link CommentAuthorInformation author information} of the comment
set-body!cljs
(set-body! comment value)The human-readable comment body
The human-readable comment body
set-context-value!cljs
(set-context-value! comment value)Context value of the comment. This can be used to contribute comment specific actions.
For example, a comment is given a context value as editable. When contributing actions to comments/comment/title
using menus extension point, you can specify context value for key comment in when expression like comment == editable.
"contributes": {
"menus": {
"comments/comment/title": [
{
"command": "extension.deleteComment",
"when": "comment == editable"
}
]
}
}
This will show action extension.deleteComment only for comments with contextValue is editable.
Context value of the comment. This can be used to contribute comment specific actions.
For example, a comment is given a context value as `editable`. When contributing actions to `comments/comment/title`
using `menus` extension point, you can specify context value for key `comment` in `when` expression like `comment == editable`.
```json
"contributes": {
"menus": {
"comments/comment/title": [
{
"command": "extension.deleteComment",
"when": "comment == editable"
}
]
}
}
```
This will show action `extension.deleteComment` only for comments with `contextValue` is `editable`.set-label!cljs
(set-label! comment value)Optional label describing the {@link Comment } Label will be rendered next to authorName if exists.
Optional label describing the {@link Comment }
Label will be rendered next to authorName if exists.set-mode!cljs
(set-mode! comment value){@link CommentMode Comment mode} of the comment
{@link CommentMode Comment mode} of the comment
set-reactions!cljs
(set-reactions! comment value)Optional reactions of the {@link Comment }
Optional reactions of the {@link Comment }
set-timestamp!cljs
(set-timestamp! comment value)Optional timestamp that will be displayed in comments. The date will be formatted according to the user's locale and settings.
Optional timestamp that will be displayed in comments. The date will be formatted according to the user's locale and settings.
timestampcljs
(timestamp comment)Optional timestamp that will be displayed in comments. The date will be formatted according to the user's locale and settings.
Returns: Date | undefined
Optional timestamp that will be displayed in comments. The date will be formatted according to the user's locale and settings. **Returns:** `Date | undefined`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close