Skip to content

Commit 2511624

Browse files
committed
update protocol comments
1 parent 8bd4821 commit 2511624

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

src/server/protocol.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2006,7 +2006,10 @@ export interface QuickInfoRequest extends FileLocationRequest {
20062006
}
20072007

20082008
export interface QuickInfoRequestArgs extends FileLocationRequestArgs {
2009-
/** TODO */
2009+
/**
2010+
* This controls how many levels of definitions will be expanded in the quick info response.
2011+
* The default value is 0.
2012+
*/
20102013
verbosityLevel?: number;
20112014
}
20122015

@@ -2051,7 +2054,7 @@ export interface QuickInfoResponseBody {
20512054
tags: JSDocTagInfo[];
20522055

20532056
/**
2054-
* TODO
2057+
* Whether the verbosity level can be increased for this quick info response.
20552058
*/
20562059
canIncreaseVerbosityLevel?: boolean;
20572060
}

tests/baselines/reference/api/typescript.d.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1487,7 +1487,10 @@ declare namespace ts {
14871487
arguments: FileLocationRequestArgs;
14881488
}
14891489
export interface QuickInfoRequestArgs extends FileLocationRequestArgs {
1490-
/** TODO */
1490+
/**
1491+
* This controls how many levels of definitions will be expanded in the quick info response.
1492+
* The default value is 0.
1493+
*/
14911494
verbosityLevel?: number;
14921495
}
14931496
/**
@@ -1524,7 +1527,7 @@ declare namespace ts {
15241527
*/
15251528
tags: JSDocTagInfo[];
15261529
/**
1527-
* TODO
1530+
* Whether the verbosity level can be increased for this quick info response.
15281531
*/
15291532
canIncreaseVerbosityLevel?: boolean;
15301533
}

0 commit comments

Comments
 (0)