pkg/analysis_server/doc/api.html - Issue 547753002: Rename debug domain to execution

Unified Diff: pkg/analysis_server/doc/api.html

Issue 547753002: Rename debug domain to execution (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart

Patch Set: Created 6 years, 3 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Download patch

« no previous file with comments | « editor/tools/plugins/com.google.dart.server/src/com/google/dart/server/generated/types/DebugService.java ('k') | pkg/analysis_server/lib/src/generated_protocol.dart » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: pkg/analysis_server/doc/api.html

diff --git a/pkg/analysis_server/doc/api.html b/pkg/analysis_server/doc/api.html

index bbd3400661059fe970f7815c1c3117a7e8db89df..e678a488b18e439dbf06ee5067e92783b82b6af9 100644

--- a/pkg/analysis_server/doc/api.html

+++ b/pkg/analysis_server/doc/api.html

@@ -152,7 +152,7 @@ dt.typeDefinition {

<li><a href="#domain_completion">Code Completion</a></li>

<li><a href="#domain_search">Search</a></li>

- <li><a href="#domain_debug">Debugging</a></li>

+ <li><a href="#domain_execution">Execution</a></li>

</ul>

<p>

The specifications of the API’s refer to data structures beyond

@@ -373,7 +373,7 @@ dt.typeDefinition {

which is not currently subject to analysis (e.g. because it

is not associated with any analysis root specified to

analysis.setAnalysisRoots), an error of type

- GET_ERRORS_INVALID_FILE will be generated.

+ <tt>GET_ERRORS_INVALID_FILE</tt> will be generated.

</p>

@@ -1380,14 +1380,7 @@ dt.typeDefinition {

</dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>fixes ( List<<a href="#type_AnalysisErrorFixes">AnalysisErrorFixes</a>> )</i></b></dt><dd>

<p>

- The fixes that are available for each of the analysis

- errors. There is a one-to-one correspondence between the

- analysis errors in the request and the lists of changes

- in the response. In particular, it is always the case

- that errors.length == fixes.length and that fixes[i] is

- the list of fixes for the error in errors[i]. The list

- of changes corresponding to an error can be empty if

- there are no fixes available for that error.

+ The fixes that are available for the errors at the given offset.

</p>

</dd></dl></dd><dt class="request">edit.getRefactoring</dt><dd><div class="box"><pre>request: {

"id": String

@@ -1490,19 +1483,19 @@ dt.typeDefinition {

potential edits for the refactoring.

</p>

</dd></dl></dd></dl>

- <h2 class="domain"><a name="domain_debug">Domain: debug</a></h2>

+ <h2 class="domain"><a name="domain_execution">Domain: execution</a></h2>

<p>

- The debugging domain contains commands related to providing a

- debugging experience.

+ The execution domain contains commands related to providing an execution

+ or debugging experience.

</p>

- <h3>Requests</h3><dl><dt class="request">debug.createContext</dt><dd><div class="box"><pre>request: {

+ <h3>Requests</h3><dl><dt class="request">execution.createContext</dt><dd><div class="box"><pre>request: {

"id": String

- "method": "debug.createContext"

+ "method": "execution.createContext"

"params": {

"<b>contextRoot</b>": <a href="#type_FilePath">FilePath</a>

}

@@ -1510,15 +1503,14 @@ dt.typeDefinition {

"<b>id</b>": String

"error": <span style="color:#999999">optional</span> <a href="#type_RequestError">RequestError</a>

"result": {

- "<b>id</b>": <a href="#type_DebugContextId">DebugContextId</a>

+ "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a>

}

}</pre></div>

<p>

- Create a debugging context for the executable file with the

- given path. The context that is created will persist until

- debug.deleteContext is used to delete it. Clients,

- therefore, are responsible for managing the lifetime of

- debugging contexts.

+ Create an execution context for the executable file with the given

+ path. The context that is created will persist until

+ execution.deleteContext is used to delete it. Clients, therefore, are

+ responsible for managing the lifetime of execution contexts.

</p>

@@ -1527,39 +1519,38 @@ dt.typeDefinition {

<p>

The path of the Dart or HTML file that will be launched.

</p>

- </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <a href="#type_DebugContextId">DebugContextId</a> )</i></b></dt><dd>

+ </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <a href="#type_ExecutionContextId">ExecutionContextId</a> )</i></b></dt><dd>

<p>

- The identifier used to refer to the debugging context

- that was created.

+ The identifier used to refer to the execution context that was

+ created.

</p>

- </dd></dl></dd><dt class="request">debug.deleteContext</dt><dd><div class="box"><pre>request: {

+ </dd></dl></dd><dt class="request">execution.deleteContext</dt><dd><div class="box"><pre>request: {

"<b>id</b>": String

- "method": "debug.deleteContext"

+ "method": "execution.deleteContext"

"params": {

- "<b>id</b>": <a href="#type_DebugContextId">DebugContextId</a>

+ "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a>

}

}</pre><br><pre>response: {

"id": String

"error": <span style="color:#999999">optional</span> <a href="#type_RequestError">RequestError</a>

}</pre></div>

<p>

- Delete the debugging context with the given identifier. The

- context id is no longer valid after this command. The server

- is allowed to re-use ids when they are no longer valid.

+ Delete the execution context with the given identifier. The context id

+ is no longer valid after this command. The server is allowed to re-use

+ ids when they are no longer valid.

</p>

- <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_DebugContextId">DebugContextId</a> )</i></b></dt><dd>

+ <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_ExecutionContextId">ExecutionContextId</a> )</i></b></dt><dd>

<p>

- The identifier of the debugging context that is to be

- deleted.

+ The identifier of the execution context that is to be deleted.

</p>

- </dd></dl></dd><dt class="request">debug.mapUri</dt><dd><div class="box"><pre>request: {

+ </dd></dl></dd><dt class="request">execution.mapUri</dt><dd><div class="box"><pre>request: {

"<b>id</b>": String

- "method": "debug.mapUri"

+ "method": "execution.mapUri"

"params": {

- "<b>id</b>": <a href="#type_DebugContextId">DebugContextId</a>

+ "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a>

"<b>file</b>": <span style="color:#999999">optional</span> <a href="#type_FilePath">FilePath</a>

"<b>uri</b>": <span style="color:#999999">optional</span> String

}

@@ -1572,20 +1563,20 @@ dt.typeDefinition {

}

}</pre></div>

<p>

- Map a URI from the debugging context to the file that it

- corresponds to, or map a file to the URI that it corresponds

- to in the debugging context.

+ Map a URI from the execution context to the file that it corresponds

+ to, or map a file to the URI that it corresponds to in the execution

+ context.

</p>

<p>

Exactly one of the file and uri fields must be provided.

</p>

- <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_DebugContextId">DebugContextId</a> )</i></b></dt><dd>

+ <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_ExecutionContextId">ExecutionContextId</a> )</i></b></dt><dd>

<p>

- The identifier of the debugging context in which the URI

- is to be mapped.

+ The identifier of the execution context in which the URI is to be

+ mapped.

</p>

</dd><dt class="field"><b><i>file ( <span style="color:#999999">optional</span> <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd>

@@ -1600,42 +1591,42 @@ dt.typeDefinition {

</dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>file ( <span style="color:#999999">optional</span> <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd>

<p>

- The file to which the URI was mapped. This field is

- omitted if the uri field was not given in the request.

+ The file to which the URI was mapped. This field is omitted if the

+ uri field was not given in the request.

</p>

</dd><dt class="field"><b><i>uri ( <span style="color:#999999">optional</span> String )</i></b></dt><dd>

<p>

- The URI to which the file path was mapped. This field is

- omitted if the file field was not given in the request.

+ The URI to which the file path was mapped. This field is omitted

+ if the file field was not given in the request.

</p>

- </dd></dl></dd><dt class="request">debug.setSubscriptions</dt><dd><div class="box"><pre>request: {

+ </dd></dl></dd><dt class="request">execution.setSubscriptions</dt><dd><div class="box"><pre>request: {

"id": String

- "method": "debug.setSubscriptions"

+ "method": "execution.setSubscriptions"

"params": {

- "<b>subscriptions</b>": List<<a href="#type_DebugService">DebugService</a>>

+ "<b>subscriptions</b>": List<<a href="#type_ExecutionService">ExecutionService</a>>

}

}</pre><br><pre>response: {

"id": String

"error": <span style="color:#999999">optional</span> <a href="#type_RequestError">RequestError</a>

}</pre></div>

<p>

- Subscribe for services. All previous subscriptions are

- replaced by the given set of services.

+ Subscribe for services. All previous subscriptions are replaced by the

+ given set of services.

</p>

<p>

- It is an error if any of the elements in the list are not

- valid services. If there is an error, then the current

- subscriptions will remain unchanged.

+ It is an error if any of the elements in the list are not valid

+ services. If there is an error, then the current subscriptions will

+ remain unchanged.

</p>

- <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( List<<a href="#type_DebugService">DebugService</a>> )</i></b></dt><dd>

+ <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( List<<a href="#type_ExecutionService">ExecutionService</a>> )</i></b></dt><dd>

<p>

A list of the services being subscribed to.

</p>

- </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification">debug.launchData</dt><dd><div class="box"><pre>notification: {

- "event": "debug.launchData"

+ </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification">execution.launchData</dt><dd><div class="box"><pre>notification: {

+ "event": "execution.launchData"

"params": {

"<b>executables</b>": List<<a href="#type_ExecutableFile">ExecutableFile</a>>

"<b>dartToHtml</b>": Map<<a href="#type_FilePath">FilePath</a>, List<<a href="#type_FilePath">FilePath</a>>>

@@ -1643,34 +1634,32 @@ dt.typeDefinition {

}

}</pre></div>

<p>

- Reports information needed to allow applications within the

- given context to be launched.

+ Reports information needed to allow applications within the given

+ context to be launched.

</p>

<p>

- This notification is not subscribed to by default. Clients

- can subscribe by including the value "LAUNCH_DATA" in the

- list of services passed in a debug.setSubscriptions request.

+ This notification is not subscribed to by default. Clients can

+ subscribe by including the value "LAUNCH_DATA" in the list of services

+ passed in a execution.setSubscriptions request.

</p>

<h4>Parameters</h4><dl><dt class="field"><b><i>executables ( List<<a href="#type_ExecutableFile">ExecutableFile</a>> )</i></b></dt><dd>

<p>

- A list of the files that are executable in the given

- context. This list replaces any previous list provided

- for the given context.

+ A list of the files that are executable in the given context. This

+ list replaces any previous list provided for the given context.

</p>

</dd><dt class="field"><b><i>dartToHtml ( Map<<a href="#type_FilePath">FilePath</a>, List<<a href="#type_FilePath">FilePath</a>>> )</i></b></dt><dd>

<p>

- A mapping from the paths of Dart files that are

- referenced by HTML files to a list of the HTML files

- that reference the Dart files.

+ A mapping from the paths of Dart files that are referenced by HTML

+ files to a list of the HTML files that reference the Dart files.

</p>

</dd><dt class="field"><b><i>htmlToDart ( Map<<a href="#type_FilePath">FilePath</a>, List<<a href="#type_FilePath">FilePath</a>>> )</i></b></dt><dd>

<p>

- A mapping from the paths of HTML files that reference

- Dart files to a list of the Dart files they reference.

+ A mapping from the paths of HTML files that reference Dart files

+ to a list of the Dart files they reference.

</p>

</dd></dl></dd></dl>

@@ -2026,18 +2015,7 @@ dt.typeDefinition {

in a completion suggestion.

</p>

- <dl><dt class="value">ARGUMENT_LIST</dt><dt class="value">CLASS</dt><dt class="value">CLASS_ALIAS</dt><dt class="value">CONSTRUCTOR</dt><dt class="value">FIELD</dt><dt class="value">FUNCTION</dt><dt class="value">FUNCTION_TYPE_ALIAS</dt><dt class="value">GETTER</dt><dt class="value">IMPORT</dt><dt class="value">KEYWORD</dt><dt class="value">LIBRARY_PREFIX</dt><dt class="value">LOCAL_VARIABLE</dt><dt class="value">METHOD</dt><dt class="value">METHOD_NAME</dt><dt class="value">NAMED_ARGUMENT</dt><dt class="value">OPTIONAL_ARGUMENT</dt><dt class="value">PARAMETER</dt><dt class="value">SETTER</dt><dt class="value">TOP_LEVEL_VARIABLE</dt><dt class="value">TYPE_PARAMETER</dt></dl></dd><dt class="typeDefinition"><a name="type_DebugContextId">DebugContextId: String</a></dt><dd>

- <p>

- The identifier for a debug context.

- </p>

- </dd><dt class="typeDefinition"><a name="type_DebugService">DebugService: String</a></dt><dd>

- <p>

- An enumeration of the services provided by the debug

- domain.

- </p>

- <dl><dt class="value">LAUNCH_DATA</dt></dl></dd><dt class="typeDefinition"><a name="type_Element">Element: object</a></dt><dd>

+ <dl><dt class="value">ARGUMENT_LIST</dt><dt class="value">CLASS</dt><dt class="value">CLASS_ALIAS</dt><dt class="value">CONSTRUCTOR</dt><dt class="value">FIELD</dt><dt class="value">FUNCTION</dt><dt class="value">FUNCTION_TYPE_ALIAS</dt><dt class="value">GETTER</dt><dt class="value">IMPORT</dt><dt class="value">KEYWORD</dt><dt class="value">LIBRARY_PREFIX</dt><dt class="value">LOCAL_VARIABLE</dt><dt class="value">METHOD</dt><dt class="value">METHOD_NAME</dt><dt class="value">NAMED_ARGUMENT</dt><dt class="value">OPTIONAL_ARGUMENT</dt><dt class="value">PARAMETER</dt><dt class="value">SETTER</dt><dt class="value">TOP_LEVEL_VARIABLE</dt><dt class="value">TYPE_PARAMETER</dt></dl></dd><dt class="typeDefinition"><a name="type_Element">Element: object</a></dt><dd>

<p>

Information about an element (something that can be declared

in code).

@@ -2114,7 +2092,18 @@ dt.typeDefinition {

An enumeration of the kinds of executable files.

</p>

- <dl><dt class="value">CLIENT</dt><dt class="value">EITHER</dt><dt class="value">SERVER</dt></dl></dd><dt class="typeDefinition"><a name="type_FilePath">FilePath: String</a></dt><dd>

+ <dl><dt class="value">CLIENT</dt><dt class="value">EITHER</dt><dt class="value">SERVER</dt></dl></dd><dt class="typeDefinition"><a name="type_ExecutionContextId">ExecutionContextId: String</a></dt><dd>

+ <p>

+ The identifier for a execution context.

+ </p>

+ </dd><dt class="typeDefinition"><a name="type_ExecutionService">ExecutionService: String</a></dt><dd>

+ <p>

+ An enumeration of the services provided by the execution

+ domain.

+ </p>

+ <dl><dt class="value">LAUNCH_DATA</dt></dl></dd><dt class="typeDefinition"><a name="type_FilePath">FilePath: String</a></dt><dd>

<p>

The absolute path of a file.

@@ -3038,21 +3027,21 @@ dt.typeDefinition {

<p>

The parameters that should be defined for the method.

- </p><p>

- It is an error if a REQUIRED or NAMED parameter follows a

- POSITIONAL parameter.

- It is an error if a REQUIRED or POSITIONAL parameter follows a

- NAMED parameter.

- </p>

- <ul>

- <li>

- To change the order and/or update proposed paramerers, add

- parameters with the same identifiers as proposed.

- </li>

- <li>To add new parameters, omit their identifier.</li>

- <li>To remove some parameters, omit them in this list.</li>

- </ul>

- <p></p>

+ </p>

+ <p>

+ It is an error if a REQUIRED or NAMED parameter follows a

+ POSITIONAL parameter.

+ It is an error if a REQUIRED or POSITIONAL parameter follows a

+ NAMED parameter.

+ </p>

+ <ul>

+ <li>

+ To change the order and/or update proposed paramerers, add

+ parameters with the same identifiers as proposed.

+ </li>

+ <li>To add new parameters, omit their identifier.</li>

+ <li>To remove some parameters, omit them in this list.</li>

+ </ul>

</dd><dt class="field"><b><i>extractAll ( bool )</i></b></dt><dd>

<p>