提交 ae9ec879 编写于 作者: A Andre Weinand

reword debug API comments

上级 4b79df84
...@@ -588,18 +588,20 @@ declare module 'vscode' { ...@@ -588,18 +588,20 @@ declare module 'vscode' {
* A DebugSource is an opaque stand-in type for the [Source](https://microsoft.github.io/debug-adapter-protocol/specification#Types_Source) type defined in the Debug Adapter Protocol. * A DebugSource is an opaque stand-in type for the [Source](https://microsoft.github.io/debug-adapter-protocol/specification#Types_Source) type defined in the Debug Adapter Protocol.
*/ */
export interface DebugSource { export interface DebugSource {
// opaque contents // Properties: see details [here](https://microsoft.github.io/debug-adapter-protocol/specification#Types_Source).
} }
export namespace debug { export namespace debug {
/** /**
* Converts a "Source" object received via the Debug Adapter Protocol into a Uri that can be used to load its contents. * Converts a "Source" descriptor object received via the Debug Adapter Protocol into a Uri that can be used to load its contents.
* If the source descriptor is based on a path, a file Uri is returned.
* If the source descriptor uses a reference number, a specific debug Uri (scheme 'debug') is constructed that requires a corresponding VS Code ContentProvider and a running debug session
* *
* If the "Source" object has insufficient information to create a uri, an error is thrown. * If the "Source" descriptor has insufficient information for creating the Uri, an error is thrown.
* *
* @param source An object conforming to the [Source](https://microsoft.github.io/debug-adapter-protocol/specification#Types_Source) type defined in the Debug Adapter Protocol. * @param source An object conforming to the [Source](https://microsoft.github.io/debug-adapter-protocol/specification#Types_Source) type defined in the Debug Adapter Protocol.
* @param session An optional debug session that will be used to locate the Debug Adapter Protocol. * @param session An optional debug session that will be used when the source descriptor uses a reference number to load the contents from an active debug session.
* @return A uri that can be used to load the contents of the source. * @return A uri that can be used to load the contents of the source.
*/ */
export function asDebugSourceUri(source: DebugSource, session?: DebugSession): Uri; export function asDebugSourceUri(source: DebugSource, session?: DebugSession): Uri;
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册