Skip to content

Commit 7ecb3a3

Browse files
committed
add jsdoc for microsoft#77728
1 parent b6d859d commit 7ecb3a3

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

src/vs/vscode.proposed.d.ts

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1464,10 +1464,31 @@ declare module 'vscode' {
14641464

14651465
//#region https://github.com/microsoft/vscode/issues/77728
14661466

1467+
/**
1468+
* Additional data for entries of a workspace edit. Supports to label entries and marks entries
1469+
* as needing confirmation by the user. The editor groups edits with equal labels into tree nodes,
1470+
* for instance all edits labelled with "Changes in Strings" would be a tree node.
1471+
*/
14671472
export interface WorkspaceEditMetadata {
1473+
1474+
/**
1475+
* A flag which indicates that user confirmation is needed.
1476+
*/
14681477
needsConfirmation: boolean;
1478+
1479+
/**
1480+
* A human-readable string which is rendered prominent.
1481+
*/
14691482
label: string;
1483+
1484+
/**
1485+
* A human-readable string which is rendered less prominent in the same line.
1486+
*/
14701487
description?: string;
1488+
1489+
/**
1490+
* The icon path or [ThemeIcon](#ThemeIcon) for the edit.
1491+
*/
14711492
iconPath?: Uri | { light: Uri; dark: Uri } | ThemeIcon;
14721493
}
14731494

0 commit comments

Comments
 (0)