Skip to content

Commit dea3960

Browse files
committed
improve FoldingRangeKind spec (for #55686)
1 parent ce44d8b commit dea3960

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

src/vs/vscode.d.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3552,6 +3552,7 @@ declare module 'vscode' {
35523552
* [Region](#FoldingRangeKind.Region). The kind is used to categorize folding ranges and used by commands
35533553
* like 'Fold all comments'. See
35543554
* [FoldingRangeKind](#FoldingRangeKind) for an enumeration of all kinds.
3555+
* If not set, the range is originated from a syntax element.
35553556
*/
35563557
kind?: FoldingRangeKind;
35573558

@@ -3566,7 +3567,10 @@ declare module 'vscode' {
35663567
}
35673568

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

0 commit comments

Comments
 (0)