Skip to content

Commit 56865d9

Browse files
author
Greg Van Liew
authored
Merge pull request microsoft#141679 from gregvanl/linkFixes
Use fully qualified names in @link
2 parents cab791b + 1a57cb8 commit 56865d9

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

src/vscode-dts/vscode.d.ts

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1645,7 +1645,7 @@ declare module 'vscode' {
16451645
export enum QuickPickItemKind {
16461646
/**
16471647
* When a {@link QuickPickItem} has a kind of {@link Separator}, the item is just a visual separator and does not represent a real item.
1648-
* The only property that applies is {@link label}. All other properties on {@link QuickPickItem} will be ignored and have no effect.
1648+
* The only property that applies is {@link QuickPickItem.label label }. All other properties on {@link QuickPickItem} will be ignored and have no effect.
16491649
*/
16501650
Separator = -1,
16511651
/**
@@ -5984,7 +5984,7 @@ declare module 'vscode' {
59845984

59855985
/**
59865986
* Assumes a {@link TerminalLocation} of editor and allows specifying a {@link ViewColumn} and
5987-
* {@link preserveFocus} property
5987+
* {@link TerminalEditorLocationOptions.preserveFocus preserveFocus } property
59885988
*/
59895989
export interface TerminalEditorLocationOptions {
59905990
/**
@@ -7688,7 +7688,7 @@ declare module 'vscode' {
76887688
/**
76897689
* Controls whether forms are enabled in the webview content or not.
76907690
*
7691-
* Defaults to true if {@link enableScripts scripts are enabled}. Otherwise defaults to false.
7691+
* Defaults to true if {@link WebViewOptions.enableScripts scripts are enabled}. Otherwise defaults to false.
76927692
* Explicitly setting this property to either true or false overrides the default.
76937693
*/
76947694
readonly enableForms?: boolean;
@@ -8868,7 +8868,7 @@ declare module 'vscode' {
88688868
/**
88698869
* A short-hand for `openTextDocument(uri).then(document => showTextDocument(document, options))`.
88708870
*
8871-
* @see {@link openTextDocument}
8871+
* @see {@link workspace.openTextDocument}
88728872
*
88738873
* @param uri A resource identifier.
88748874
* @param options {@link TextDocumentShowOptions Editor options} to configure the behavior of showing the {@link TextEditor editor}.
@@ -9304,7 +9304,7 @@ declare module 'vscode' {
93049304
* Registers a webview panel serializer.
93059305
*
93069306
* Extensions that support reviving should have an `"onWebviewPanel:viewType"` activation event and
9307-
* make sure that {@link registerWebviewPanelSerializer} is called during activation.
9307+
* make sure that `registerWebviewPanelSerializer` is called during activation.
93089308
*
93099309
* Only a single serializer may be registered at a time for a given `viewType`.
93109310
*
@@ -11177,7 +11177,7 @@ declare module 'vscode' {
1117711177
/**
1117811178
* A short-hand for `openTextDocument(Uri.file(fileName))`.
1117911179
*
11180-
* @see {@link openTextDocument}
11180+
* @see {@link workspace.openTextDocument}
1118111181
* @param fileName A name of a file on disk.
1118211182
* @return A promise that resolves to a {@link TextDocument document}.
1118311183
*/
@@ -11281,7 +11281,7 @@ declare module 'vscode' {
1128111281
* Open an untitled notebook. The editor will prompt the user for a file
1128211282
* path when the document is to be saved.
1128311283
*
11284-
* @see {@link openNotebookDocument}
11284+
* @see {@link workspace.openNotebookDocument}
1128511285
* @param notebookType The notebook type that should be used.
1128611286
* @param content The initial contents of the notebook.
1128711287
* @returns A promise that resolves to a {@link NotebookDocument notebook}.
@@ -14140,7 +14140,7 @@ declare module 'vscode' {
1414014140
*
1414114141
* Defaults to false.
1414214142
*
14143-
* Note: you cannot use this option with {@link silent}.
14143+
* Note: you cannot use this option with {@link AuthenticationGetSessionOptions.silent silent}.
1414414144
*/
1414514145
createIfNone?: boolean;
1414614146

@@ -14162,7 +14162,7 @@ declare module 'vscode' {
1416214162
*
1416314163
* Defaults to false.
1416414164
*
14165-
* Note: you cannot use this option with any other options that prompt the user like {@link createIfNone}.
14165+
* Note: you cannot use this option with any other options that prompt the user like {@link AuthenticationGetSessionOptions.createIfNone createIfNone}.
1416614166
*/
1416714167
silent?: boolean;
1416814168
}
@@ -14510,7 +14510,7 @@ declare module 'vscode' {
1451014510
* the function returns or the returned thenable resolves.
1451114511
*
1451214512
* @param item An unresolved test item for which children are being
14513-
* requested, or `undefined` to resolve the controller's initial {@link items}.
14513+
* requested, or `undefined` to resolve the controller's initial {@link TestController.items items}.
1451414514
*/
1451514515
resolveHandler?: (item: TestItem | undefined) => Thenable<void> | void;
1451614516

@@ -14560,7 +14560,7 @@ declare module 'vscode' {
1456014560
* A TestRunRequest is a precursor to a {@link TestRun}, which in turn is
1456114561
* created by passing a request to {@link tests.runTests}. The TestRunRequest
1456214562
* contains information about which tests should be run, which should not be
14563-
* run, and how they are run (via the {@link profile}).
14563+
* run, and how they are run (via the {@link TestRunRequest.profile profile}).
1456414564
*
1456514565
* In general, TestRunRequests are created by the editor and pass to
1456614566
* {@link TestRunProfile.runHandler}, however you can also create test
@@ -14762,7 +14762,7 @@ declare module 'vscode' {
1476214762
/**
1476314763
* The parent of this item. It's set automatically, and is undefined
1476414764
* top-level items in the {@link TestController.items} and for items that
14765-
* aren't yet included in another item's {@link children}.
14765+
* aren't yet included in another item's {@link TestItem.children children}.
1476614766
*/
1476714767
readonly parent: TestItem | undefined;
1476814768

@@ -14802,7 +14802,7 @@ declare module 'vscode' {
1480214802
description?: string;
1480314803

1480414804
/**
14805-
* Location of the test item in its {@link uri}.
14805+
* Location of the test item in its {@link TestItem.uri uri}.
1480614806
*
1480714807
* This is only meaningful if the `uri` points to a file.
1480814808
*/
@@ -14828,12 +14828,12 @@ declare module 'vscode' {
1482814828
message: string | MarkdownString;
1482914829

1483014830
/**
14831-
* Expected test output. If given with {@link actualOutput}, a diff view will be shown.
14831+
* Expected test output. If given with {@link TestMessage.actualOutput actualOutput }, a diff view will be shown.
1483214832
*/
1483314833
expectedOutput?: string;
1483414834

1483514835
/**
14836-
* Actual test output. If given with {@link expectedOutput}, a diff view will be shown.
14836+
* Actual test output. If given with {@link TestMessage.expectedOutput expectedOutput }, a diff view will be shown.
1483714837
*/
1483814838
actualOutput?: string;
1483914839

0 commit comments

Comments
 (0)