some jsdoc for language status items, https://github.com/microsoft/vscode/issues/129037
This commit is contained in:
parent
c67fd6e5cd
commit
d673cdb0ec
|
@ -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;
|
||||
}
|
||||
|
||||
|
|
Loading…
Reference in a new issue