From 1d4bed79e1084df3aff80eb90b2bc3c4a5e19141 Mon Sep 17 00:00:00 2001 From: Johannes Rieken Date: Mon, 21 Jan 2019 17:20:19 -0800 Subject: [PATCH] add some jsdoc #66741 --- src/vs/vscode.proposed.d.ts | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/src/vs/vscode.proposed.d.ts b/src/vs/vscode.proposed.d.ts index 4fce9d49e50..7da978be049 100644 --- a/src/vs/vscode.proposed.d.ts +++ b/src/vs/vscode.proposed.d.ts @@ -19,10 +19,18 @@ declare module 'vscode' { //#region Joh - vscode.open export namespace env { + /** + * Opens an *external* item, e.g. a http(s) or mailto-link, using the + * default application. * + * *Note* that [`showTextDocument`](#window.showTextDocument) is the right + * way to open a text document inside the editor, not this function. + * + * @param target The uri that should be opened. + * @returns A promise indicating if open was successful. */ - export function open(uri: Uri): Thenable; + export function open(target: Uri): Thenable; } //#endregion