development/vscode
development/vscode
1
0
Fork 0
mirror of https://github.com/Microsoft/vscode synced 2024-08-28 05:19:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

improve documentation for debug hover API; fxes #91404

Browse source
This commit is contained in:
Andre Weinand 2020-02-27 13:15:30 +01:00
parent f9b3974299
commit 4f232ba78f
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
src/vs/vscode.d.ts vendored
View file

@ -2495,16 +2495,18 @@ declare module 'vscode' {
/**
* The evaluatable expression provider interface defines the contract between extensions and
* the debug hover.
* the debug hover. In this contract the provider returns an evaluatable expression for a given position
* in a document and VS Code evaluates this expression in the active debug session and shows the result in a debug hover.
*/
export interface EvaluatableExpressionProvider {
/**
* Provide an evaluatable expression for the given document and position.
* VS Code will evaluate this expression in the active debug session and will show the result in the debug hover.
* The expression can be implicitly specified by the range in the underlying document or by explicitly returning an expression.
*
* @param document The document in which the debug hover is opened.
* @param position The position in the document where the debug hover is opened.
* @param document The document for which the debug hover is about to appear.
* @param position The line and character position in the document where the debug hover is about to appear.
* @param token A cancellation token.
* @return An EvaluatableExpression or a thenable that resolves to such. The lack of a result can be
* signaled by returning `undefined` or `null`.
@ -9174,6 +9176,7 @@ declare module 'vscode' {
/**
* Register a provider that locates evaluatable expressions in text documents.
* VS Code will evaluate the expression in the active debug session and will show the result in the debug hover.
*
* If multiple providers are registered for a language an arbitrary provider will be used.
*