pkg/analyzer_plugin/doc/api.html - Issue 2911783002: Re-gen analysis server specs.

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

Issue 2911783002: Re-gen analysis server specs. (Closed)

Patch Set: Created 3 years, 7 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

« no previous file with comments | « pkg/analysis_server/tool/spec/to_html.dart ('k') | pkg/analyzer_plugin/test/integration/support/integration_test_methods.dart » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: pkg/analyzer_plugin/doc/api.html

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

index 81617e4e28cc356cc8d004990be247813de9abeb..ba4607baa48f659dcb8f0b23a473e6a70d110740 100644

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

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

@@ -95,9 +95,6 @@ a:focus, a:hover {

/* Styles for index */

-.subindex {

.subindex ul {

padding-left: 0;

margin-left: 0;

@@ -140,7 +137,7 @@ a:focus, a:hover {

-<h3>Requests</h3><dl><dt class="request"><a name="request_plugin.versionCheck">plugin.versionCheck</a> (<a href="#request_plugin.versionCheck">#</a>)</dt><dd><div class="box"><pre>request: {

+<h3>Requests</h3><dl><dt class="request"><a name="request_plugin.versionCheck">plugin.versionCheck</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "plugin.versionCheck"

"params": {

@@ -165,51 +162,51 @@ a:focus, a:hover {

- <h4>parameters:</h4><dl><dt class="field">byteStorePath (String)</dt><dd>

+ <h4>parameters:</h4><dl><dt class="field">byteStorePath: String</dt><dd>

The path to the directory containing the on-disk byte store that is to

be used by any analysis drivers that are created.

- </dd><dt class="field">sdkPath (String)</dt><dd>

+ </dd><dt class="field">sdkPath: String</dt><dd>

The path to the directory containing the SDK that is to be used by any

analysis drivers that are created.

- </dd><dt class="field">version (String)</dt><dd>

+ </dd><dt class="field">version: String</dt><dd>

The version number of the plugin spec supported by the analysis server

that is executing the plugin.

- </dd></dl><h4>returns:</h4><dl><dt class="field">isCompatible (bool)</dt><dd>

+ </dd></dl><h4>returns:</h4><dl><dt class="field">isCompatible: bool</dt><dd>

A flag indicating whether the plugin supports the same version of the

plugin spec as the analysis server. If the value is <tt>false</tt>,

then the plugin is expected to shutdown after returning the response.

- </dd><dt class="field">name (String)</dt><dd>

+ </dd><dt class="field">name: String</dt><dd>

The name of the plugin. This value is only used when the server needs

to identify the plugin, either to the user or for debugging purposes.

- </dd><dt class="field">version (String)</dt><dd>

+ </dd><dt class="field">version: String</dt><dd>

The version of the plugin. This value is only used when the server

needs to identify the plugin, either to the user or for debugging

purposes.

- </dd><dt class="field">contactInfo (optional String)</dt><dd>

+ </dd><dt class="field">contactInfo: String (optional)</dt><dd>

Information that the user can use to use to contact the maintainers of

the plugin when there is a problem.

- </dd><dt class="field">interestingFiles (List<String>)</dt><dd>

+ </dd><dt class="field">interestingFiles: List<String></dt><dd>

The glob patterns of the files for which the plugin will provide

@@ -217,7 +214,7 @@ a:focus, a:hover {

field is <tt>false</tt>. Otherwise, it will be used to identify

the files for which the plugin should be notified of changes.

- </dd></dl></dd><dt class="request"><a name="request_plugin.shutdown">plugin.shutdown</a> (<a href="#request_plugin.shutdown">#</a>)</dt><dd><div class="box"><pre>request: {

+ </dd></dl></dd><dt class="request"><a name="request_plugin.shutdown">plugin.shutdown</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "plugin.shutdown"

}</pre> <pre>response: {

@@ -229,7 +226,7 @@ a:focus, a:hover {

requests after this request. The plugin should not send any responses or

notifications after sending the response to this request.

- </dd></dl><h3>Notifications</h3><dl><dt class="notification"><a name="notification_plugin.error">plugin.error</a> (<a href="#notification_plugin.error">#</a>)</dt><dd><div class="box"><pre>notification: {

+ </dd></dl><h3>Notifications</h3><dl><dt class="notification"><a name="notification_plugin.error">plugin.error</a></dt><dd><div class="box"><pre>notification: {

"event": "plugin.error"

"params": {

"isFatal": bool

@@ -245,7 +242,7 @@ a:focus, a:hover {

preparing notifications.

- <h4>parameters:</h4><dl><dt class="field">isFatal (bool)</dt><dd>

+ <h4>parameters:</h4><dl><dt class="field">isFatal: bool</dt><dd>

A flag indicating whether the error is a fatal error, meaning that the

@@ -253,12 +250,12 @@ a:focus, a:hover {

<tt>true</tt>, the server will not expect any other responses or

notifications from the plugin.

- </dd><dt class="field">message (String)</dt><dd>

+ </dd><dt class="field">message: String</dt><dd>

The error message indicating what kind of error was encountered.

- </dd><dt class="field">stackTrace (String)</dt><dd>

+ </dd><dt class="field">stackTrace: String</dt><dd>

The stack trace associated with the generation of the error, used for

@@ -283,7 +280,7 @@ a:focus, a:hover {

-<h3>Requests</h3><dl><dt class="request"><a name="request_analysis.getNavigation">analysis.getNavigation</a> (<a href="#request_analysis.getNavigation">#</a>)</dt><dd><div class="box"><pre>request: {

+<h3>Requests</h3><dl><dt class="request"><a name="request_analysis.getNavigation">analysis.getNavigation</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "analysis.getNavigation"

"params": {

@@ -320,42 +317,42 @@ a:focus, a:hover {

- <h4>parameters:</h4><dl><dt class="field">file (<a href="#type_FilePath">FilePath</a>)</dt><dd>

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

The file in which navigation information is being requested.

- </dd><dt class="field">offset (int)</dt><dd>

+ </dd><dt class="field">offset: int</dt><dd>

The offset of the region for which navigation information is being

requested.

- </dd><dt class="field">length (int)</dt><dd>

+ </dd><dt class="field">length: int</dt><dd>

The length of the region for which navigation information is being

requested.

- </dd></dl><h4>returns:</h4><dl><dt class="field">files (List<<a href="#type_FilePath">FilePath</a>>)</dt><dd>

+ </dd></dl><h4>returns:</h4><dl><dt class="field">files: List<<a href="#type_FilePath">FilePath</a>></dt><dd>

A list of the paths of files that are referenced by the navigation

targets.

- </dd><dt class="field">targets (List<<a href="#type_NavigationTarget">NavigationTarget</a>>)</dt><dd>

+ </dd><dt class="field">targets: List<<a href="#type_NavigationTarget">NavigationTarget</a>></dt><dd>

A list of the navigation targets that are referenced by the

navigation regions.

- </dd><dt class="field">regions (List<<a href="#type_NavigationRegion">NavigationRegion</a>>)</dt><dd>

+ </dd><dt class="field">regions: List<<a href="#type_NavigationRegion">NavigationRegion</a>></dt><dd>

A list of the navigation regions within the requested region of

the file.

- </dd></dl></dd><dt class="request"><a name="request_analysis.handleWatchEvents">analysis.handleWatchEvents</a> (<a href="#request_analysis.handleWatchEvents">#</a>)</dt><dd><div class="box"><pre>request: {

+ </dd></dl></dd><dt class="request"><a name="request_analysis.handleWatchEvents">analysis.handleWatchEvents</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "analysis.handleWatchEvents"

"params": {

@@ -371,12 +368,12 @@ a:focus, a:hover {

patterns will be forwarded to the plugin.

- <h4>parameters:</h4><dl><dt class="field">events (List<<a href="#type_WatchEvent">WatchEvent</a>>)</dt><dd>

+ <h4>parameters:</h4><dl><dt class="field">events: List<<a href="#type_WatchEvent">WatchEvent</a>></dt><dd>

The watch events that the plugin should handle.

- </dd></dl></dd><dt class="request"><a name="request_analysis.reanalyze">analysis.reanalyze</a> (<a href="#request_analysis.reanalyze">#</a>)</dt><dd><div class="box"><pre>request: {

+ </dd></dl></dd><dt class="request"><a name="request_analysis.reanalyze">analysis.reanalyze</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "analysis.reanalyze"

"params": {

@@ -393,7 +390,7 @@ a:focus, a:hover {

notifications to be re-sent.

- <h4>parameters:</h4><dl><dt class="field">roots (optional List<<a href="#type_FilePath">FilePath</a>>)</dt><dd>

+ <h4>parameters:</h4><dl><dt class="field">roots: List<<a href="#type_FilePath">FilePath</a>> (optional)</dt><dd>

A list of the context roots that are to be re-analyzed.

@@ -402,7 +399,7 @@ a:focus, a:hover {

If no context roots are provided, then all current context roots

should be re-analyzed.

- </dd></dl></dd><dt class="request"><a name="request_analysis.setContextBuilderOptions">analysis.setContextBuilderOptions</a> (<a href="#request_analysis.setContextBuilderOptions">#</a>)</dt><dd><div class="box"><pre>request: {

+ </dd></dl></dd><dt class="request"><a name="request_analysis.setContextBuilderOptions">analysis.setContextBuilderOptions</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "analysis.setContextBuilderOptions"

"params": {

@@ -417,12 +414,12 @@ a:focus, a:hover {

be sent exactly once before any context roots have been specified.

- <h4>parameters:</h4><dl><dt class="field">options (<a href="#type_ContextBuilderOptions">ContextBuilderOptions</a>)</dt><dd>

+ <h4>parameters:</h4><dl><dt class="field">options: <a href="#type_ContextBuilderOptions">ContextBuilderOptions</a></dt><dd>

The options used to build the analysis contexts.

- </dd></dl></dd><dt class="request"><a name="request_analysis.setContextRoots">analysis.setContextRoots</a> (<a href="#request_analysis.setContextRoots">#</a>)</dt><dd><div class="box"><pre>request: {

+ </dd></dl></dd><dt class="request"><a name="request_analysis.setContextRoots">analysis.setContextRoots</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "analysis.setContextRoots"

"params": {

@@ -436,12 +433,12 @@ a:focus, a:hover {

Set the list of context roots that should be analyzed.

- <h4>parameters:</h4><dl><dt class="field">roots (List<<a href="#type_ContextRoot">ContextRoot</a>>)</dt><dd>

+ <h4>parameters:</h4><dl><dt class="field">roots: List<<a href="#type_ContextRoot">ContextRoot</a>></dt><dd>

A list of the context roots that should be analyzed.

- </dd></dl></dd><dt class="request"><a name="request_analysis.setPriorityFiles">analysis.setPriorityFiles</a> (<a href="#request_analysis.setPriorityFiles">#</a>)</dt><dd><div class="box"><pre>request: {

+ </dd></dl></dd><dt class="request"><a name="request_analysis.setPriorityFiles">analysis.setPriorityFiles</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "analysis.setPriorityFiles"

"params": {

@@ -461,12 +458,12 @@ a:focus, a:hover {

the second, the second higher priority than the third, and so on.

- <h4>parameters:</h4><dl><dt class="field">files (List<<a href="#type_FilePath">FilePath</a>>)</dt><dd>

+ <h4>parameters:</h4><dl><dt class="field">files: List<<a href="#type_FilePath">FilePath</a>></dt><dd>

The files that are to be a priority for analysis.

- </dd></dl></dd><dt class="request"><a name="request_analysis.setSubscriptions">analysis.setSubscriptions</a> (<a href="#request_analysis.setSubscriptions">#</a>)</dt><dd><div class="box"><pre>request: {

+ </dd></dl></dd><dt class="request"><a name="request_analysis.setSubscriptions">analysis.setSubscriptions</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "analysis.setSubscriptions"

"params": {

@@ -484,13 +481,13 @@ a:focus, a:hover {

had been included in the map with an explicit empty list of files.

- <h4>parameters:</h4><dl><dt class="field">subscriptions (Map<<a href="#type_AnalysisService">AnalysisService</a>, List<<a href="#type_FilePath">FilePath</a>>>)</dt><dd>

+ <h4>parameters:</h4><dl><dt class="field">subscriptions: Map<<a href="#type_AnalysisService">AnalysisService</a>, List<<a href="#type_FilePath">FilePath</a>>></dt><dd>

A table mapping services to a list of the files being subscribed to

the service.

- </dd></dl></dd><dt class="request"><a name="request_analysis.updateContent">analysis.updateContent</a> (<a href="#request_analysis.updateContent">#</a>)</dt><dd><div class="box"><pre>request: {

+ </dd></dl></dd><dt class="request"><a name="request_analysis.updateContent">analysis.updateContent</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "analysis.updateContent"

"params": {

@@ -509,13 +506,13 @@ a:focus, a:hover {

the file path represents the path to a directory on the filesystem.

- <h4>parameters:</h4><dl><dt class="field">files (Map<<a href="#type_FilePath">FilePath</a>, <a href="#type_AddContentOverlay">AddContentOverlay</a> | <a href="#type_ChangeContentOverlay">ChangeContentOverlay</a> | <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a>>)</dt><dd>

+ <h4>parameters:</h4><dl><dt class="field">files: Map<<a href="#type_FilePath">FilePath</a>, <a href="#type_AddContentOverlay">AddContentOverlay</a> | <a href="#type_ChangeContentOverlay">ChangeContentOverlay</a> | <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a>></dt><dd>

A table mapping the files whose content has changed to a description

of the content change.

- </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"><a name="notification_analysis.errors">analysis.errors</a> (<a href="#notification_analysis.errors">#</a>)</dt><dd><div class="box"><pre>notification: {

+ </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"><a name="notification_analysis.errors">analysis.errors</a></dt><dd><div class="box"><pre>notification: {

"event": "analysis.errors"

"params": {

"file": <a href="#type_FilePath">FilePath</a>

@@ -528,17 +525,17 @@ a:focus, a:hover {

previously reported errors.

- <h4>parameters:</h4><dl><dt class="field">file (<a href="#type_FilePath">FilePath</a>)</dt><dd>

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

The file containing the errors.

- </dd><dt class="field">errors (List<<a href="#type_AnalysisError">AnalysisError</a>>)</dt><dd>

+ </dd><dt class="field">errors: List<<a href="#type_AnalysisError">AnalysisError</a>></dt><dd>

The errors contained in the file.

- </dd></dl></dd><dt class="notification"><a name="notification_analysis.folding">analysis.folding</a> (<a href="#notification_analysis.folding">#</a>)</dt><dd><div class="box"><pre>notification: {

+ </dd></dl></dd><dt class="notification"><a name="notification_analysis.folding">analysis.folding</a></dt><dd><div class="box"><pre>notification: {

"event": "analysis.folding"

"params": {

"file": <a href="#type_FilePath">FilePath</a>

@@ -562,17 +559,17 @@ a:focus, a:hover {

passed in an analysis.setSubscriptions request.

- <h4>parameters:</h4><dl><dt class="field">file (<a href="#type_FilePath">FilePath</a>)</dt><dd>

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

The file containing the folding regions.

- </dd><dt class="field">regions (List<<a href="#type_FoldingRegion">FoldingRegion</a>>)</dt><dd>

+ </dd><dt class="field">regions: List<<a href="#type_FoldingRegion">FoldingRegion</a>></dt><dd>

The folding regions contained in the file.

- </dd></dl></dd><dt class="notification"><a name="notification_analysis.highlights">analysis.highlights</a> (<a href="#notification_analysis.highlights">#</a>)</dt><dd><div class="box"><pre>notification: {

+ </dd></dl></dd><dt class="notification"><a name="notification_analysis.highlights">analysis.highlights</a></dt><dd><div class="box"><pre>notification: {

"event": "analysis.highlights"

"params": {

"file": <a href="#type_FilePath">FilePath</a>

@@ -592,17 +589,17 @@ a:focus, a:hover {

passed in an analysis.setSubscriptions request.

- <h4>parameters:</h4><dl><dt class="field">file (<a href="#type_FilePath">FilePath</a>)</dt><dd>

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

The file containing the highlight regions.

- </dd><dt class="field">regions (List<<a href="#type_HighlightRegion">HighlightRegion</a>>)</dt><dd>

+ </dd><dt class="field">regions: List<<a href="#type_HighlightRegion">HighlightRegion</a>></dt><dd>

The highlight regions contained in the file.

- </dd></dl></dd><dt class="notification"><a name="notification_analysis.navigation">analysis.navigation</a> (<a href="#notification_analysis.navigation">#</a>)</dt><dd><div class="box"><pre>notification: {

+ </dd></dl></dd><dt class="notification"><a name="notification_analysis.navigation">analysis.navigation</a></dt><dd><div class="box"><pre>notification: {

"event": "analysis.navigation"

"params": {

"file": <a href="#type_FilePath">FilePath</a>

@@ -632,24 +629,24 @@ a:focus, a:hover {

passed in an analysis.setSubscriptions request.

- <h4>parameters:</h4><dl><dt class="field">file (<a href="#type_FilePath">FilePath</a>)</dt><dd>

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

The file containing the navigation regions.

- </dd><dt class="field">regions (List<<a href="#type_NavigationRegion">NavigationRegion</a>>)</dt><dd>

+ </dd><dt class="field">regions: List<<a href="#type_NavigationRegion">NavigationRegion</a>></dt><dd>

The navigation regions contained in the file.

- </dd><dt class="field">targets (List<<a href="#type_NavigationTarget">NavigationTarget</a>>)</dt><dd>

+ </dd><dt class="field">targets: List<<a href="#type_NavigationTarget">NavigationTarget</a>></dt><dd>

The navigation targets referenced in the file. They are referenced by

<a href="#type_NavigationRegion">NavigationRegion</a>s by their index

in this array.

- </dd><dt class="field">files (List<<a href="#type_FilePath">FilePath</a>>)</dt><dd>

+ </dd><dt class="field">files: List<<a href="#type_FilePath">FilePath</a>></dt><dd>

The files containing navigation targets referenced in the file. They

@@ -657,7 +654,7 @@ a:focus, a:hover {

<a href="#type_NavigationTarget">NavigationTarget</a>s by their index

in this array.

- </dd></dl></dd><dt class="notification"><a name="notification_analysis.occurrences">analysis.occurrences</a> (<a href="#notification_analysis.occurrences">#</a>)</dt><dd><div class="box"><pre>notification: {

+ </dd></dl></dd><dt class="notification"><a name="notification_analysis.occurrences">analysis.occurrences</a></dt><dd><div class="box"><pre>notification: {

"event": "analysis.occurrences"

"params": {

"file": <a href="#type_FilePath">FilePath</a>

@@ -680,17 +677,17 @@ a:focus, a:hover {

passed in an analysis.setSubscriptions request.

- <h4>parameters:</h4><dl><dt class="field">file (<a href="#type_FilePath">FilePath</a>)</dt><dd>

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

The file in which the references occur.

- </dd><dt class="field">occurrences (List<<a href="#type_Occurrences">Occurrences</a>>)</dt><dd>

+ </dd><dt class="field">occurrences: List<<a href="#type_Occurrences">Occurrences</a>></dt><dd>

The occurrences of references to elements within the file.

- </dd></dl></dd><dt class="notification"><a name="notification_analysis.outline">analysis.outline</a> (<a href="#notification_analysis.outline">#</a>)</dt><dd><div class="box"><pre>notification: {

+ </dd></dl></dd><dt class="notification"><a name="notification_analysis.outline">analysis.outline</a></dt><dd><div class="box"><pre>notification: {

"event": "analysis.outline"

"params": {

"file": <a href="#type_FilePath">FilePath</a>

@@ -711,12 +708,12 @@ a:focus, a:hover {

passed in an analysis.setSubscriptions request.

- <h4>parameters:</h4><dl><dt class="field">file (<a href="#type_FilePath">FilePath</a>)</dt><dd>

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

The file with which the outline is associated.

- </dd><dt class="field">outline (List<<a href="#type_Outline">Outline</a>>)</dt><dd>

+ </dd><dt class="field">outline: List<<a href="#type_Outline">Outline</a>></dt><dd>

The outline fragments associated with the file.

@@ -728,7 +725,7 @@ a:focus, a:hover {

suggestions.

-<h3>Requests</h3><dl><dt class="request"><a name="request_completion.getSuggestions">completion.getSuggestions</a> (<a href="#request_completion.getSuggestions">#</a>)</dt><dd><div class="box"><pre>request: {

+<h3>Requests</h3><dl><dt class="request"><a name="request_completion.getSuggestions">completion.getSuggestions</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "completion.getSuggestions"

"params": {

@@ -750,17 +747,17 @@ a:focus, a:hover {

- <h4>parameters:</h4><dl><dt class="field">file (<a href="#type_FilePath">FilePath</a>)</dt><dd>

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

The file containing the point at which suggestions are to be made.

- </dd><dt class="field">offset (int)</dt><dd>

+ </dd><dt class="field">offset: int</dt><dd>

The offset within the file at which suggestions are to be made.

- </dd></dl><h4>returns:</h4><dl><dt class="field">replacementOffset (int)</dt><dd>

+ </dd></dl><h4>returns:</h4><dl><dt class="field">replacementOffset: int</dt><dd>

The offset of the start of the text to be replaced. This will be

@@ -769,7 +766,7 @@ a:focus, a:hover {

particular, the replacementOffset will be the offset of the beginning

of said identifier.

- </dd><dt class="field">replacementLength (int)</dt><dd>

+ </dd><dt class="field">replacementLength: int</dt><dd>

The length of the text to be replaced if the remainder of the

@@ -777,7 +774,7 @@ a:focus, a:hover {

is applied (that is, the number of characters in the existing

identifier).

- </dd><dt class="field">results (List<<a href="#type_CompletionSuggestion">CompletionSuggestion</a>>)</dt><dd>

+ </dd><dt class="field">results: List<<a href="#type_CompletionSuggestion">CompletionSuggestion</a>></dt><dd>

The completion suggestions being reported. The notification contains

@@ -796,7 +793,7 @@ a:focus, a:hover {

-<h3>Requests</h3><dl><dt class="request"><a name="request_edit.getAssists">edit.getAssists</a> (<a href="#request_edit.getAssists">#</a>)</dt><dd><div class="box"><pre>request: {

+<h3>Requests</h3><dl><dt class="request"><a name="request_edit.getAssists">edit.getAssists</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "edit.getAssists"

"params": {

@@ -819,27 +816,27 @@ a:focus, a:hover {

- <h4>parameters:</h4><dl><dt class="field">file (<a href="#type_FilePath">FilePath</a>)</dt><dd>

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

The file containing the code for which assists are being requested.

- </dd><dt class="field">offset (int)</dt><dd>

+ </dd><dt class="field">offset: int</dt><dd>

The offset of the code for which assists are being requested.

- </dd><dt class="field">length (int)</dt><dd>

+ </dd><dt class="field">length: int</dt><dd>

The length of the code for which assists are being requested.

- </dd></dl><h4>returns:</h4><dl><dt class="field">assists (List<<a href="#type_PrioritizedSourceChange">PrioritizedSourceChange</a>>)</dt><dd>

+ </dd></dl><h4>returns:</h4><dl><dt class="field">assists: List<<a href="#type_PrioritizedSourceChange">PrioritizedSourceChange</a>></dt><dd>

The assists that are available at the given location.

- </dd></dl></dd><dt class="request"><a name="request_edit.getAvailableRefactorings">edit.getAvailableRefactorings</a> (<a href="#request_edit.getAvailableRefactorings">#</a>)</dt><dd><div class="box"><pre>request: {

+ </dd></dl></dd><dt class="request"><a name="request_edit.getAvailableRefactorings">edit.getAvailableRefactorings</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "edit.getAvailableRefactorings"

"params": {

@@ -860,22 +857,22 @@ a:focus, a:hover {

- <h4>parameters:</h4><dl><dt class="field">file (<a href="#type_FilePath">FilePath</a>)</dt><dd>

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

The file containing the code on which the refactoring would be based.

- </dd><dt class="field">offset (int)</dt><dd>

+ </dd><dt class="field">offset: int</dt><dd>

The offset of the code on which the refactoring would be based.

- </dd><dt class="field">length (int)</dt><dd>

+ </dd><dt class="field">length: int</dt><dd>

The length of the code on which the refactoring would be based.

- </dd></dl><h4>returns:</h4><dl><dt class="field">kinds (List<<a href="#type_RefactoringKind">RefactoringKind</a>>)</dt><dd>

+ </dd></dl><h4>returns:</h4><dl><dt class="field">kinds: List<<a href="#type_RefactoringKind">RefactoringKind</a>></dt><dd>

The kinds of refactorings that are valid for the given selection.

@@ -886,7 +883,7 @@ a:focus, a:hover {

However, plugins can support pre-defined refactorings, such as a

rename refactoring, at locations not supported by server.

- </dd></dl></dd><dt class="request"><a name="request_edit.getFixes">edit.getFixes</a> (<a href="#request_edit.getFixes">#</a>)</dt><dd><div class="box"><pre>request: {

+ </dd></dl></dd><dt class="request"><a name="request_edit.getFixes">edit.getFixes</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "edit.getFixes"

"params": {

@@ -906,22 +903,22 @@ a:focus, a:hover {

- <h4>parameters:</h4><dl><dt class="field">file (<a href="#type_FilePath">FilePath</a>)</dt><dd>

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

The file containing the errors for which fixes are being requested.

- </dd><dt class="field">offset (int)</dt><dd>

+ </dd><dt class="field">offset: int</dt><dd>

The offset used to select the errors for which fixes will be returned.

- </dd></dl><h4>returns:</h4><dl><dt class="field">fixes (List<<a href="#type_AnalysisErrorFixes">AnalysisErrorFixes</a>>)</dt><dd>

+ </dd></dl><h4>returns:</h4><dl><dt class="field">fixes: List<<a href="#type_AnalysisErrorFixes">AnalysisErrorFixes</a>></dt><dd>

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

- </dd></dl></dd><dt class="request"><a name="request_edit.getRefactoring">edit.getRefactoring</a> (<a href="#request_edit.getRefactoring">#</a>)</dt><dd><div class="box"><pre>request: {

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

"id": String

"method": "edit.getRefactoring"

"params": {

@@ -949,33 +946,33 @@ a:focus, a:hover {

- <h4>parameters:</h4><dl><dt class="field">kind (<a href="#type_RefactoringKind">RefactoringKind</a>)</dt><dd>

+ <h4>parameters:</h4><dl><dt class="field">kind: <a href="#type_RefactoringKind">RefactoringKind</a></dt><dd>

The kind of refactoring to be performed.

- </dd><dt class="field">file (<a href="#type_FilePath">FilePath</a>)</dt><dd>

+ </dd><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

The file containing the code involved in the refactoring.

- </dd><dt class="field">offset (int)</dt><dd>

+ </dd><dt class="field">offset: int</dt><dd>

The offset of the region involved in the refactoring.

- </dd><dt class="field">length (int)</dt><dd>

+ </dd><dt class="field">length: int</dt><dd>

The length of the region involved in the refactoring.

- </dd><dt class="field">validateOnly (bool)</dt><dd>

+ </dd><dt class="field">validateOnly: bool</dt><dd>

True if the client is only requesting that the values of the options

be validated and no change be generated.

- </dd><dt class="field">options (optional <a href="#type_RefactoringOptions">RefactoringOptions</a>)</dt><dd>

+ </dd><dt class="field">options: <a href="#type_RefactoringOptions">RefactoringOptions</a> (optional)</dt><dd>

Data used to provide values provided by the user. The structure of the

@@ -985,28 +982,28 @@ a:focus, a:hover {

field can be omitted if the refactoring does not require any options

or if the values of those options are not known.

- </dd></dl><h4>returns:</h4><dl><dt class="field">initialProblems (List<<a href="#type_RefactoringProblem">RefactoringProblem</a>>)</dt><dd>

+ </dd></dl><h4>returns:</h4><dl><dt class="field">initialProblems: List<<a href="#type_RefactoringProblem">RefactoringProblem</a>></dt><dd>

The initial status of the refactoring, that is, problems related to

the context in which the refactoring is requested. The list should be

empty if there are no known problems.

- </dd><dt class="field">optionsProblems (List<<a href="#type_RefactoringProblem">RefactoringProblem</a>>)</dt><dd>

+ </dd><dt class="field">optionsProblems: List<<a href="#type_RefactoringProblem">RefactoringProblem</a>></dt><dd>

The options validation status, that is, problems in the given options,

such as light-weight validation of a new name, flags compatibility,

etc. The list should be empty if there are no known problems.

- </dd><dt class="field">finalProblems (List<<a href="#type_RefactoringProblem">RefactoringProblem</a>>)</dt><dd>

+ </dd><dt class="field">finalProblems: List<<a href="#type_RefactoringProblem">RefactoringProblem</a>></dt><dd>

The final status of the refactoring, that is, problems identified in

the result of a full, potentially expensive validation and / or change

creation. The list should be empty if there are no known problems.

- </dd><dt class="field">feedback (optional <a href="#type_RefactoringFeedback">RefactoringFeedback</a>)</dt><dd>

+ </dd><dt class="field">feedback: <a href="#type_RefactoringFeedback">RefactoringFeedback</a> (optional)</dt><dd>

Data used to provide feedback to the user. The structure of the data

@@ -1014,7 +1011,7 @@ a:focus, a:hover {

is returned is documented in the section titled

<a href="#refactorings">Refactorings</a>, labeled as "Feedback".

- </dd><dt class="field">change (optional <a href="#type_SourceChange">SourceChange</a>)</dt><dd>

+ </dd><dt class="field">change: <a href="#type_SourceChange">SourceChange</a> (optional)</dt><dd>

The changes that are to be applied to affect the refactoring. This

@@ -1022,7 +1019,7 @@ a:focus, a:hover {

changes from being computed, such as having no options specified for a

refactoring that requires them, or if only validation was requested.

- </dd><dt class="field">potentialEdits (optional List<String>)</dt><dd>

+ </dd><dt class="field">potentialEdits: List<String> (optional)</dt><dd>

The ids of source edits that are not known to be valid. An edit is not

@@ -1065,7 +1062,7 @@ a:focus, a:hover {

- </dd><dt class="field">content (String)</dt><dd>

+ </dd><dt class="field">content: String</dt><dd>

The new content of the file.

@@ -1076,28 +1073,28 @@ a:focus, a:hover {

analysis.

- <dl><dt class="field">severity (<a href="#type_AnalysisErrorSeverity">AnalysisErrorSeverity</a>)</dt><dd>

+ <dl><dt class="field">severity: <a href="#type_AnalysisErrorSeverity">AnalysisErrorSeverity</a></dt><dd>

The severity of the error.

- </dd><dt class="field">type (<a href="#type_AnalysisErrorType">AnalysisErrorType</a>)</dt><dd>

+ </dd><dt class="field">type: <a href="#type_AnalysisErrorType">AnalysisErrorType</a></dt><dd>

The type of the error.

- </dd><dt class="field">location (<a href="#type_Location">Location</a>)</dt><dd>

+ </dd><dt class="field">location: <a href="#type_Location">Location</a></dt><dd>

The location associated with the error.

- </dd><dt class="field">message (String)</dt><dd>

+ </dd><dt class="field">message: String</dt><dd>

The message to be displayed for this error. The message should

indicate what is wrong with the code and why it is wrong.

- </dd><dt class="field">correction (optional String)</dt><dd>

+ </dd><dt class="field">correction: String (optional)</dt><dd>

The correction message to be displayed for this error. The correction

@@ -1105,12 +1102,12 @@ a:focus, a:hover {

omitted if there is no correction message associated with the error

code.

- </dd><dt class="field">code (String)</dt><dd>

+ </dd><dt class="field">code: String</dt><dd>

The name, as a string, of the error code associated with this error.

- </dd><dt class="field">hasFix (optional bool)</dt><dd>

+ </dd><dt class="field">hasFix: bool (optional)</dt><dd>

A hint to indicate to interested clients that this error has an

@@ -1128,12 +1125,12 @@ a:focus, a:hover {

A list of fixes associated with a specific error

- <dl><dt class="field">error (<a href="#type_AnalysisError">AnalysisError</a>)</dt><dd>

+ <dl><dt class="field">error: <a href="#type_AnalysisError">AnalysisError</a></dt><dd>

The error with which the fixes are associated.

- </dd><dt class="field">fixes (List<<a href="#type_PrioritizedSourceChange">PrioritizedSourceChange</a>>)</dt><dd>

+ </dd><dt class="field">fixes: List<<a href="#type_PrioritizedSourceChange">PrioritizedSourceChange</a>></dt><dd>

The fixes associated with the error.

@@ -1177,7 +1174,7 @@ a:focus, a:hover {

<dl><dt class="field">type = "change"</dt><dd>

- </dd><dt class="field">edits (List<<a href="#type_SourceEdit">SourceEdit</a>>)</dt><dd>

+ </dd><dt class="field">edits: List<<a href="#type_SourceEdit">SourceEdit</a>></dt><dd>

The edits to be applied to the file.

@@ -1188,18 +1185,18 @@ a:focus, a:hover {

fields are optional, depending on the kind of element being suggested.

- <dl><dt class="field">kind (<a href="#type_CompletionSuggestionKind">CompletionSuggestionKind</a>)</dt><dd>

+ <dl><dt class="field">kind: <a href="#type_CompletionSuggestionKind">CompletionSuggestionKind</a></dt><dd>

The kind of element being suggested.

- </dd><dt class="field">relevance (int)</dt><dd>

+ </dd><dt class="field">relevance: int</dt><dd>

The relevance of this completion suggestion where a higher number

indicates a higher relevance.

- </dd><dt class="field">completion (String)</dt><dd>

+ </dd><dt class="field">completion: String</dt><dd>

The identifier to be inserted if the suggestion is selected. If the

@@ -1207,54 +1204,54 @@ a:focus, a:hover {

additionally insert a template for the parameters. The information

required in order to do so is contained in other fields.

- </dd><dt class="field">selectionOffset (int)</dt><dd>

+ </dd><dt class="field">selectionOffset: int</dt><dd>

The offset, relative to the beginning of the completion, of where the

selection should be placed after insertion.

- </dd><dt class="field">selectionLength (int)</dt><dd>

+ </dd><dt class="field">selectionLength: int</dt><dd>

The number of characters that should be selected after insertion.

- </dd><dt class="field">isDeprecated (bool)</dt><dd>

+ </dd><dt class="field">isDeprecated: bool</dt><dd>

True if the suggested element is deprecated.

- </dd><dt class="field">isPotential (bool)</dt><dd>

+ </dd><dt class="field">isPotential: bool</dt><dd>

True if the element is not known to be valid for the target. This

happens if the type of the target is dynamic.

- </dd><dt class="field">docSummary (optional String)</dt><dd>

+ </dd><dt class="field">docSummary: String (optional)</dt><dd>

An abbreviated version of the Dartdoc associated with the element

being suggested, This field is omitted if there is no Dartdoc

associated with the element.

- </dd><dt class="field">docComplete (optional String)</dt><dd>

+ </dd><dt class="field">docComplete: String (optional)</dt><dd>

The Dartdoc associated with the element being suggested. This field is

omitted if there is no Dartdoc associated with the element.

- </dd><dt class="field">declaringType (optional String)</dt><dd>

+ </dd><dt class="field">declaringType: String (optional)</dt><dd>

The class that declares the element being suggested. This field is

omitted if the suggested element is not a member of a class.

- </dd><dt class="field">defaultArgumentListString (optional String)</dt><dd>

+ </dd><dt class="field">defaultArgumentListString: String (optional)</dt><dd>

A default String for use in generating argument list source contents

on the client side.

- </dd><dt class="field">defaultArgumentListTextRanges (optional List<int>)</dt><dd>

+ </dd><dt class="field">defaultArgumentListTextRanges: List<int> (optional)</dt><dd>

Pairs of offsets and lengths describing 'defaultArgumentListString'

@@ -1265,59 +1262,59 @@ a:focus, a:hover {

use these ranges to treat the 'x' and 'y' values specially for linked

edits.

- </dd><dt class="field">element (optional <a href="#type_Element">Element</a>)</dt><dd>

+ </dd><dt class="field">element: <a href="#type_Element">Element</a> (optional)</dt><dd>

Information about the element reference being suggested.

- </dd><dt class="field">returnType (optional String)</dt><dd>

+ </dd><dt class="field">returnType: String (optional)</dt><dd>

The return type of the getter, function or method or the type of the

field being suggested. This field is omitted if the suggested element

is not a getter, function or method.

- </dd><dt class="field">parameterNames (optional List<String>)</dt><dd>

+ </dd><dt class="field">parameterNames: List<String> (optional)</dt><dd>

The names of the parameters of the function or method being suggested.

This field is omitted if the suggested element is not a setter,

function or method.

- </dd><dt class="field">parameterTypes (optional List<String>)</dt><dd>

+ </dd><dt class="field">parameterTypes: List<String> (optional)</dt><dd>

The types of the parameters of the function or method being suggested.

This field is omitted if the parameterNames field is omitted.

- </dd><dt class="field">requiredParameterCount (optional int)</dt><dd>

+ </dd><dt class="field">requiredParameterCount: int (optional)</dt><dd>

The number of required parameters for the function or method being

suggested. This field is omitted if the parameterNames field is

omitted.

- </dd><dt class="field">hasNamedParameters (optional bool)</dt><dd>

+ </dd><dt class="field">hasNamedParameters: bool (optional)</dt><dd>

True if the function or method being suggested has at least one named

parameter. This field is omitted if the parameterNames field is

omitted.

- </dd><dt class="field">parameterName (optional String)</dt><dd>

+ </dd><dt class="field">parameterName: String (optional)</dt><dd>

The name of the optional parameter being suggested. This field is

omitted if the suggestion is not the addition of an optional argument

within an argument list.

- </dd><dt class="field">parameterType (optional String)</dt><dd>

+ </dd><dt class="field">parameterType: String (optional)</dt><dd>

The type of the options parameter being suggested. This field is

omitted if the parameterName field is omitted.

- </dd><dt class="field">importUri (optional String)</dt><dd>

+ </dd><dt class="field">importUri: String (optional)</dt><dd>

The import to be added if the suggestion is out of scope and needs

@@ -1372,14 +1369,14 @@ a:focus, a:hover {

The options used to build an analysis context.

- <dl><dt class="field">dartSdkSummaryPath (optional String)</dt><dd>

+ <dl><dt class="field">dartSdkSummaryPath: String (optional)</dt><dd>

The file path of the file containing the summary of the SDK that

should be used to "analyze" the SDK. The field will be omitted if the

summary should be found in the SDK.

- </dd><dt class="field">defaultAnalysisOptionsFilePath (optional List<String>)</dt><dd>

+ </dd><dt class="field">defaultAnalysisOptionsFilePath: List<String> (optional)</dt><dd>

The file path of the analysis options file that should be used in

@@ -1387,14 +1384,14 @@ a:focus, a:hover {

directory. The field will be omitted if the normal lookup mechanism

should be used.

- </dd><dt class="field">declaredVariables (optional Map<String, String>)</dt><dd>

+ </dd><dt class="field">declaredVariables: Map<String, String> (optional)</dt><dd>

A table mapping variable names to values for the declared variables.

The field will be omitted if no additional variables need to be

declared.

- </dd><dt class="field">defaultPackageFilePath (optional List<String>)</dt><dd>

+ </dd><dt class="field">defaultPackageFilePath: List<String> (optional)</dt><dd>

The file path of the .packages file that should be used in place of

@@ -1402,7 +1399,7 @@ a:focus, a:hover {

mechanism. The field will be omitted if the normal lookup mechanism

should be used.

- </dd><dt class="field">defaultPackagesDirectoryPath (optional List<String>)</dt><dd>

+ </dd><dt class="field">defaultPackagesDirectoryPath: List<String> (optional)</dt><dd>

The file path of the packages directory that should be used in place

@@ -1415,13 +1412,13 @@ a:focus, a:hover {

A description of an analysis context.

- <dl><dt class="field">root (String)</dt><dd>

+ <dl><dt class="field">root: String</dt><dd>

The absolute path of the root directory containing the files to be

analyzed.

- </dd><dt class="field">exclude (List<String>)</dt><dd>

+ </dd><dt class="field">exclude: List<String></dt><dd>

A list of the absolute paths of files and directories within the root

@@ -1432,23 +1429,23 @@ a:focus, a:hover {

Information about an element (something that can be declared in code).

- <dl><dt class="field">kind (<a href="#type_ElementKind">ElementKind</a>)</dt><dd>

+ <dl><dt class="field">kind: <a href="#type_ElementKind">ElementKind</a></dt><dd>

The kind of the element.

- </dd><dt class="field">name (String)</dt><dd>

+ </dd><dt class="field">name: String</dt><dd>

The name of the element. This is typically used as the label in the

outline.

- </dd><dt class="field">location (optional <a href="#type_Location">Location</a>)</dt><dd>

+ </dd><dt class="field">location: <a href="#type_Location">Location</a> (optional)</dt><dd>

The location of the name in the declaration of the element.

- </dd><dt class="field">flags (int)</dt><dd>

+ </dd><dt class="field">flags: int</dt><dd>

A bit-map containing the following flags:

@@ -1474,7 +1471,7 @@ a:focus, a:hover {

0x20 - set if the element is deprecated

</li>

</ul>

- </dd><dt class="field">parameters (optional String)</dt><dd>

+ </dd><dt class="field">parameters: String (optional)</dt><dd>

The parameter list for the element. If the element is not a method or

@@ -1482,14 +1479,14 @@ a:focus, a:hover {

parameters (e.g. getter), this field will not be defined. If the

element has zero parameters, this field will have a value of "()".

- </dd><dt class="field">returnType (optional String)</dt><dd>

+ </dd><dt class="field">returnType: String (optional)</dt><dd>

The return type of the element. If the element is not a method or

function this field will not be defined. If the element does not have

a declared return type, this field will contain an empty string.

- </dd><dt class="field">typeParameters (optional String)</dt><dd>

+ </dd><dt class="field">typeParameters: String (optional)</dt><dd>

The type parameter list for the element. If the element doesn't have

@@ -1500,10 +1497,10 @@ a:focus, a:hover {

An enumeration of the kinds of elements.

- <dl><dt class="value">CLASS</dt><dt class="value">CLASS_TYPE_ALIAS</dt><dt class="value">COMPILATION_UNIT</dt><dt class="value">CONSTRUCTOR</dt><dt class="value">ENUM</dt><dt class="value">ENUM_CONSTANT</dt><dt class="value">FIELD</dt><dt class="value">FILE</dt><dt class="value">FUNCTION</dt><dt class="value">FUNCTION_TYPE_ALIAS</dt><dt class="value">GETTER</dt><dt class="value">LABEL</dt><dt class="value">LIBRARY</dt><dt class="value">LOCAL_VARIABLE</dt><dt class="value">METHOD</dt><dt class="value">PARAMETER</dt><dt class="value">PREFIX</dt><dt class="value">SETTER</dt><dt class="value">TOP_LEVEL_VARIABLE</dt><dt class="value">TYPE_PARAMETER</dt><dt class="value">UNIT_TEST_GROUP</dt><dd>

+ <dl><dt class="value">CLASS</dt><dt class="value">CLASS_TYPE_ALIAS</dt><dt class="value">COMPILATION_UNIT</dt><dt class="value">CONSTRUCTOR</dt><dt class="value">ENUM</dt><dt class="value">ENUM_CONSTANT</dt><dt class="value">FIELD</dt><dt class="value">FILE</dt><dt class="value">FUNCTION</dt><dt class="value">FUNCTION_TYPE_ALIAS</dt><dt class="value">GETTER</dt><dt class="value">LABEL</dt><dt class="value">LIBRARY</dt><dt class="value">LOCAL_VARIABLE</dt><dt class="value">METHOD</dt><dt class="value">PARAMETER</dt><dt class="value">PREFIX</dt><dt class="value">SETTER</dt><dt class="value">TOP_LEVEL_VARIABLE</dt><dt class="value">TYPE_PARAMETER</dt><dt class="value deprecated">UNIT_TEST_GROUP</dt><dd>

Deprecated: support for tests was removed.

- </dd><dt class="value">UNIT_TEST_TEST</dt><dd>

+ </dd><dt class="value deprecated">UNIT_TEST_TEST</dt><dd>

Deprecated: support for tests was removed.

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

@@ -1526,17 +1523,17 @@ a:focus, a:hover {

A description of a region that can be folded.

- <dl><dt class="field">kind (<a href="#type_FoldingKind">FoldingKind</a>)</dt><dd>

+ <dl><dt class="field">kind: <a href="#type_FoldingKind">FoldingKind</a></dt><dd>

The kind of the region.

- </dd><dt class="field">offset (int)</dt><dd>

+ </dd><dt class="field">offset: int</dt><dd>

The offset of the region to be folded.

- </dd><dt class="field">length (int)</dt><dd>

+ </dd><dt class="field">length: int</dt><dd>

The length of the region to be folded.

@@ -1547,17 +1544,17 @@ a:focus, a:hover {

with it.

- <dl><dt class="field">type (<a href="#type_HighlightRegionType">HighlightRegionType</a>)</dt><dd>

+ <dl><dt class="field">type: <a href="#type_HighlightRegionType">HighlightRegionType</a></dt><dd>

The type of highlight associated with the region.

- </dd><dt class="field">offset (int)</dt><dd>

+ </dd><dt class="field">offset: int</dt><dd>

The offset of the region to be highlighted.

- </dd><dt class="field">length (int)</dt><dd>

+ </dd><dt class="field">length: int</dt><dd>

The length of the region to be highlighted.

@@ -1724,17 +1721,17 @@ a:focus, a:hover {

the name could be edited simultaneously.

- <dl><dt class="field">positions (List<<a href="#type_Position">Position</a>>)</dt><dd>

+ <dl><dt class="field">positions: List<<a href="#type_Position">Position</a>></dt><dd>

The positions of the regions that should be edited simultaneously.

- </dd><dt class="field">length (int)</dt><dd>

+ </dd><dt class="field">length: int</dt><dd>

The length of the regions that should be edited simultaneously.

- </dd><dt class="field">suggestions (List<<a href="#type_LinkedEditSuggestion">LinkedEditSuggestion</a>>)</dt><dd>

+ </dd><dt class="field">suggestions: List<<a href="#type_LinkedEditSuggestion">LinkedEditSuggestion</a>></dt><dd>

Pre-computed suggestions for what every region might want to be

@@ -1746,13 +1743,13 @@ a:focus, a:hover {

edit regions in a <a href="#type_LinkedEditGroup">LinkedEditGroup</a>.

- <dl><dt class="field">value (String)</dt><dd>

+ <dl><dt class="field">value: String</dt><dd>

The value that could be used to replace all of the linked edit

regions.

- </dd><dt class="field">kind (<a href="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKind</a>)</dt><dd>

+ </dd><dt class="field">kind: <a href="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKind</a></dt><dd>

The kind of value being proposed.

@@ -1768,28 +1765,28 @@ a:focus, a:hover {

A location (character range) within a file.

- <dl><dt class="field">file (<a href="#type_FilePath">FilePath</a>)</dt><dd>

+ <dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

The file containing the range.

- </dd><dt class="field">offset (int)</dt><dd>

+ </dd><dt class="field">offset: int</dt><dd>

The offset of the range.

- </dd><dt class="field">length (int)</dt><dd>

+ </dd><dt class="field">length: int</dt><dd>

The length of the range.

- </dd><dt class="field">startLine (int)</dt><dd>

+ </dd><dt class="field">startLine: int</dt><dd>

The one-based index of the line containing the first character of the

range.

- </dd><dt class="field">startColumn (int)</dt><dd>

+ </dd><dt class="field">startColumn: int</dt><dd>

The one-based index of the column containing the first character of

@@ -1801,17 +1798,17 @@ a:focus, a:hover {

declaration of an element.

- <dl><dt class="field">offset (int)</dt><dd>

+ <dl><dt class="field">offset: int</dt><dd>

The offset of the region from which the user can navigate.

- </dd><dt class="field">length (int)</dt><dd>

+ </dd><dt class="field">length: int</dt><dd>

The length of the region from which the user can navigate.

- </dd><dt class="field">targets (List<int>)</dt><dd>

+ </dd><dt class="field">targets: List<int></dt><dd>

The indexes of the targets (in the enclosing navigation response) to

@@ -1823,34 +1820,34 @@ a:focus, a:hover {

A description of a target to which the user can navigate.

- <dl><dt class="field">kind (<a href="#type_ElementKind">ElementKind</a>)</dt><dd>

+ <dl><dt class="field">kind: <a href="#type_ElementKind">ElementKind</a></dt><dd>

The kind of the element.

- </dd><dt class="field">fileIndex (int)</dt><dd>

+ </dd><dt class="field">fileIndex: int</dt><dd>

The index of the file (in the enclosing navigation response) to

navigate to.

- </dd><dt class="field">offset (int)</dt><dd>

+ </dd><dt class="field">offset: int</dt><dd>

The offset of the region to which the user can navigate.

- </dd><dt class="field">length (int)</dt><dd>

+ </dd><dt class="field">length: int</dt><dd>

The length of the region to which the user can navigate.

- </dd><dt class="field">startLine (int)</dt><dd>

+ </dd><dt class="field">startLine: int</dt><dd>

The one-based index of the line containing the first character of the

region.

- </dd><dt class="field">startColumn (int)</dt><dd>

+ </dd><dt class="field">startColumn: int</dt><dd>

The one-based index of the column containing the first character of

@@ -1861,17 +1858,17 @@ a:focus, a:hover {

A description of the references to a single element within a single file.

- <dl><dt class="field">element (<a href="#type_Element">Element</a>)</dt><dd>

+ <dl><dt class="field">element: <a href="#type_Element">Element</a></dt><dd>

The element that was referenced.

- </dd><dt class="field">offsets (List<int>)</dt><dd>

+ </dd><dt class="field">offsets: List<int></dt><dd>

The offsets of the name of the referenced element within the file.

- </dd><dt class="field">length (int)</dt><dd>

+ </dd><dt class="field">length: int</dt><dd>

The length of the name of the referenced element.

@@ -1881,12 +1878,12 @@ a:focus, a:hover {

An node in the outline structure of a file.

- <dl><dt class="field">element (<a href="#type_Element">Element</a>)</dt><dd>

+ <dl><dt class="field">element: <a href="#type_Element">Element</a></dt><dd>

A description of the element represented by this node.

- </dd><dt class="field">offset (int)</dt><dd>

+ </dd><dt class="field">offset: int</dt><dd>

The offset of the first character of the element. This is different

@@ -1894,12 +1891,12 @@ a:focus, a:hover {

element. It can be used, for example, to map locations in the file

back to an outline.

- </dd><dt class="field">length (int)</dt><dd>

+ </dd><dt class="field">length: int</dt><dd>

The length of the element.

- </dd><dt class="field">children (optional List<<a href="#type_Outline">Outline</a>>)</dt><dd>

+ </dd><dt class="field">children: List<<a href="#type_Outline">Outline</a>> (optional)</dt><dd>

The children of the node. The field will be omitted if the node has no

@@ -1910,12 +1907,12 @@ a:focus, a:hover {

A position within a file.

- <dl><dt class="field">file (<a href="#type_FilePath">FilePath</a>)</dt><dd>

+ <dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

The file containing the position.

- </dd><dt class="field">offset (int)</dt><dd>

+ </dd><dt class="field">offset: int</dt><dd>

The offset of the position.

@@ -1925,13 +1922,13 @@ a:focus, a:hover {

A source change that has a priority associated with it.

- <dl><dt class="field">priority (int)</dt><dd>

+ <dl><dt class="field">priority: int</dt><dd>

The priority of the change. The value is expected to be non-negative,

and zero (0) is the lowest priority.

- </dd><dt class="field">change (<a href="#type_SourceChange">SourceChange</a>)</dt><dd>

+ </dd><dt class="field">change: <a href="#type_SourceChange">SourceChange</a></dt><dd>

The change with which the relevance is associated.

@@ -1952,29 +1949,29 @@ a:focus, a:hover {

A description of a parameter in a method refactoring.

- <dl><dt class="field">id (optional String)</dt><dd>

+ <dl><dt class="field">id: String (optional)</dt><dd>

The unique identifier of the parameter. Clients may omit this field

for the parameters they want to add.

- </dd><dt class="field">kind (<a href="#type_RefactoringMethodParameterKind">RefactoringMethodParameterKind</a>)</dt><dd>

+ </dd><dt class="field">kind: <a href="#type_RefactoringMethodParameterKind">RefactoringMethodParameterKind</a></dt><dd>

The kind of the parameter.

- </dd><dt class="field">type (String)</dt><dd>

+ </dd><dt class="field">type: String</dt><dd>

The type that should be given to the parameter, or the return type of

the parameter's function type.

- </dd><dt class="field">name (String)</dt><dd>

+ </dd><dt class="field">name: String</dt><dd>

The name that should be given to the parameter.

- </dd><dt class="field">parameters (optional String)</dt><dd>

+ </dd><dt class="field">parameters: String (optional)</dt><dd>

The parameter list of the parameter's function type. If the parameter

@@ -1997,17 +1994,17 @@ a:focus, a:hover {

A description of a problem related to a refactoring.

- <dl><dt class="field">severity (<a href="#type_RefactoringProblemSeverity">RefactoringProblemSeverity</a>)</dt><dd>

+ <dl><dt class="field">severity: <a href="#type_RefactoringProblemSeverity">RefactoringProblemSeverity</a></dt><dd>

The severity of the problem being represented.

- </dd><dt class="field">message (String)</dt><dd>

+ </dd><dt class="field">message: String</dt><dd>

A human-readable description of the problem being represented.

- </dd><dt class="field">location (optional <a href="#type_Location">Location</a>)</dt><dd>

+ </dd><dt class="field">location: <a href="#type_Location">Location</a> (optional)</dt><dd>

The location of the problem being represented. This field is omitted

@@ -2072,17 +2069,17 @@ a:focus, a:hover {

typically in response to a request.

- <dl><dt class="field">code (<a href="#type_RequestErrorCode">RequestErrorCode</a>)</dt><dd>

+ <dl><dt class="field">code: <a href="#type_RequestErrorCode">RequestErrorCode</a></dt><dd>

A code that uniquely identifies the error that occurred.

- </dd><dt class="field">message (String)</dt><dd>

+ </dd><dt class="field">message: String</dt><dd>

A short description of the error.

- </dd><dt class="field">stackTrace (optional String)</dt><dd>

+ </dd><dt class="field">stackTrace: String (optional)</dt><dd>

The stack trace associated with processing the request, used for

@@ -2135,23 +2132,23 @@ a:focus, a:hover {

A description of a set of edits that implement a single conceptual change.

- <dl><dt class="field">message (String)</dt><dd>

+ <dl><dt class="field">message: String</dt><dd>

A human-readable description of the change to be applied.

- </dd><dt class="field">edits (List<<a href="#type_SourceFileEdit">SourceFileEdit</a>>)</dt><dd>

+ </dd><dt class="field">edits: List<<a href="#type_SourceFileEdit">SourceFileEdit</a>></dt><dd>

A list of the edits used to effect the change, grouped by file.

- </dd><dt class="field">linkedEditGroups (List<<a href="#type_LinkedEditGroup">LinkedEditGroup</a>>)</dt><dd>

+ </dd><dt class="field">linkedEditGroups: List<<a href="#type_LinkedEditGroup">LinkedEditGroup</a>></dt><dd>

A list of the linked editing groups used to customize the changes that

were made.

- </dd><dt class="field">selection (optional <a href="#type_Position">Position</a>)</dt><dd>

+ </dd><dt class="field">selection: <a href="#type_Position">Position</a> (optional)</dt><dd>

The position that should be selected after the edits have been

@@ -2162,22 +2159,22 @@ a:focus, a:hover {

A description of a single change to a single file.

- <dl><dt class="field">offset (int)</dt><dd>

+ <dl><dt class="field">offset: int</dt><dd>

The offset of the region to be modified.

- </dd><dt class="field">length (int)</dt><dd>

+ </dd><dt class="field">length: int</dt><dd>

The length of the region to be modified.

- </dd><dt class="field">replacement (String)</dt><dd>

+ </dd><dt class="field">replacement: String</dt><dd>

The code that is to replace the specified region in the original code.

- </dd><dt class="field">id (optional String)</dt><dd>

+ </dd><dt class="field">id: String (optional)</dt><dd>

An identifier that uniquely identifies this source edit from other

@@ -2195,12 +2192,12 @@ a:focus, a:hover {

A description of a set of changes to a single file.

- <dl><dt class="field">file (<a href="#type_FilePath">FilePath</a>)</dt><dd>

+ <dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

The file containing the code to be modified.

- </dd><dt class="field">fileStamp (long)</dt><dd>

+ </dd><dt class="field">fileStamp: long</dt><dd>

The modification stamp of the file at the moment when the change was

@@ -2209,7 +2206,7 @@ a:focus, a:hover {

field to make sure that the file was not changed since then, so it is

safe to apply the change.

- </dd><dt class="field">edits (List<<a href="#type_SourceEdit">SourceEdit</a>>)</dt><dd>

+ </dd><dt class="field">edits: List<<a href="#type_SourceEdit">SourceEdit</a>></dt><dd>

A list of the edits used to effect the change.

@@ -2219,12 +2216,12 @@ a:focus, a:hover {

A watch event sent by the server when the file system has been modified.

- <dl><dt class="field">type (<a href="#type_WatchEventType">WatchEventType</a>)</dt><dd>

+ <dl><dt class="field">type: <a href="#type_WatchEventType">WatchEventType</a></dt><dd>

The type of change represented by this event.

- </dd><dt class="field">path (String)</dt><dd>

+ </dd><dt class="field">path: String</dt><dd>

The absolute path of the file or directory that changed.

@@ -2299,30 +2296,30 @@ a:focus, a:hover {

- <h4>Feedback:</h4><dl><dt class="field">coveringExpressionOffsets (optional List<int>)</dt><dd>

+ <h4>Feedback:</h4><dl><dt class="field">coveringExpressionOffsets: List<int> (optional)</dt><dd>

The offsets of the expressions that cover the specified selection,

from the down most to the up most.

- </dd><dt class="field">coveringExpressionLengths (optional List<int>)</dt><dd>

+ </dd><dt class="field">coveringExpressionLengths: List<int> (optional)</dt><dd>

The lengths of the expressions that cover the specified selection,

from the down most to the up most.

- </dd><dt class="field">names (List<String>)</dt><dd>

+ </dd><dt class="field">names: List<String></dt><dd>

The proposed names for the local variable.

- </dd><dt class="field">offsets (List<int>)</dt><dd>

+ </dd><dt class="field">offsets: List<int></dt><dd>

The offsets of the expressions that would be replaced by a reference

to the variable.

- </dd><dt class="field">lengths (List<int>)</dt><dd>

+ </dd><dt class="field">lengths: List<int></dt><dd>

The lengths of the expressions that would be replaced by a reference

@@ -2330,12 +2327,12 @@ a:focus, a:hover {

words, for a given expression, if the offset of that expression is

offsets[i], then the length of that expression is lengths[i].

- </dd></dl><h4>Options:</h4><dl><dt class="field">name (String)</dt><dd>

+ </dd></dl><h4>Options:</h4><dl><dt class="field">name: String</dt><dd>

The name that the local variable should be given.

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

+ </dd><dt class="field">extractAll: bool</dt><dd>

True if all occurrences of the expression within the scope in which

@@ -2355,46 +2352,46 @@ a:focus, a:hover {

- <h4>Feedback:</h4><dl><dt class="field">offset (int)</dt><dd>

+ <h4>Feedback:</h4><dl><dt class="field">offset: int</dt><dd>

The offset to the beginning of the expression or statements that will

be extracted.

- </dd><dt class="field">length (int)</dt><dd>

+ </dd><dt class="field">length: int</dt><dd>

The length of the expression or statements that will be extracted.

- </dd><dt class="field">returnType (String)</dt><dd>

+ </dd><dt class="field">returnType: String</dt><dd>

The proposed return type for the method. If the returned element does

not have a declared return type, this field will contain an empty

string.

- </dd><dt class="field">names (List<String>)</dt><dd>

+ </dd><dt class="field">names: List<String></dt><dd>

The proposed names for the method.

- </dd><dt class="field">canCreateGetter (bool)</dt><dd>

+ </dd><dt class="field">canCreateGetter: bool</dt><dd>

True if a getter could be created rather than a method.

- </dd><dt class="field">parameters (List<<a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a>>)</dt><dd>

+ </dd><dt class="field">parameters: List<<a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a>></dt><dd>

The proposed parameters for the method.

- </dd><dt class="field">offsets (List<int>)</dt><dd>

+ </dd><dt class="field">offsets: List<int></dt><dd>

The offsets of the expressions or statements that would be replaced by

an invocation of the method.

- </dd><dt class="field">lengths (List<int>)</dt><dd>

+ </dd><dt class="field">lengths: List<int></dt><dd>

The lengths of the expressions or statements that would be replaced by

@@ -2403,23 +2400,23 @@ a:focus, a:hover {

offset of that expression is offsets[i], then the length of that

expression is lengths[i].

- </dd></dl><h4>Options:</h4><dl><dt class="field">returnType (String)</dt><dd>

+ </dd></dl><h4>Options:</h4><dl><dt class="field">returnType: String</dt><dd>

The return type that should be defined for the method.

- </dd><dt class="field">createGetter (bool)</dt><dd>

+ </dd><dt class="field">createGetter: bool</dt><dd>

True if a getter should be created rather than a method. It is an

error if this field is true and the list of parameters is non-empty.

- </dd><dt class="field">name (String)</dt><dd>

+ </dd><dt class="field">name: String</dt><dd>

The name that the method should be given.

- </dd><dt class="field">parameters (List<<a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a>>)</dt><dd>

+ </dd><dt class="field">parameters: List<<a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a>></dt><dd>

The parameters that should be defined for the method.

@@ -2441,7 +2438,7 @@ a:focus, a:hover {

To remove some parameters, omit them in this list.

</li>

</ul>

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

+ </dd><dt class="field">extractAll: bool</dt><dd>

True if all occurrences of the expression or statements should be

@@ -2458,12 +2455,12 @@ a:focus, a:hover {

the name of a single local variable.

- <h4>Feedback:</h4><dl><dt class="field">name (String)</dt><dd>

+ <h4>Feedback:</h4><dl><dt class="field">name: String</dt><dd>

The name of the variable being inlined.

- </dd><dt class="field">occurrences (int)</dt><dd>

+ </dd><dt class="field">occurrences: int</dt><dd>

The number of times the variable occurs.

@@ -2478,30 +2475,30 @@ a:focus, a:hover {

- <h4>Feedback:</h4><dl><dt class="field">className (optional String)</dt><dd>

+ <h4>Feedback:</h4><dl><dt class="field">className: String (optional)</dt><dd>

The name of the class enclosing the method being inlined. If not a

class member is being inlined, this field will be absent.

- </dd><dt class="field">methodName (String)</dt><dd>

+ </dd><dt class="field">methodName: String</dt><dd>

The name of the method (or function) being inlined.

- </dd><dt class="field">isDeclaration (bool)</dt><dd>

+ </dd><dt class="field">isDeclaration: bool</dt><dd>

True if the declaration of the method is selected and all references

should be inlined.

- </dd></dl><h4>Options:</h4><dl><dt class="field">deleteSource (bool)</dt><dd>

+ </dd></dl><h4>Options:</h4><dl><dt class="field">deleteSource: bool</dt><dd>

True if the method being inlined should be removed. It is an error if

this field is true and inlineAll is false.

- </dd><dt class="field">inlineAll (bool)</dt><dd>

+ </dd><dt class="field">inlineAll: bool</dt><dd>

True if all invocations of the method should be inlined, or false if

@@ -2523,7 +2520,7 @@ a:focus, a:hover {

file specified in the request specifies the file to be moved.

- <h4>Feedback:</h4>none<h4>Options:</h4><dl><dt class="field">newFile (<a href="#type_FilePath">FilePath</a>)</dt><dd>

+ <h4>Feedback:</h4>none<h4>Options:</h4><dl><dt class="field">newFile: <a href="#type_FilePath">FilePath</a></dt><dd>

The new file path to which the given file is being moved.

@@ -2540,28 +2537,28 @@ a:focus, a:hover {

- <h4>Feedback:</h4><dl><dt class="field">offset (int)</dt><dd>

+ <h4>Feedback:</h4><dl><dt class="field">offset: int</dt><dd>

The offset to the beginning of the name selected to be renamed.

- </dd><dt class="field">length (int)</dt><dd>

+ </dd><dt class="field">length: int</dt><dd>

The length of the name selected to be renamed.

- </dd><dt class="field">elementKindName (String)</dt><dd>

+ </dd><dt class="field">elementKindName: String</dt><dd>

The human-readable description of the kind of element being renamed

(such as “class” or “function type alias”).

- </dd><dt class="field">oldName (String)</dt><dd>

+ </dd><dt class="field">oldName: String</dt><dd>

The old name of the element before the refactoring.

- </dd></dl><h4>Options:</h4><dl><dt class="field">newName (String)</dt><dd>

+ </dd></dl><h4>Options:</h4><dl><dt class="field">newName: String</dt><dd>

The name that the element should have after the refactoring.