Skip to content

Commit 077507d

Browse files
jriekenGeoffrey
authored and
Geoffrey
committed
some jsdoc for language status items, microsoft#129037
1 parent ad37d89 commit 077507d

File tree

1 file changed

+45
-2
lines changed

1 file changed

+45
-2
lines changed

src/vscode-dts/vscode.proposed.languageStatus.d.ts

+45-2
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,59 @@ declare module 'vscode' {
1414
}
1515

1616
interface LanguageStatusItem {
17+
18+
/**
19+
* The identifier of this item.
20+
*/
1721
readonly id: string;
22+
23+
/**
24+
* The short name of this item, like 'Java Language Status', etc.
25+
*/
26+
name: string | undefined;
27+
28+
/**
29+
* A {@link DocumentSelector selector} that defines for what documents
30+
* this item shows.
31+
*/
1832
selector: DocumentSelector;
33+
1934
// todo@jrieken replace with boolean ala needsAttention
2035
severity: LanguageStatusSeverity;
21-
busy: boolean;
22-
name: string | undefined;
36+
37+
/**
38+
* The text to show for the entry. You can embed icons in the text by leveraging the syntax:
39+
*
40+
* `My text $(icon-name) contains icons like $(icon-name) this one.`
41+
*
42+
* Where the icon-name is taken from the ThemeIcon [icon set](https://code.visualstudio.com/api/references/icons-in-labels#icon-listing), e.g.
43+
* `light-bulb`, `thumbsup`, `zap` etc.
44+
*/
2345
text: string;
46+
47+
/**
48+
* Optional, human-readable details for this item.
49+
*/
2450
detail?: string;
51+
52+
/**
53+
* Controls whether the item is shown as "busy". Defaults to `false`.
54+
*/
55+
busy: boolean;
56+
57+
/**
58+
* A {@linkcode Command command} for this item.
59+
*/
2560
command: Command | undefined;
61+
62+
/**
63+
* Accessibility information used when a screen reader interacts with this item
64+
*/
2665
accessibilityInformation?: AccessibilityInformation;
66+
67+
/**
68+
* Dispose and free associated resources.
69+
*/
2770
dispose(): void;
2871
}
2972

0 commit comments

Comments
 (0)