Skip to content

Commit

Permalink
improve FoldingRangeKind spec (for microsoft#55686)
Browse files Browse the repository at this point in the history
  • Loading branch information
aeschli committed Aug 3, 2018
1 parent ce44d8b commit dea3960
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions src/vs/vscode.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3552,6 +3552,7 @@ declare module 'vscode' {
* [Region](#FoldingRangeKind.Region). The kind is used to categorize folding ranges and used by commands
* like 'Fold all comments'. See
* [FoldingRangeKind](#FoldingRangeKind) for an enumeration of all kinds.
* If not set, the range is originated from a syntax element.
*/
kind?: FoldingRangeKind;

Expand All @@ -3566,7 +3567,10 @@ declare module 'vscode' {
}

/**
* An enumeration of all folding range kinds. The kind is used to categorize folding ranges.
* An enumeration of specific folding range kinds. The kind is an optional field of a [FoldingRange](#FoldingRange)
* and is used to distinguish specific folding ranges such as ranges originated from comments. The kind is used by commands like
* `Fold all comments` or `Fold all regions`.
* If the kind is not set on the range, the range originated from a syntax element other than comments, imports or region markers.
*/
export enum FoldingRangeKind {
/**
Expand All @@ -3578,7 +3582,7 @@ declare module 'vscode' {
*/
Imports = 2,
/**
* Kind for folding range representing regions (for example a folding range marked by `#region` and `#endregion`).
* Kind for folding range representing regions originating from folding markers like `#region` and `#endregion`.
*/
Region = 3
}
Expand Down

0 comments on commit dea3960

Please sign in to comment.