From f9db59cc7559d13914d429c1b7f2c3c6c0632b44 Mon Sep 17 00:00:00 2001 From: rebornix Date: Mon, 19 Apr 2021 08:49:06 -0700 Subject: [PATCH] update jsdocs. --- src/vs/vscode.proposed.d.ts | 27 +++++++++++++++++++++++---- 1 file changed, 23 insertions(+), 4 deletions(-) diff --git a/src/vs/vscode.proposed.d.ts b/src/vs/vscode.proposed.d.ts index 944c07042f1..522eb59249f 100644 --- a/src/vs/vscode.proposed.d.ts +++ b/src/vs/vscode.proposed.d.ts @@ -1229,6 +1229,12 @@ declare module 'vscode' { */ readonly visibleRanges: NotebookRange[]; + /** + * Scroll as indicated by `revealType` in order to reveal the given range. + * + * @param range A range. + * @param revealType The scrolling strategy for revealing `range`. + */ revealRange(range: NotebookRange, revealType?: NotebookEditorRevealType): void; /** @@ -1238,6 +1244,9 @@ declare module 'vscode' { } export interface NotebookDocumentMetadataChangeEvent { + /** + * The [notebook document](#NotebookDocument) for which the document metadata have changed. + */ readonly document: NotebookDocument; } @@ -1252,39 +1261,49 @@ declare module 'vscode' { } export interface NotebookCellsChangeEvent { - /** - * The affected document. + * The [notebook document](#NotebookDocument) for which the cells have changed. */ readonly document: NotebookDocument; readonly changes: ReadonlyArray; } export interface NotebookCellOutputsChangeEvent { - /** - * The affected document. + * The [notebook document](#NotebookDocument) for which the cell outputs have changed. */ readonly document: NotebookDocument; readonly cells: NotebookCell[]; } export interface NotebookCellMetadataChangeEvent { + /** + * The [notebook document](#NotebookDocument) for which the cell metadata have changed. + */ readonly document: NotebookDocument; readonly cell: NotebookCell; } export interface NotebookEditorSelectionChangeEvent { + /** + * The [notebook editor](#NotebookEditor) for which the selections have changed. + */ readonly notebookEditor: NotebookEditor; readonly selections: ReadonlyArray } export interface NotebookEditorVisibleRangesChangeEvent { + /** + * The [notebook editor](#NotebookEditor) for which the visible ranges have changed. + */ readonly notebookEditor: NotebookEditor; readonly visibleRanges: ReadonlyArray; } export interface NotebookCellExecutionStateChangeEvent { + /** + * The [notebook document](#NotebookDocument) for which the cell execution state has changed. + */ readonly document: NotebookDocument; readonly cell: NotebookCell; readonly executionState: NotebookCellExecutionState; -- GitLab