maxmustermann/vscode
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

#57186 - add API comments

Browse source
This commit is contained in:
Rob Lourens 2018-08-25 13:10:32 -07:00
parent 8f130e0119
commit 3d28155dfd
1 changed files with 24 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
src/vs/vscode.proposed.d.ts vendored
View file

@ -77,9 +77,23 @@ declare module 'vscode' {
followSymlinks: boolean;
}
/**
* Options to specify the size of the result text preview.
*/
export interface TextSearchPreviewOptions {
/**
* The maximum number of lines in the preview.
*/
maxLines: number;
/**
* The maximum number of characters included before the start of the match.
*/
leadingChars: number;
/**
* The maximum number of characters included per line.
*/
totalChars: number;
}
@ -92,6 +106,9 @@ declare module 'vscode' {
*/
maxResults: number;
/**
* Options to specify the size of the result text preview.
*/
previewOptions?: TextSearchPreviewOptions;
/**
@ -131,6 +148,9 @@ declare module 'vscode' {
*/
export interface FileIndexOptions extends SearchOptions { }
/**
* A preview of the text result.
*/
export interface TextSearchResultPreview {
/**
* The matching line of text, or a portion of the matching line that contains the match.
@ -159,7 +179,7 @@ declare module 'vscode' {
range: Range;
/**
* A preview of the matching line
* A preview of the text result.
*/
preview: TextSearchResultPreview;
}
@ -261,6 +281,9 @@ declare module 'vscode' {
*/
encoding?: string;
/**
* Options to specify the size of the result text preview.
*/
previewOptions?: TextSearchPreviewOptions;
}