6
6
import * as vscode from 'vscode' ;
7
7
8
8
/**
9
- * This interface describes the shape for the references viewlet API. It consists
10
- * of a single `setInput` function which must be called with a full implementation
9
+ * This interface describes the shape for the references viewlet API. It consists
10
+ * of a single `setInput` function which must be called with a full implementation
11
11
* of the `SymbolTreeInput`-interface. To acquire this API use the default mechanics, e.g:
12
- *
12
+ *
13
13
* ```ts
14
14
* // get references viewlet API
15
- * const api = await vscode.extensions.getExtension<SymbolTree>('ms- vscode.references-view').activate();
16
- *
15
+ * const api = await vscode.extensions.getExtension<SymbolTree>('vscode.references-view').activate();
16
+ *
17
17
* // instantiate and set input which updates the view
18
18
* const myInput: SymbolTreeInput<MyItems> = ...
19
19
* api.setInput(myInput)
@@ -22,16 +22,16 @@ import * as vscode from 'vscode';
22
22
export interface SymbolTree {
23
23
24
24
/**
25
- * Set the contents of the references viewlet.
26
- *
25
+ * Set the contents of the references viewlet.
26
+ *
27
27
* @param input A symbol tree input object
28
28
*/
29
29
setInput ( input : SymbolTreeInput < unknown > ) : void ;
30
30
}
31
31
32
32
/**
33
33
* A symbol tree input is the entry point for populating the references viewlet.
34
- * Inputs must be anchored at a code location, they must have a title, and they
34
+ * Inputs must be anchored at a code location, they must have a title, and they
35
35
* must resolve to a model.
36
36
*/
37
37
export interface SymbolTreeInput < T > {
@@ -54,17 +54,17 @@ export interface SymbolTreeInput<T> {
54
54
readonly location : vscode . Location ;
55
55
56
56
/**
57
- * Resolve this input to a model that contains the actual data. When there are no result
57
+ * Resolve this input to a model that contains the actual data. When there are no result
58
58
* than `undefined` or `null` should be returned.
59
59
*/
60
60
resolve ( ) : vscode . ProviderResult < SymbolTreeModel < T > > ;
61
61
62
62
/**
63
63
* This function is called when re-running from history. The symbols tree has tracked
64
- * the original location of this input and that is now passed to this input. The
64
+ * the original location of this input and that is now passed to this input. The
65
65
* implementation of this function should return a clone where the `location`-property
66
66
* uses the provided `location`
67
- *
67
+ *
68
68
* @param location The location at which the new input should be anchored.
69
69
* @returns A new input which location is anchored at the position.
70
70
*/
@@ -94,7 +94,7 @@ export interface SymbolTreeModel<T> {
94
94
navigation ?: SymbolItemNavigation < T > ;
95
95
96
96
/**
97
- * Optional support for editor highlights. WHen implemented, the editor will highlight
97
+ * Optional support for editor highlights. WHen implemented, the editor will highlight
98
98
* symbol ranges in the source code.
99
99
*/
100
100
highlights ?: SymbolItemEditorHighlights < T > ;
0 commit comments