From a563e80b420bc01419bcc85484a4dad55d81df6b Mon Sep 17 00:00:00 2001 From: andreamah Date: Wed, 30 Oct 2024 10:38:10 -0700 Subject: [PATCH] search APIs- deep links to interface fields do not resolve Fixes #227478 --- .../services/search/common/searchExtTypes.ts | 6 +++--- .../vscode.proposed.fileSearchProvider2.d.ts | 4 ++-- src/vscode-dts/vscode.proposed.findFiles2.d.ts | 6 +++--- .../vscode.proposed.findTextInFiles2.d.ts | 16 ++++++++-------- .../vscode.proposed.textSearchProvider2.d.ts | 8 ++++---- 5 files changed, 20 insertions(+), 20 deletions(-) diff --git a/src/vs/workbench/services/search/common/searchExtTypes.ts b/src/vs/workbench/services/search/common/searchExtTypes.ts index fc785ae189b..decb405a400 100644 --- a/src/vs/workbench/services/search/common/searchExtTypes.ts +++ b/src/vs/workbench/services/search/common/searchExtTypes.ts @@ -152,11 +152,11 @@ export interface TextSearchProviderFolderOptions { */ local: boolean; /** - * Use ignore files at the parent directory. If set, {@link TextSearchProviderOptions.useIgnoreFiles.local} should also be `true`. + * Use ignore files at the parent directory. If set, `local` in {@link TextSearchProviderFolderOptions.useIgnoreFiles} should also be `true`. */ parent: boolean; /** - * Use global ignore files. If set, {@link TextSearchProviderOptions.useIgnoreFiles.local} should also be `true`. + * Use global ignore files. If set, `local` in {@link TextSearchProviderFolderOptions.useIgnoreFiles} should also be `true`. */ global: boolean; }; @@ -440,7 +440,7 @@ export interface TextSearchProvider2 { export interface TextSearchComplete2 { /** * Whether the search hit the limit on the maximum number of search results. - * `maxResults` on {@linkcode TextSearchOptions} specifies the max number of results. + * `maxResults` on {@link TextSearchOptions} specifies the max number of results. * - If exactly that number of matches exist, this should be false. * - If `maxResults` matches are returned and more exist, this should be true. * - If search hits an internal limit which is less than `maxResults`, this should be true. diff --git a/src/vscode-dts/vscode.proposed.fileSearchProvider2.d.ts b/src/vscode-dts/vscode.proposed.fileSearchProvider2.d.ts index e23123d376c..e986e8fbd57 100644 --- a/src/vscode-dts/vscode.proposed.fileSearchProvider2.d.ts +++ b/src/vscode-dts/vscode.proposed.fileSearchProvider2.d.ts @@ -42,11 +42,11 @@ declare module 'vscode' { */ local: boolean; /** - * Use ignore files at the parent directory. If set, {@link FileSearchProviderOptions.useIgnoreFiles.local} should also be `true`. + * Use ignore files at the parent directory. If set, `local` in {@link FileSearchProviderOptions.useIgnoreFiles} should also be `true`. */ parent: boolean; /** - * Use global ignore files. If set, {@link FileSearchProviderOptions.useIgnoreFiles.local} should also be `true`. + * Use global ignore files. If set, `local` in {@link FileSearchProviderOptions.useIgnoreFiles} should also be `true`. */ global: boolean; }; diff --git a/src/vscode-dts/vscode.proposed.findFiles2.d.ts b/src/vscode-dts/vscode.proposed.findFiles2.d.ts index 579ba732ac9..15a0c584cb0 100644 --- a/src/vscode-dts/vscode.proposed.findFiles2.d.ts +++ b/src/vscode-dts/vscode.proposed.findFiles2.d.ts @@ -9,8 +9,8 @@ declare module 'vscode' { export interface FindFiles2Options { /** - * An array of {@link GlobPattern GlobPattern} that defines files to exclude. - * The glob patterns will be matched against the file paths of files relative to their workspace or {@link RelativePattern.baseUri} if applicable. + * An array of {@link GlobPattern} that defines files to exclude. + * The glob patterns will be matched against the file paths of files relative to their workspace or {@link RelativePattern}'s `baseUri` if applicable. * * If more than one value is used, the values are combined with a logical AND. * For example, consider the following code: @@ -26,7 +26,7 @@ declare module 'vscode' { exclude?: GlobPattern[]; /** - * Which settings to follow when searching for files. Defaults to {@link ExcludeSettingOptions.searchAndFilesExclude}. + * Which settings to follow when searching for files. Defaults to `ExcludeSettingOptions.searchAndFilesExclude`. */ useExcludeSettings?: ExcludeSettingOptions; diff --git a/src/vscode-dts/vscode.proposed.findTextInFiles2.d.ts b/src/vscode-dts/vscode.proposed.findTextInFiles2.d.ts index 95a01a850f3..e62d23bfb7c 100644 --- a/src/vscode-dts/vscode.proposed.findTextInFiles2.d.ts +++ b/src/vscode-dts/vscode.proposed.findTextInFiles2.d.ts @@ -9,9 +9,9 @@ declare module 'vscode' { export interface FindTextInFilesOptions2 { /** - * An array of {@link GlobPattern GlobPattern} that defines the files to search for. - * The glob patterns will be matched against the file paths of files relative to their workspace or {@link baseUri GlobPattern.baseUri} if applicable. - * Use a {@link RelativePattern RelativePattern} to restrict the search results to a {@link WorkspaceFolder workspace folder}. + * An array of {@link GlobPattern} that defines the files to search for. + * The glob patterns will be matched against the file paths of files relative to their workspace or {@link GlobPattern}'s `baseUri` if applicable. + * Use a {@link RelativePattern} to restrict the search results to a {@link WorkspaceFolder workspace folder}. * * If more than one value is used, the values are combined with a logical OR. * @@ -28,8 +28,8 @@ declare module 'vscode' { include?: GlobPattern[]; /** - * An array of {@link GlobPattern GlobPattern} that defines files to exclude. - * The glob patterns will be matched against the file paths of files relative to their workspace or {@link RelativePattern.baseUri} if applicable. + * An array of {@link GlobPattern} that defines files to exclude. + * The glob patterns will be matched against the file paths of files relative to their workspace or {@link RelativePattern}'s `baseUri` if applicable. * * If more than one value is used, the values are combined with a logical AND. * For example, consider the following code: @@ -45,7 +45,7 @@ declare module 'vscode' { exclude?: GlobPattern[]; /** - * Which settings to follow when searching for files. Defaults to {@link ExcludeSettingOptions.searchAndFilesExclude}. + * Which settings to follow when searching for files. Defaults to `ExcludeSettingOptions.searchAndFilesExclude`. */ useExcludeSettings?: ExcludeSettingOptions; @@ -73,12 +73,12 @@ declare module 'vscode' { */ local?: boolean; /** - * Use ignore files at the parent directory. When set to `true`, {@link FindTextInFilesOptions2.useIgnoreFiles.local} must be `true`. + * Use ignore files at the parent directory. When set to `true`, `local` in {@link FindTextInFilesOptions2.useIgnoreFiles} must be `true`. * May default to `search.useParentIgnoreFiles` setting if not set. */ parent?: boolean; /** - * Use global ignore files. When set to `true`, {@link FindTextInFilesOptions2.useIgnoreFiles.local} must also be `true`. + * Use global ignore files. When set to `true`, `local` in {@link FindTextInFilesOptions2.useIgnoreFiles} must also be `true`. * May default to `search.useGlobalIgnoreFiles` setting if not set. */ global?: boolean; diff --git a/src/vscode-dts/vscode.proposed.textSearchProvider2.d.ts b/src/vscode-dts/vscode.proposed.textSearchProvider2.d.ts index 23d1ba018b5..c045956da9f 100644 --- a/src/vscode-dts/vscode.proposed.textSearchProvider2.d.ts +++ b/src/vscode-dts/vscode.proposed.textSearchProvider2.d.ts @@ -89,11 +89,11 @@ declare module 'vscode' { */ local: boolean; /** - * Use ignore files at the parent directory. If set, {@link TextSearchProviderOptions.useIgnoreFiles.local} should also be `true`. - */ + * Use ignore files at the parent directory. If set, `local` in {@link TextSearchProviderFolderOptions.useIgnoreFiles} should also be `true`. + */ parent: boolean; /** - * Use global ignore files. If set, {@link TextSearchProviderOptions.useIgnoreFiles.local} should also be `true`. + * Use global ignore files. If set, `local` in {@link TextSearchProviderFolderOptions.useIgnoreFiles} should also be `true`. */ global: boolean; }; @@ -145,7 +145,7 @@ declare module 'vscode' { export interface TextSearchComplete2 { /** * Whether the search hit the limit on the maximum number of search results. - * `maxResults` on {@linkcode TextSearchProviderOptions} specifies the max number of results. + * `maxResults` on {@link TextSearchProviderOptions} specifies the max number of results. * - If exactly that number of matches exist, this should be false. * - If `maxResults` matches are returned and more exist, this should be true. * - If search hits an internal limit which is less than `maxResults`, this should be true.