Skip to content

Commit 82349e6

Browse files
committed
Add missing documentation
1 parent bc0c9c8 commit 82349e6

1 file changed

Lines changed: 12 additions & 2 deletions

File tree

src/vs/vscode.proposed.d.ts

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1337,10 +1337,9 @@ declare module 'vscode' {
13371337
}
13381338

13391339
/**
1340-
* Provider for custom editors that use a custom document model.
1340+
* Provider for readonly custom editors that use a custom document model.
13411341
*
13421342
* Custom editors use [`CustomDocument`](#CustomDocument) as their document model instead of a [`TextDocument`](#TextDocument).
1343-
* This gives extensions full control over actions such as edit, save, and backup.
13441343
*
13451344
* You should use this type of custom editor when dealing with binary files or more complex scenarios. For simple
13461345
* text based documents, use [`CustomTextEditorProvider`](#CustomTextEditorProvider) instead.
@@ -1383,6 +1382,17 @@ declare module 'vscode' {
13831382
resolveCustomEditor(document: T, webviewPanel: WebviewPanel, token: CancellationToken): Thenable<void> | void;
13841383
}
13851384

1385+
/**
1386+
* Provider for editiable custom editors that use a custom document model.
1387+
*
1388+
* Custom editors use [`CustomDocument`](#CustomDocument) as their document model instead of a [`TextDocument`](#TextDocument).
1389+
* This gives extensions full control over actions such as edit, save, and backup.
1390+
*
1391+
* You should use this type of custom editor when dealing with binary files or more complex scenarios. For simple
1392+
* text based documents, use [`CustomTextEditorProvider`](#CustomTextEditorProvider) instead.
1393+
*
1394+
* @param T Type of the custom document returned by this provider.
1395+
*/
13861396
export interface CustomEditorProvider<T extends CustomDocument = CustomDocument> extends CustomReadonlyEditorProvider<T> {
13871397
/**
13881398
* Signal that an edit has occurred inside a custom editor.

0 commit comments

Comments
 (0)