Liking cljdoc? Tell your friends :D

dots.vscode.comment-controller

A comment controller is able to provide {@link CommentThread comments} support to the editor and provide users various ways to interact with comments.

A comment controller is able to provide {@link CommentThread comments} support to the editor and
provide users various ways to interact with comments.
raw docstring

commenting-range-providercljs

(commenting-range-provider comment-controller)

Optional commenting range provider. Provide a list {@link Range ranges} which support commenting to any given resource uri.

If not provided, users cannot leave any comments.

Optional commenting range provider. Provide a list {@link Range ranges} which support commenting to any given resource uri.

If not provided, users cannot leave any comments.
sourceraw docstring

create-comment-threadcljs

(create-comment-thread comment-controller uri range comments)

Create a {@link CommentThread comment thread}. The comment thread will be displayed in visible text editors (if the resource matches) and Comments Panel once created.

Parameters:

  • uri: Uri - The uri of the document the thread has been created on.
  • range: Range - The range the comment thread is located within the document.
  • comments: readonly Comment[] - The ordered comments of the thread.

Returns: CommentThread

Create a {@link CommentThread comment thread}. The comment thread will be displayed in visible text editors (if the resource matches)
and Comments Panel once created.

**Parameters:**
- `uri`: `Uri` - The uri of the document the thread has been created on.
- `range`: `Range` - The range the comment thread is located within the document.
- `comments`: `readonly Comment[]` - The ordered comments of the thread.

**Returns:** `CommentThread`
sourceraw docstring

disposecljs

(dispose comment-controller)

Dispose this comment controller.

Once disposed, all {@link CommentThread comment threads} created by this comment controller will also be removed from the editor and Comments Panel.

Returns: void

Dispose this comment controller.

Once disposed, all {@link CommentThread comment threads} created by this comment controller will also be removed from the editor
and Comments Panel.

**Returns:** `void`
sourceraw docstring

idcljs

(id comment-controller)

The id of this comment controller.

The id of this comment controller.
sourceraw docstring

labelcljs

(label comment-controller)

The human-readable label of this comment controller.

The human-readable label of this comment controller.
sourceraw docstring

optionscljs

(options comment-controller)

Comment controller options

Comment controller options
sourceraw docstring

reaction-handlercljs

(reaction-handler comment-controller)

Optional reaction handler for creating and deleting reactions on a {@link Comment }.

Optional reaction handler for creating and deleting reactions on a {@link Comment }.
sourceraw docstring

set-commenting-range-provider!cljs

(set-commenting-range-provider! comment-controller value)

Optional commenting range provider. Provide a list {@link Range ranges} which support commenting to any given resource uri.

If not provided, users cannot leave any comments.

Optional commenting range provider. Provide a list {@link Range ranges} which support commenting to any given resource uri.

If not provided, users cannot leave any comments.
sourceraw docstring

set-options!cljs

(set-options! comment-controller value)

Comment controller options

Comment controller options
sourceraw docstring

set-reaction-handler!cljs

(set-reaction-handler! comment-controller value)

Optional reaction handler for creating and deleting reactions on a {@link Comment }.

Optional reaction handler for creating and deleting reactions on a {@link Comment }.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close