From d673cdb0ecf1c760f22e0ba5530971e1d91a9d44 Mon Sep 17 00:00:00 2001 From: Johannes Rieken Date: Fri, 26 Nov 2021 12:20:00 +0100 Subject: [PATCH] some jsdoc for language status items, https://github.com/microsoft/vscode/issues/129037 --- .../vscode.proposed.languageStatus.d.ts | 47 ++++++++++++++++++- 1 file changed, 45 insertions(+), 2 deletions(-) diff --git a/src/vscode-dts/vscode.proposed.languageStatus.d.ts b/src/vscode-dts/vscode.proposed.languageStatus.d.ts index 9de4ed5309e..d39081e8202 100644 --- a/src/vscode-dts/vscode.proposed.languageStatus.d.ts +++ b/src/vscode-dts/vscode.proposed.languageStatus.d.ts @@ -14,16 +14,59 @@ declare module 'vscode' { } interface LanguageStatusItem { + + /** + * The identifier of this item. + */ readonly id: string; + + /** + * The short name of this item, like 'Java Language Status', etc. + */ + name: string | undefined; + + /** + * A {@link DocumentSelector selector} that defines for what documents + * this item shows. + */ selector: DocumentSelector; + // todo@jrieken replace with boolean ala needsAttention severity: LanguageStatusSeverity; - busy: boolean; - name: string | undefined; + + /** + * The text to show for the entry. You can embed icons in the text by leveraging the syntax: + * + * `My text $(icon-name) contains icons like $(icon-name) this one.` + * + * Where the icon-name is taken from the ThemeIcon [icon set](https://code.visualstudio.com/api/references/icons-in-labels#icon-listing), e.g. + * `light-bulb`, `thumbsup`, `zap` etc. + */ text: string; + + /** + * Optional, human-readable details for this item. + */ detail?: string; + + /** + * Controls whether the item is shown as "busy". Defaults to `false`. + */ + busy: boolean; + + /** + * A {@linkcode Command command} for this item. + */ command: Command | undefined; + + /** + * Accessibility information used when a screen reader interacts with this item + */ accessibilityInformation?: AccessibilityInformation; + + /** + * Dispose and free associated resources. + */ dispose(): void; }