Index: pkg/analysis_server/doc/api.html |
diff --git a/pkg/analysis_server/doc/api.html b/pkg/analysis_server/doc/api.html |
index 343d50be2a5cb3372cd4f0a46141765072552819..f7cc3879bcc56bc2004e45c7037f9976a0193256 100644 |
--- a/pkg/analysis_server/doc/api.html |
+++ b/pkg/analysis_server/doc/api.html |
@@ -1,60 +1,110 @@ |
<!DOCTYPE html><html><head> |
<meta charset="UTF-8"> |
<title>Analysis Server API Specification</title> |
- <style>body { |
- font-family: sans-serif, serif; |
- padding-left: 5%; |
- padding-right: 5%; |
+ <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Code+Pro|Roboto:500,400italic,300,400" type="text/css"><style>body { |
+ font-family: 'Roboto', sans-serif; |
+ max-width: 800px; |
+ margin: 0 auto; |
+ padding: 0 16px; |
+ font-size: 16px; |
+ line-height: 1.5; |
+ color: #111; |
+ background-color: #fdfdfd; |
+ font-weight: 300; |
+ -webkit-font-smoothing: auto; |
} |
+ |
h1 { |
text-align: center; |
} |
+ |
+h2, h3, h4, h5 { |
+ margin-bottom: 0; |
+} |
+ |
h2.domain { |
- border-bottom: 3px solid rgb(160, 160, 160); |
+ border-bottom: 1px solid rgb(200, 200, 200); |
+ margin-bottom: 0.5em; |
+} |
+ |
+h4 { |
+ font-size: 18px; |
+} |
+ |
+h5 { |
+ font-size: 16px; |
+} |
+ |
+p { |
+ margin-top: 0; |
} |
+ |
pre { |
- margin: 0px; |
+ margin: 0; |
+ font-family: 'Source Code Pro', monospace; |
+ font-size: 15px; |
} |
+ |
div.box { |
- border: 1px solid rgb(0, 0, 0); |
- background-color: rgb(207, 226, 243); |
- padding: 0.5em; |
+ background-color: rgb(240, 245, 240); |
+ border-radius: 4px; |
+ padding: 4px 12px; |
+ margin: 16px 0; |
} |
+ |
div.hangingIndent { |
padding-left: 3em; |
text-indent: -3em; |
} |
+ |
+dl dt { |
+ font-weight: bold; |
+} |
+ |
+dl dd { |
+ margin-left: 16px; |
+} |
+ |
dt { |
margin-top: 1em; |
- margin-bottom: 1em; |
} |
+ |
dt.notification { |
font-weight: bold; |
} |
+ |
dt.refactoring { |
font-weight: bold; |
} |
+ |
dt.request { |
font-weight: bold; |
} |
+ |
dt.typeDefinition { |
font-weight: bold; |
} |
-*/ |
-* Styles for index |
-*/ |
+a { |
+ text-decoration: none; |
+} |
+ |
+a:focus, a:hover { |
+ text-decoration: underline; |
+} |
+ |
+/* Styles for index */ |
.subindex { |
} |
.subindex ul { |
- padding-left: 0px; |
- margin-left: 0px; |
+ padding-left: 0; |
+ margin-left: 0; |
- -webkit-margin-before: 0px; |
- -webkit-margin-start: 0px; |
- -webkit-padding-start: 0px; |
+ -webkit-margin-before: 0; |
+ -webkit-margin-start: 0; |
+ -webkit-padding-start: 0; |
list-style-type: none; |
} |
@@ -67,7 +117,7 @@ dt.typeDefinition { |
analysis server. The API in this document is currently under |
development. Changes to the API will be accompanied by an update to the |
protocol version number according to the principles of semantic |
- versioning <a href="http://semver.org/">http://semver.org/</a>. |
+ versioning (<a href="http://semver.org/">semver.org</a>). |
</p> |
<h2>Overview</h2> |
<p> |
@@ -173,7 +223,7 @@ dt.typeDefinition { |
</p> |
<h3>Eventual Consistency</h3> |
<p> |
- TBD |
+ TODO: TBD |
</p> |
<h3>Domains</h3> |
<p> |
@@ -237,7 +287,7 @@ dt.typeDefinition { |
</dd> |
</dl> |
</blockquote> |
- <h2 class="domain"><a name="domain_server">Domain: server</a></h2> |
+ <h2 class="domain"><a name="domain_server">server domain</a></h2> |
<p> |
The server domain contains API’s related to the execution of |
the server. |
@@ -260,7 +310,7 @@ dt.typeDefinition { |
}</pre></div> |
<p>Return the version number of the analysis server.</p> |
- <h4>Returns</h4><dl><dt class="field"><b><i>version ( String )</i></b></dt><dd> |
+ <h4>returns:</h4><dl><dt class="field"><b>version (String)</b></dt><dd> |
<p>The version number of the analysis server.</p> |
</dd></dl></dd><dt class="request"><a name="request_server.shutdown">server.shutdown</a> (<a href="#request_server.shutdown">#</a>)</dt><dd><div class="box"><pre>request: { |
@@ -298,7 +348,7 @@ dt.typeDefinition { |
subscriptions will remain unchanged. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( List<<a href="#type_ServerService">ServerService</a>> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>subscriptions (List<<a href="#type_ServerService">ServerService</a>>)</b></dt><dd> |
<p>A list of the services being subscribed to.</p> |
</dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"><a name="notification_server.connected">server.connected</a> (<a href="#notification_server.connected">#</a>)</dt><dd><div class="box"><pre>notification: { |
@@ -319,10 +369,10 @@ dt.typeDefinition { |
notification. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>version ( String )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>version (String)</b></dt><dd> |
<p>The version number of the analysis server.</p> |
- </dd><dt class="field"><b><i>pid ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>pid (int)</b></dt><dd> |
<p>The process id of the analysis server process.</p> |
</dd></dl></dd><dt class="notification"><a name="notification_server.error">server.error</a> (<a href="#notification_server.error">#</a>)</dt><dd><div class="box"><pre>notification: { |
@@ -346,20 +396,20 @@ dt.typeDefinition { |
notification. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>isFatal ( bool )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>isFatal (bool)</b></dt><dd> |
<p> |
True if the error is a fatal error, meaning that the |
server will shutdown automatically after sending this |
notification. |
</p> |
- </dd><dt class="field"><b><i>message ( String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>message (String)</b></dt><dd> |
<p> |
The error message indicating what kind of error was |
encountered. |
</p> |
- </dd><dt class="field"><b><i>stackTrace ( String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>stackTrace (String)</b></dt><dd> |
<p> |
The stack trace associated with the generation of the |
@@ -384,21 +434,21 @@ dt.typeDefinition { |
request. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>analysis ( <span style="color:#999999">optional</span> <a href="#type_AnalysisStatus">AnalysisStatus</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>analysis (<span style="color:#999999">optional</span> <a href="#type_AnalysisStatus">AnalysisStatus</a>)</b></dt><dd> |
<p> |
The current status of analysis, including whether |
analysis is being performed and if so what is being |
analyzed. |
</p> |
- </dd><dt class="field"><b><i>pub ( <span style="color:#999999">optional</span> <a href="#type_PubStatus">PubStatus</a> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>pub (<span style="color:#999999">optional</span> <a href="#type_PubStatus">PubStatus</a>)</b></dt><dd> |
<p> |
The current status of pub execution, indicating whether we are |
currently running pub. |
</p> |
</dd></dl></dd></dl> |
- <h2 class="domain"><a name="domain_analysis">Domain: analysis</a></h2> |
+ <h2 class="domain"><a name="domain_analysis">analysis domain</a></h2> |
<p> |
The analysis domain contains API’s related to the analysis of |
files. |
@@ -468,12 +518,12 @@ dt.typeDefinition { |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file for which errors are being requested. |
</p> |
- </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>errors ( List<<a href="#type_AnalysisError">AnalysisError</a>> )</i></b></dt><dd> |
+ </dd></dl><h4>returns:</h4><dl><dt class="field"><b>errors (List<<a href="#type_AnalysisError">AnalysisError</a>>)</b></dt><dd> |
<p> |
The errors associated with the file. |
@@ -500,17 +550,17 @@ dt.typeDefinition { |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file in which hover information is being requested. |
</p> |
- </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>offset (int)</b></dt><dd> |
<p> |
The offset for which hover information is being requested. |
</p> |
- </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>hovers ( List<<a href="#type_HoverInformation">HoverInformation</a>> )</i></b></dt><dd> |
+ </dd></dl><h4>returns:</h4><dl><dt class="field"><b>hovers (List<<a href="#type_HoverInformation">HoverInformation</a>>)</b></dt><dd> |
<p> |
The hover information associated with the |
@@ -545,12 +595,12 @@ dt.typeDefinition { |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file for which reachable source information is being requested. |
</p> |
- </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>sources ( Map<String, List<String>> )</i></b></dt><dd> |
+ </dd></dl><h4>returns:</h4><dl><dt class="field"><b>sources (Map<String, List<String>>)</b></dt><dd> |
<p> |
A mapping from source URIs to directly reachable source URIs. For example, |
@@ -580,13 +630,13 @@ dt.typeDefinition { |
analyzedFiles notification instead. |
</p> |
- <h4>Returns</h4><dl><dt class="field"><b><i>libraries ( List<<a href="#type_FilePath">FilePath</a>> )</i></b></dt><dd> |
+ <h4>returns:</h4><dl><dt class="field"><b>libraries (List<<a href="#type_FilePath">FilePath</a>>)</b></dt><dd> |
<p> |
A list of the paths of library elements referenced by |
files in existing analysis roots. |
</p> |
- </dd><dt class="field"><b><i>packageMap ( Map<String, Map<String, List<<a href="#type_FilePath">FilePath</a>>>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>packageMap (Map<String, Map<String, List<<a href="#type_FilePath">FilePath</a>>>>)</b></dt><dd> |
<p> |
A mapping from context source roots to package maps which map |
@@ -637,36 +687,36 @@ dt.typeDefinition { |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file in which navigation information is being requested. |
</p> |
- </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>offset (int)</b></dt><dd> |
<p> |
The offset of the region for which navigation information is being |
requested. |
</p> |
- </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>length (int)</b></dt><dd> |
<p> |
The length of the region for which navigation information is being |
requested. |
</p> |
- </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>files ( List<<a href="#type_FilePath">FilePath</a>> )</i></b></dt><dd> |
+ </dd></dl><h4>returns:</h4><dl><dt class="field"><b>files (List<<a href="#type_FilePath">FilePath</a>>)</b></dt><dd> |
<p> |
A list of the paths of files that are referenced by the navigation |
targets. |
</p> |
- </dd><dt class="field"><b><i>targets ( List<<a href="#type_NavigationTarget">NavigationTarget</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>targets (List<<a href="#type_NavigationTarget">NavigationTarget</a>>)</b></dt><dd> |
<p> |
A list of the navigation targets that are referenced by the |
navigation regions. |
</p> |
- </dd><dt class="field"><b><i>regions ( List<<a href="#type_NavigationRegion">NavigationRegion</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>regions (List<<a href="#type_NavigationRegion">NavigationRegion</a>>)</b></dt><dd> |
<p> |
A list of the navigation regions within the requested region of |
@@ -696,7 +746,7 @@ dt.typeDefinition { |
<tt>INVALID_ANALYSIS_ROOT</tt> will be generated. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>roots ( <span style="color:#999999">optional</span> List<<a href="#type_FilePath">FilePath</a>> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>roots (<span style="color:#999999">optional</span> List<<a href="#type_FilePath">FilePath</a>>)</b></dt><dd> |
<p> |
A list of the analysis roots that are to be re-analyzed. |
@@ -746,19 +796,19 @@ dt.typeDefinition { |
be used to resolve package: URI’s within the file. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>included ( List<<a href="#type_FilePath">FilePath</a>> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>included (List<<a href="#type_FilePath">FilePath</a>>)</b></dt><dd> |
<p> |
A list of the files and directories that should be |
analyzed. |
</p> |
- </dd><dt class="field"><b><i>excluded ( List<<a href="#type_FilePath">FilePath</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>excluded (List<<a href="#type_FilePath">FilePath</a>>)</b></dt><dd> |
<p> |
A list of the files and directories within the |
included directories that should not be analyzed. |
</p> |
- </dd><dt class="field"><b><i>packageRoots ( <span style="color:#999999">optional</span> Map<<a href="#type_FilePath">FilePath</a>, <a href="#type_FilePath">FilePath</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>packageRoots (<span style="color:#999999">optional</span> Map<<a href="#type_FilePath">FilePath</a>, <a href="#type_FilePath">FilePath</a>>)</b></dt><dd> |
<p> |
A mapping from source directories to package roots |
@@ -810,7 +860,7 @@ dt.typeDefinition { |
remain unchanged. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( List<<a href="#type_GeneralAnalysisService">GeneralAnalysisService</a>> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>subscriptions (List<<a href="#type_GeneralAnalysisService">GeneralAnalysisService</a>>)</b></dt><dd> |
<p>A list of the services being subscribed to.</p> |
</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: { |
@@ -849,7 +899,7 @@ dt.typeDefinition { |
actual priority files. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>files ( List<<a href="#type_FilePath">FilePath</a>> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>files (List<<a href="#type_FilePath">FilePath</a>>)</b></dt><dd> |
<p> |
The files that are to be a priority for analysis. |
@@ -898,7 +948,7 @@ dt.typeDefinition { |
subscriptions will remain unchanged. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( Map<<a href="#type_AnalysisService">AnalysisService</a>, List<<a href="#type_FilePath">FilePath</a>>> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>subscriptions (Map<<a href="#type_AnalysisService">AnalysisService</a>, List<<a href="#type_FilePath">FilePath</a>>>)</b></dt><dd> |
<p> |
A table mapping services to a list of the files being |
@@ -928,13 +978,13 @@ dt.typeDefinition { |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>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>> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>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>>)</b></dt><dd> |
<p> |
A table mapping the files whose content has changed to a |
description of the content change. |
</p> |
- </dd></dl><h4>Returns</h4><dl></dl></dd><dt class="request"><a name="request_analysis.updateOptions">analysis.updateOptions</a> (<a href="#request_analysis.updateOptions">#</a>)</dt><dd><div class="box"><pre>request: { |
+ </dd></dl><h4>returns:</h4><dl></dl></dd><dt class="request"><a name="request_analysis.updateOptions">analysis.updateOptions</a> (<a href="#request_analysis.updateOptions">#</a>)</dt><dd><div class="box"><pre>request: { |
"id": String |
"method": "analysis.updateOptions" |
"params": { |
@@ -952,7 +1002,7 @@ dt.typeDefinition { |
silently ignored. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>options ( <a href="#type_AnalysisOptions">AnalysisOptions</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>options (<a href="#type_AnalysisOptions">AnalysisOptions</a>)</b></dt><dd> |
<p> |
The options that are to be used to control analysis. |
@@ -972,7 +1022,7 @@ dt.typeDefinition { |
of services passed in an analysis.setGeneralSubscriptions request. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>directories ( List<<a href="#type_FilePath">FilePath</a>> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>directories (List<<a href="#type_FilePath">FilePath</a>>)</b></dt><dd> |
<p> |
A list of the paths of the files that are being analyzed. |
@@ -994,12 +1044,12 @@ dt.typeDefinition { |
using the command-line flag --no-error-notification. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file containing the errors. |
</p> |
- </dd><dt class="field"><b><i>errors ( List<<a href="#type_AnalysisError">AnalysisError</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>errors (List<<a href="#type_AnalysisError">AnalysisError</a>>)</b></dt><dd> |
<p> |
The errors contained in the file. |
@@ -1028,7 +1078,7 @@ dt.typeDefinition { |
notification. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>files ( List<<a href="#type_FilePath">FilePath</a>> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>files (List<<a href="#type_FilePath">FilePath</a>>)</b></dt><dd> |
<p> |
The files that are no longer being analyzed. |
@@ -1054,12 +1104,12 @@ dt.typeDefinition { |
request. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file containing the folding regions. |
</p> |
- </dd><dt class="field"><b><i>regions ( List<<a href="#type_FoldingRegion">FoldingRegion</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>regions (List<<a href="#type_FoldingRegion">FoldingRegion</a>>)</b></dt><dd> |
<p> |
The folding regions contained in the file. |
@@ -1081,12 +1131,12 @@ dt.typeDefinition { |
analysis.setSubscriptions request. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file containing the highlight regions. |
</p> |
- </dd><dt class="field"><b><i>regions ( List<<a href="#type_HighlightRegion">HighlightRegion</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>regions (List<<a href="#type_HighlightRegion">HighlightRegion</a>>)</b></dt><dd> |
<p> |
The highlight regions contained in the file. Each |
@@ -1115,17 +1165,17 @@ dt.typeDefinition { |
request. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file with which the implementations are associated. |
</p> |
- </dd><dt class="field"><b><i>classes ( List<<a href="#type_ImplementedClass">ImplementedClass</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>classes (List<<a href="#type_ImplementedClass">ImplementedClass</a>>)</b></dt><dd> |
<p> |
The classes defined in the file that are implemented or extended. |
</p> |
- </dd><dt class="field"><b><i>members ( List<<a href="#type_ImplementedMember">ImplementedMember</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>members (List<<a href="#type_ImplementedMember">ImplementedMember</a>>)</b></dt><dd> |
<p> |
The member defined in the file that are implemented or overridden. |
@@ -1149,22 +1199,22 @@ dt.typeDefinition { |
services passed in an analysis.setSubscriptions request. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file whose information has been invalidated. |
</p> |
- </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>offset (int)</b></dt><dd> |
<p> |
The offset of the invalidated region. |
</p> |
- </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>length (int)</b></dt><dd> |
<p> |
The length of the invalidated region. |
</p> |
- </dd><dt class="field"><b><i>delta ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>delta (int)</b></dt><dd> |
<p> |
The delta to be applied to the offsets in information that follows |
@@ -1190,12 +1240,12 @@ dt.typeDefinition { |
analysis.setSubscriptions request. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file containing the navigation regions. |
</p> |
- </dd><dt class="field"><b><i>regions ( List<<a href="#type_NavigationRegion">NavigationRegion</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>regions (List<<a href="#type_NavigationRegion">NavigationRegion</a>>)</b></dt><dd> |
<p> |
The navigation regions contained in the file. |
@@ -1209,14 +1259,14 @@ dt.typeDefinition { |
regions that are returned do not overlap other |
navigation regions. |
</p> |
- </dd><dt class="field"><b><i>targets ( List<<a href="#type_NavigationTarget">NavigationTarget</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>targets (List<<a href="#type_NavigationTarget">NavigationTarget</a>>)</b></dt><dd> |
<p> |
The navigation targets referenced in the file. |
They are referenced by <tt>NavigationRegion</tt>s by their |
index in this array. |
</p> |
- </dd><dt class="field"><b><i>files ( List<<a href="#type_FilePath">FilePath</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>files (List<<a href="#type_FilePath">FilePath</a>>)</b></dt><dd> |
<p> |
The files containing navigation targets referenced in the file. |
@@ -1241,12 +1291,12 @@ dt.typeDefinition { |
analysis.setSubscriptions request. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file in which the references occur. |
</p> |
- </dd><dt class="field"><b><i>occurrences ( List<<a href="#type_Occurrences">Occurrences</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>occurrences (List<<a href="#type_Occurrences">Occurrences</a>>)</b></dt><dd> |
<p> |
The occurrences of references to elements within the |
@@ -1271,17 +1321,17 @@ dt.typeDefinition { |
request. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file with which the outline is associated. |
</p> |
- </dd><dt class="field"><b><i>kind ( <a href="#type_FileKind">FileKind</a> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>kind (<a href="#type_FileKind">FileKind</a>)</b></dt><dd> |
<p> |
The kind of the file. |
</p> |
- </dd><dt class="field"><b><i>libraryName ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>libraryName (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
The name of the library defined by the file using a "library" |
@@ -1291,7 +1341,7 @@ dt.typeDefinition { |
This field will be omitted if the file has neither "library" |
nor "part of" directives. |
</p> |
- </dd><dt class="field"><b><i>outline ( <a href="#type_Outline">Outline</a> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>outline (<a href="#type_Outline">Outline</a>)</b></dt><dd> |
<p> |
The outline associated with the file. |
@@ -1313,18 +1363,18 @@ dt.typeDefinition { |
request. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file with which the overrides are associated. |
</p> |
- </dd><dt class="field"><b><i>overrides ( List<<a href="#type_Override">Override</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>overrides (List<<a href="#type_Override">Override</a>>)</b></dt><dd> |
<p> |
The overrides associated with the file. |
</p> |
</dd></dl></dd></dl> |
- <h2 class="domain"><a name="domain_completion">Domain: completion</a></h2> |
+ <h2 class="domain"><a name="domain_completion">completion domain</a></h2> |
<p> |
The code completion domain contains commands related to |
getting code completion suggestions. |
@@ -1351,19 +1401,19 @@ dt.typeDefinition { |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file containing the point at which suggestions are |
to be made. |
</p> |
- </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>offset (int)</b></dt><dd> |
<p> |
The offset within the file at which suggestions are to |
be made. |
</p> |
- </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <a href="#type_CompletionId">CompletionId</a> )</i></b></dt><dd> |
+ </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id (<a href="#type_CompletionId">CompletionId</a>)</b></dt><dd> |
<p> |
The identifier used to associate results with this |
@@ -1386,12 +1436,12 @@ dt.typeDefinition { |
previously reported suggestions. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_CompletionId">CompletionId</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>id (<a href="#type_CompletionId">CompletionId</a>)</b></dt><dd> |
<p> |
The id associated with the completion. |
</p> |
- </dd><dt class="field"><b><i>replacementOffset ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>replacementOffset (int)</b></dt><dd> |
<p> |
The offset of the start of the text to be |
@@ -1401,7 +1451,7 @@ dt.typeDefinition { |
offset. In particular, the replacementOffset will be |
the offset of the beginning of said identifier. |
</p> |
- </dd><dt class="field"><b><i>replacementLength ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>replacementLength (int)</b></dt><dd> |
<p> |
The length of the text to be replaced if the remainder |
@@ -1409,7 +1459,7 @@ dt.typeDefinition { |
replaced when the suggestion is applied (that is, the |
number of characters in the existing identifier). |
</p> |
- </dd><dt class="field"><b><i>results ( List<<a href="#type_CompletionSuggestion">CompletionSuggestion</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>results (List<<a href="#type_CompletionSuggestion">CompletionSuggestion</a>>)</b></dt><dd> |
<p> |
The completion suggestions being reported. The |
@@ -1419,14 +1469,14 @@ dt.typeDefinition { |
the client to respond to further keystrokes from the |
user without having to make additional requests. |
</p> |
- </dd><dt class="field"><b><i>isLast ( bool )</i></b></dt><dd> |
+ </dd><dt class="field"><b>isLast (bool)</b></dt><dd> |
<p> |
True if this is that last set of results that will be |
returned for the indicated completion. |
</p> |
</dd></dl></dd></dl> |
- <h2 class="domain"><a name="domain_search">Domain: search</a></h2> |
+ <h2 class="domain"><a name="domain_search">search domain</a></h2> |
<p> |
The search domain contains commands related to searches that |
can be performed against the code base. |
@@ -1464,25 +1514,25 @@ dt.typeDefinition { |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file containing the declaration of or reference to |
the element used to define the search. |
</p> |
- </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>offset (int)</b></dt><dd> |
<p> |
The offset within the file of the declaration of or |
reference to the element. |
</p> |
- </dd><dt class="field"><b><i>includePotential ( bool )</i></b></dt><dd> |
+ </dd><dt class="field"><b>includePotential (bool)</b></dt><dd> |
<p> |
True if potential matches are to be included in the |
results. |
</p> |
- </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <span style="color:#999999">optional</span> <a href="#type_SearchId">SearchId</a> )</i></b></dt><dd> |
+ </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id (<span style="color:#999999">optional</span> <a href="#type_SearchId">SearchId</a>)</b></dt><dd> |
<p> |
The identifier used to associate results with this |
@@ -1493,7 +1543,7 @@ dt.typeDefinition { |
field will be absent, and no results will be reported |
via the search.results notification. |
</p> |
- </dd><dt class="field"><b><i>element ( <span style="color:#999999">optional</span> <a href="#type_Element">Element</a> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>element (<span style="color:#999999">optional</span> <a href="#type_Element">Element</a>)</b></dt><dd> |
<p> |
The element referenced or defined at the given offset |
@@ -1528,12 +1578,12 @@ dt.typeDefinition { |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>name ( String )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>name (String)</b></dt><dd> |
<p> |
The name of the declarations to be found. |
</p> |
- </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <a href="#type_SearchId">SearchId</a> )</i></b></dt><dd> |
+ </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id (<a href="#type_SearchId">SearchId</a>)</b></dt><dd> |
<p> |
The identifier used to associate results with this |
@@ -1565,12 +1615,12 @@ dt.typeDefinition { |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>name ( String )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>name (String)</b></dt><dd> |
<p> |
The name of the references to be found. |
</p> |
- </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <a href="#type_SearchId">SearchId</a> )</i></b></dt><dd> |
+ </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id (<a href="#type_SearchId">SearchId</a>)</b></dt><dd> |
<p> |
The identifier used to associate results with this |
@@ -1601,13 +1651,13 @@ dt.typeDefinition { |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>pattern ( String )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>pattern (String)</b></dt><dd> |
<p> |
The regular expression used to match the names of the |
declarations to be found. |
</p> |
- </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <a href="#type_SearchId">SearchId</a> )</i></b></dt><dd> |
+ </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id (<a href="#type_SearchId">SearchId</a>)</b></dt><dd> |
<p> |
The identifier used to associate results with this |
@@ -1634,24 +1684,24 @@ dt.typeDefinition { |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file containing the declaration or reference to the |
type for which a hierarchy is being requested. |
</p> |
- </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>offset (int)</b></dt><dd> |
<p> |
The offset of the name of the type within the file. |
</p> |
- </dd><dt class="field"><b><i>superOnly ( <span style="color:#999999">optional</span> bool )</i></b></dt><dd> |
+ </dd><dt class="field"><b>superOnly (<span style="color:#999999">optional</span> bool)</b></dt><dd> |
<p> |
True if the client is only requesting superclasses and |
interfaces hierarchy. |
</p> |
- </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>hierarchyItems ( <span style="color:#999999">optional</span> List<<a href="#type_TypeHierarchyItem">TypeHierarchyItem</a>> )</i></b></dt><dd> |
+ </dd></dl><h4>returns:</h4><dl><dt class="field"><b>hierarchyItems (<span style="color:#999999">optional</span> List<<a href="#type_TypeHierarchyItem">TypeHierarchyItem</a>>)</b></dt><dd> |
<p> |
A list of the types in the requested hierarchy. The |
@@ -1683,24 +1733,24 @@ dt.typeDefinition { |
search id. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_SearchId">SearchId</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>id (<a href="#type_SearchId">SearchId</a>)</b></dt><dd> |
<p> |
The id associated with the search. |
</p> |
- </dd><dt class="field"><b><i>results ( List<<a href="#type_SearchResult">SearchResult</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>results (List<<a href="#type_SearchResult">SearchResult</a>>)</b></dt><dd> |
<p> |
The search results being reported. |
</p> |
- </dd><dt class="field"><b><i>isLast ( bool )</i></b></dt><dd> |
+ </dd><dt class="field"><b>isLast (bool)</b></dt><dd> |
<p> |
True if this is that last set of results that will be |
returned for the indicated search. |
</p> |
</dd></dl></dd></dl> |
- <h2 class="domain"><a name="domain_edit">Domain: edit</a></h2> |
+ <h2 class="domain"><a name="domain_edit">edit domain</a></h2> |
<p> |
The edit domain contains commands related to edits that can be |
applied to the code. |
@@ -1749,39 +1799,39 @@ dt.typeDefinition { |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file containing the code to be formatted. |
</p> |
- </dd><dt class="field"><b><i>selectionOffset ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>selectionOffset (int)</b></dt><dd> |
<p> |
The offset of the current selection in the file. |
</p> |
- </dd><dt class="field"><b><i>selectionLength ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>selectionLength (int)</b></dt><dd> |
<p> |
The length of the current selection in the file. |
</p> |
- </dd><dt class="field"><b><i>lineLength ( <span style="color:#999999">optional</span> int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>lineLength (<span style="color:#999999">optional</span> int)</b></dt><dd> |
<p> |
The line length to be used by the formatter. |
</p> |
- </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>edits ( List<<a href="#type_SourceEdit">SourceEdit</a>> )</i></b></dt><dd> |
+ </dd></dl><h4>returns:</h4><dl><dt class="field"><b>edits (List<<a href="#type_SourceEdit">SourceEdit</a>>)</b></dt><dd> |
<p> |
The edit(s) to be applied in order to format the code. The list |
will be empty if the code was already formatted (there are no |
changes). |
</p> |
- </dd><dt class="field"><b><i>selectionOffset ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>selectionOffset (int)</b></dt><dd> |
<p> |
The offset of the selection after formatting the code. |
</p> |
- </dd><dt class="field"><b><i>selectionLength ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>selectionLength (int)</b></dt><dd> |
<p> |
The length of the selection after formatting the code. |
@@ -1809,25 +1859,25 @@ dt.typeDefinition { |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file containing the code for which assists are being |
requested. |
</p> |
- </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>offset (int)</b></dt><dd> |
<p> |
The offset of the code for which assists are being |
requested. |
</p> |
- </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>length (int)</b></dt><dd> |
<p> |
The length of the code for which assists are being |
requested. |
</p> |
- </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>assists ( List<<a href="#type_SourceChange">SourceChange</a>> )</i></b></dt><dd> |
+ </dd></dl><h4>returns:</h4><dl><dt class="field"><b>assists (List<<a href="#type_SourceChange">SourceChange</a>>)</b></dt><dd> |
<p> |
The assists that are available at the given location. |
@@ -1853,25 +1903,25 @@ dt.typeDefinition { |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file containing the code on which the refactoring |
would be based. |
</p> |
- </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>offset (int)</b></dt><dd> |
<p> |
The offset of the code on which the refactoring would be |
based. |
</p> |
- </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>length (int)</b></dt><dd> |
<p> |
The length of the code on which the refactoring would be |
based. |
</p> |
- </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>kinds ( List<<a href="#type_RefactoringKind">RefactoringKind</a>> )</i></b></dt><dd> |
+ </dd></dl><h4>returns:</h4><dl><dt class="field"><b>kinds (List<<a href="#type_RefactoringKind">RefactoringKind</a>>)</b></dt><dd> |
<p> |
The kinds of refactorings that are valid for the given |
@@ -1897,19 +1947,19 @@ dt.typeDefinition { |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file containing the errors for which fixes are being |
requested. |
</p> |
- </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>offset (int)</b></dt><dd> |
<p> |
The offset used to select the errors for which fixes |
will be returned. |
</p> |
- </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>fixes ( List<<a href="#type_AnalysisErrorFixes">AnalysisErrorFixes</a>> )</i></b></dt><dd> |
+ </dd></dl><h4>returns:</h4><dl><dt class="field"><b>fixes (List<<a href="#type_AnalysisErrorFixes">AnalysisErrorFixes</a>>)</b></dt><dd> |
<p> |
The fixes that are available for the errors at the given offset. |
@@ -1947,34 +1997,34 @@ dt.typeDefinition { |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>kind ( <a href="#type_RefactoringKind">RefactoringKind</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>kind (<a href="#type_RefactoringKind">RefactoringKind</a>)</b></dt><dd> |
<p> |
The kind of refactoring to be performed. |
</p> |
- </dd><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file containing the code involved in the |
refactoring. |
</p> |
- </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>offset (int)</b></dt><dd> |
<p> |
The offset of the region involved in the refactoring. |
</p> |
- </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>length (int)</b></dt><dd> |
<p> |
The length of the region involved in the refactoring. |
</p> |
- </dd><dt class="field"><b><i>validateOnly ( bool )</i></b></dt><dd> |
+ </dd><dt class="field"><b>validateOnly (bool)</b></dt><dd> |
<p> |
True if the client is only requesting that the values of |
the options be validated and no change be generated. |
</p> |
- </dd><dt class="field"><b><i>options ( <span style="color:#999999">optional</span> <a href="#type_RefactoringOptions">RefactoringOptions</a> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>options (<span style="color:#999999">optional</span> <a href="#type_RefactoringOptions">RefactoringOptions</a>)</b></dt><dd> |
<p> |
Data used to provide values provided by the user. The |
@@ -1985,14 +2035,14 @@ dt.typeDefinition { |
does not require any options or if the values of those |
options are not known. |
</p> |
- </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>initialProblems ( List<<a href="#type_RefactoringProblem">RefactoringProblem</a>> )</i></b></dt><dd> |
+ </dd></dl><h4>returns:</h4><dl><dt class="field"><b>initialProblems (List<<a href="#type_RefactoringProblem">RefactoringProblem</a>>)</b></dt><dd> |
<p> |
The initial status of the refactoring, i.e. problems related to |
the context in which the refactoring is requested. |
The array will be empty if there are no known problems. |
</p> |
- </dd><dt class="field"><b><i>optionsProblems ( List<<a href="#type_RefactoringProblem">RefactoringProblem</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>optionsProblems (List<<a href="#type_RefactoringProblem">RefactoringProblem</a>>)</b></dt><dd> |
<p> |
The options validation status, i.e. problems in the given options, |
@@ -2000,7 +2050,7 @@ dt.typeDefinition { |
compatibility, etc. |
The array will be empty if there are no known problems. |
</p> |
- </dd><dt class="field"><b><i>finalProblems ( List<<a href="#type_RefactoringProblem">RefactoringProblem</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>finalProblems (List<<a href="#type_RefactoringProblem">RefactoringProblem</a>>)</b></dt><dd> |
<p> |
The final status of the refactoring, i.e. problems identified in |
@@ -2008,7 +2058,7 @@ dt.typeDefinition { |
change creation. |
The array will be empty if there are no known problems. |
</p> |
- </dd><dt class="field"><b><i>feedback ( <span style="color:#999999">optional</span> <a href="#type_RefactoringFeedback">RefactoringFeedback</a> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>feedback (<span style="color:#999999">optional</span> <a href="#type_RefactoringFeedback">RefactoringFeedback</a>)</b></dt><dd> |
<p> |
Data used to provide feedback to the user. The structure |
@@ -2017,7 +2067,7 @@ dt.typeDefinition { |
in the section titled <a href="#refactorings">Refactorings</a>, labeled as |
“Feedback”. |
</p> |
- </dd><dt class="field"><b><i>change ( <span style="color:#999999">optional</span> <a href="#type_SourceChange">SourceChange</a> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>change (<span style="color:#999999">optional</span> <a href="#type_SourceChange">SourceChange</a>)</b></dt><dd> |
<p> |
The changes that are to be applied to affect the |
@@ -2027,7 +2077,7 @@ dt.typeDefinition { |
refactoring that requires them, or if only validation |
was requested. |
</p> |
- </dd><dt class="field"><b><i>potentialEdits ( <span style="color:#999999">optional</span> List<String> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>potentialEdits (<span style="color:#999999">optional</span> List<String>)</b></dt><dd> |
<p> |
The ids of source edits that are not known to be valid. An edit is |
@@ -2066,12 +2116,12 @@ dt.typeDefinition { |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The Dart file to sort. |
</p> |
- </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>edit ( <a href="#type_SourceFileEdit">SourceFileEdit</a> )</i></b></dt><dd> |
+ </dd></dl><h4>returns:</h4><dl><dt class="field"><b>edit (<a href="#type_SourceFileEdit">SourceFileEdit</a>)</b></dt><dd> |
<p> |
The file edit that is to be applied to the given file to effect |
@@ -2108,19 +2158,19 @@ dt.typeDefinition { |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The Dart file to organize directives in. |
</p> |
- </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>edit ( <a href="#type_SourceFileEdit">SourceFileEdit</a> )</i></b></dt><dd> |
+ </dd></dl><h4>returns:</h4><dl><dt class="field"><b>edit (<a href="#type_SourceFileEdit">SourceFileEdit</a>)</b></dt><dd> |
<p> |
The file edit that is to be applied to the given file to effect |
the organizing. |
</p> |
</dd></dl></dd></dl> |
- <h2 class="domain"><a name="domain_execution">Domain: execution</a></h2> |
+ <h2 class="domain"><a name="domain_execution">execution domain</a></h2> |
<p> |
The execution domain contains commands related to providing an execution |
or debugging experience. |
@@ -2151,13 +2201,13 @@ dt.typeDefinition { |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>contextRoot ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>contextRoot (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The path of the Dart or HTML file that will be launched, or the |
path of the directory containing the file. |
</p> |
- </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <a href="#type_ExecutionContextId">ExecutionContextId</a> )</i></b></dt><dd> |
+ </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id (<a href="#type_ExecutionContextId">ExecutionContextId</a>)</b></dt><dd> |
<p> |
The identifier used to refer to the execution context that was |
@@ -2179,7 +2229,7 @@ dt.typeDefinition { |
ids when they are no longer valid. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_ExecutionContextId">ExecutionContextId</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>id (<a href="#type_ExecutionContextId">ExecutionContextId</a>)</b></dt><dd> |
<p> |
The identifier of the execution context that is to be deleted. |
@@ -2230,29 +2280,29 @@ dt.typeDefinition { |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_ExecutionContextId">ExecutionContextId</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>id (<a href="#type_ExecutionContextId">ExecutionContextId</a>)</b></dt><dd> |
<p> |
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> |
+ </dd><dt class="field"><b>file (<span style="color:#999999">optional</span> <a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The path of the file to be mapped into a URI. |
</p> |
- </dd><dt class="field"><b><i>uri ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>uri (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
The URI to be mapped into a file path. |
</p> |
- </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> |
+ </dd></dl><h4>returns:</h4><dl><dt class="field"><b>file (<span style="color:#999999">optional</span> <a href="#type_FilePath">FilePath</a>)</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. |
</p> |
- </dd><dt class="field"><b><i>uri ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>uri (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
The URI to which the file path was mapped. This field is omitted |
@@ -2278,7 +2328,7 @@ dt.typeDefinition { |
remain unchanged. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( List<<a href="#type_ExecutionService">ExecutionService</a>> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>subscriptions (List<<a href="#type_ExecutionService">ExecutionService</a>>)</b></dt><dd> |
<p> |
A list of the services being subscribed to. |
@@ -2300,26 +2350,26 @@ dt.typeDefinition { |
passed in an <tt>execution.setSubscriptions</tt> request. |
</p> |
- <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file for which launch data is being provided. This will either |
be a Dart library or an HTML file. |
</p> |
- </dd><dt class="field"><b><i>kind ( <span style="color:#999999">optional</span> <a href="#type_ExecutableKind">ExecutableKind</a> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>kind (<span style="color:#999999">optional</span> <a href="#type_ExecutableKind">ExecutableKind</a>)</b></dt><dd> |
<p> |
The kind of the executable file. This field is omitted if the file |
is not a Dart file. |
</p> |
- </dd><dt class="field"><b><i>referencedFiles ( <span style="color:#999999">optional</span> List<<a href="#type_FilePath">FilePath</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>referencedFiles (<span style="color:#999999">optional</span> List<<a href="#type_FilePath">FilePath</a>>)</b></dt><dd> |
<p> |
A list of the Dart files that are referenced by the file. This |
field is omitted if the file is not an HTML file. |
</p> |
</dd></dl></dd></dl> |
- <h2 class="domain"><a name="domain_diagnostic">Domain: diagnostic</a></h2> |
+ <h2 class="domain"><a name="domain_diagnostic">diagnostic domain</a></h2> |
<p> |
The diagnostic domain contains server diagnostics APIs. |
</p> |
@@ -2336,7 +2386,7 @@ dt.typeDefinition { |
}</pre></div> |
<p>Return server diagnostics.</p> |
- <h4>Returns</h4><dl><dt class="field"><b><i>contexts ( List<<a href="#type_ContextData">ContextData</a>> )</i></b></dt><dd> |
+ <h4>returns:</h4><dl><dt class="field"><b>contexts (List<<a href="#type_ContextData">ContextData</a>>)</b></dt><dd> |
<p>The list of analysis contexts.</p> |
</dd></dl></dd></dl> |
@@ -2417,7 +2467,7 @@ dt.typeDefinition { |
with the new one. |
</p> |
- <dl><dt class="field"><b><i>type = "add"</i></b></dt><dd></dd><dt class="field"><b><i>content ( String )</i></b></dt><dd> |
+ <dl><dt class="field"><b>type = "add"</b></dt><dd></dd><dt class="field"><b>content (String)</b></dt><dd> |
<p> |
The new content of the file. |
@@ -2428,29 +2478,29 @@ dt.typeDefinition { |
by the analysis. |
</p> |
- <dl><dt class="field"><b><i>severity ( <a href="#type_AnalysisErrorSeverity">AnalysisErrorSeverity</a> )</i></b></dt><dd> |
+ <dl><dt class="field"><b>severity (<a href="#type_AnalysisErrorSeverity">AnalysisErrorSeverity</a>)</b></dt><dd> |
<p> |
The severity of the error. |
</p> |
- </dd><dt class="field"><b><i>type ( <a href="#type_AnalysisErrorType">AnalysisErrorType</a> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>type (<a href="#type_AnalysisErrorType">AnalysisErrorType</a>)</b></dt><dd> |
<p> |
The type of the error. |
</p> |
- </dd><dt class="field"><b><i>location ( <a href="#type_Location">Location</a> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>location (<a href="#type_Location">Location</a>)</b></dt><dd> |
<p> |
The location associated with the error. |
</p> |
- </dd><dt class="field"><b><i>message ( String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>message (String)</b></dt><dd> |
<p> |
The message to be displayed for this error. The message |
should indicate what is wrong with the code and why it is |
wrong. |
</p> |
- </dd><dt class="field"><b><i>correction ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>correction (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
The correction message to be displayed for this error. The |
@@ -2458,12 +2508,12 @@ dt.typeDefinition { |
the error. The field is omitted if there is no correction |
message associated with the error code. |
</p> |
- </dd><dt class="field"><b><i>code ( String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>code (String)</b></dt><dd> |
<p> |
The name, as a string, of the error code associated with this error. |
</p> |
- </dd><dt class="field"><b><i>hasFix ( <span style="color:#999999">optional</span> bool )</i></b></dt><dd> |
+ </dd><dt class="field"><b>hasFix (<span style="color:#999999">optional</span> bool)</b></dt><dd> |
<p> |
A hint to indicate to interested clients that this error has |
@@ -2482,12 +2532,12 @@ dt.typeDefinition { |
A list of fixes associated with a specific error |
</p> |
- <dl><dt class="field"><b><i>error ( <a href="#type_AnalysisError">AnalysisError</a> )</i></b></dt><dd> |
+ <dl><dt class="field"><b>error (<a href="#type_AnalysisError">AnalysisError</a>)</b></dt><dd> |
<p> |
The error with which the fixes are associated. |
</p> |
- </dd><dt class="field"><b><i>fixes ( List<<a href="#type_SourceChange">SourceChange</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>fixes (List<<a href="#type_SourceChange">SourceChange</a>>)</b></dt><dd> |
<p> |
The fixes associated with the error. |
@@ -2510,53 +2560,53 @@ dt.typeDefinition { |
option will not be changed. |
</p> |
- <dl><dt class="field"><b><i>enableAsync ( <span style="color:#999999">optional</span> bool )</i></b></dt><dd> |
+ <dl><dt class="field"><b>enableAsync (<span style="color:#999999">optional</span> bool)</b></dt><dd> |
<p><b><i>Deprecated</i></b>: this feature is always enabled.</p> |
<p> |
True if the client wants to enable support for the |
proposed async feature. |
</p> |
- </dd><dt class="field"><b><i>enableDeferredLoading ( <span style="color:#999999">optional</span> bool )</i></b></dt><dd> |
+ </dd><dt class="field"><b>enableDeferredLoading (<span style="color:#999999">optional</span> bool)</b></dt><dd> |
<p><b><i>Deprecated</i></b>: this feature is always enabled.</p> |
<p> |
True if the client wants to enable support for the |
proposed deferred loading feature. |
</p> |
- </dd><dt class="field"><b><i>enableEnums ( <span style="color:#999999">optional</span> bool )</i></b></dt><dd> |
+ </dd><dt class="field"><b>enableEnums (<span style="color:#999999">optional</span> bool)</b></dt><dd> |
<p><b><i>Deprecated</i></b>: this feature is always enabled.</p> |
<p> |
True if the client wants to enable support for the |
proposed enum feature. |
</p> |
- </dd><dt class="field"><b><i>enableNullAwareOperators ( <span style="color:#999999">optional</span> bool )</i></b></dt><dd> |
+ </dd><dt class="field"><b>enableNullAwareOperators (<span style="color:#999999">optional</span> bool)</b></dt><dd> |
<p><b><i>Deprecated</i></b>: this feature is always enabled.</p> |
<p> |
True if the client wants to enable support for the |
proposed "null aware operators" feature. |
</p> |
- </dd><dt class="field"><b><i>enableSuperMixins ( <span style="color:#999999">optional</span> bool )</i></b></dt><dd> |
+ </dd><dt class="field"><b>enableSuperMixins (<span style="color:#999999">optional</span> bool)</b></dt><dd> |
<p> |
True if the client wants to enable support for the |
proposed "less restricted mixins" proposal (DEP 34). |
</p> |
- </dd><dt class="field"><b><i>generateDart2jsHints ( <span style="color:#999999">optional</span> bool )</i></b></dt><dd> |
+ </dd><dt class="field"><b>generateDart2jsHints (<span style="color:#999999">optional</span> bool)</b></dt><dd> |
<p> |
True if hints that are specific to dart2js should be |
generated. This option is ignored if generateHints is false. |
</p> |
- </dd><dt class="field"><b><i>generateHints ( <span style="color:#999999">optional</span> bool )</i></b></dt><dd> |
+ </dd><dt class="field"><b>generateHints (<span style="color:#999999">optional</span> bool)</b></dt><dd> |
<p> |
True if hints should be generated as part of generating |
errors and warnings. |
</p> |
- </dd><dt class="field"><b><i>generateLints ( <span style="color:#999999">optional</span> bool )</i></b></dt><dd> |
+ </dd><dt class="field"><b>generateLints (<span style="color:#999999">optional</span> bool)</b></dt><dd> |
<p> |
True if lints should be generated as part of generating |
@@ -2579,10 +2629,10 @@ dt.typeDefinition { |
An indication of the current state of analysis. |
</p> |
- <dl><dt class="field"><b><i>isAnalyzing ( bool )</i></b></dt><dd> |
+ <dl><dt class="field"><b>isAnalyzing (bool)</b></dt><dd> |
<p>True if analysis is currently being performed.</p> |
- </dd><dt class="field"><b><i>analysisTarget ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>analysisTarget (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
The name of the current target of analysis. This field is |
@@ -2610,7 +2660,7 @@ dt.typeDefinition { |
will be reported. |
</p> |
- <dl><dt class="field"><b><i>type = "change"</i></b></dt><dd></dd><dt class="field"><b><i>edits ( List<<a href="#type_SourceEdit">SourceEdit</a>> )</i></b></dt><dd> |
+ <dl><dt class="field"><b>type = "change"</b></dt><dd></dd><dt class="field"><b>edits (List<<a href="#type_SourceEdit">SourceEdit</a>>)</b></dt><dd> |
<p> |
The edits to be applied to the file. |
@@ -2628,18 +2678,18 @@ dt.typeDefinition { |
being suggested. |
</p> |
- <dl><dt class="field"><b><i>kind ( <a href="#type_CompletionSuggestionKind">CompletionSuggestionKind</a> )</i></b></dt><dd> |
+ <dl><dt class="field"><b>kind (<a href="#type_CompletionSuggestionKind">CompletionSuggestionKind</a>)</b></dt><dd> |
<p> |
The kind of element being suggested. |
</p> |
- </dd><dt class="field"><b><i>relevance ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>relevance (int)</b></dt><dd> |
<p> |
The relevance of this completion suggestion |
where a higher number indicates a higher relevance. |
</p> |
- </dd><dt class="field"><b><i>completion ( String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>completion (String)</b></dt><dd> |
<p> |
The identifier to be inserted if the suggestion is |
@@ -2648,56 +2698,56 @@ dt.typeDefinition { |
for the parameters. The information required in order to |
do so is contained in other fields. |
</p> |
- </dd><dt class="field"><b><i>selectionOffset ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>selectionOffset (int)</b></dt><dd> |
<p> |
The offset, relative to the beginning of the completion, |
of where the selection should be placed after insertion. |
</p> |
- </dd><dt class="field"><b><i>selectionLength ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>selectionLength (int)</b></dt><dd> |
<p> |
The number of characters that should be selected after |
insertion. |
</p> |
- </dd><dt class="field"><b><i>isDeprecated ( bool )</i></b></dt><dd> |
+ </dd><dt class="field"><b>isDeprecated (bool)</b></dt><dd> |
<p> |
True if the suggested element is deprecated. |
</p> |
- </dd><dt class="field"><b><i>isPotential ( bool )</i></b></dt><dd> |
+ </dd><dt class="field"><b>isPotential (bool)</b></dt><dd> |
<p> |
True if the element is not known to be valid for the |
target. This happens if the type of the target is dynamic. |
</p> |
- </dd><dt class="field"><b><i>docSummary ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>docSummary (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
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. |
</p> |
- </dd><dt class="field"><b><i>docComplete ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>docComplete (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
The Dartdoc associated with the element being suggested, |
This field is omitted if there is no Dartdoc associated |
with the element. |
</p> |
- </dd><dt class="field"><b><i>declaringType ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>declaringType (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
The class that declares the element being suggested. This |
field is omitted if the suggested element is not a member |
of a class. |
</p> |
- </dd><dt class="field"><b><i>element ( <span style="color:#999999">optional</span> <a href="#type_Element">Element</a> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>element (<span style="color:#999999">optional</span> <a href="#type_Element">Element</a>)</b></dt><dd> |
<p> |
Information about the element reference being suggested. |
</p> |
- </dd><dt class="field"><b><i>returnType ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>returnType (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
The return type of the getter, function or method |
@@ -2705,48 +2755,48 @@ dt.typeDefinition { |
This field is omitted if the suggested element |
is not a getter, function or method. |
</p> |
- </dd><dt class="field"><b><i>parameterNames ( <span style="color:#999999">optional</span> List<String> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>parameterNames (<span style="color:#999999">optional</span> List<String>)</b></dt><dd> |
<p> |
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. |
</p> |
- </dd><dt class="field"><b><i>parameterTypes ( <span style="color:#999999">optional</span> List<String> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>parameterTypes (<span style="color:#999999">optional</span> List<String>)</b></dt><dd> |
<p> |
The types of the parameters of the function or method |
being suggested. This field is omitted if the |
parameterNames field is omitted. |
</p> |
- </dd><dt class="field"><b><i>requiredParameterCount ( <span style="color:#999999">optional</span> int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>requiredParameterCount (<span style="color:#999999">optional</span> int)</b></dt><dd> |
<p> |
The number of required parameters for the function or |
method being suggested. This field is omitted if the |
parameterNames field is omitted. |
</p> |
- </dd><dt class="field"><b><i>hasNamedParameters ( <span style="color:#999999">optional</span> bool )</i></b></dt><dd> |
+ </dd><dt class="field"><b>hasNamedParameters (<span style="color:#999999">optional</span> bool)</b></dt><dd> |
<p> |
True if the function or method being suggested has at |
least one named parameter. This field is omitted if the |
parameterNames field is omitted. |
</p> |
- </dd><dt class="field"><b><i>parameterName ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>parameterName (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
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. |
</p> |
- </dd><dt class="field"><b><i>parameterType ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>parameterType (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
The type of the options parameter being suggested. This |
field is omitted if the parameterName field is omitted. |
</p> |
- </dd><dt class="field"><b><i>importUri ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>importUri (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
The import to be added if the suggestion is out of scope |
@@ -2800,27 +2850,27 @@ dt.typeDefinition { |
Information about an analysis context. |
</p> |
- <dl><dt class="field"><b><i>name ( String )</i></b></dt><dd> |
+ <dl><dt class="field"><b>name (String)</b></dt><dd> |
<p> |
The name of the context. |
</p> |
- </dd><dt class="field"><b><i>explicitFileCount ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>explicitFileCount (int)</b></dt><dd> |
<p> |
Explicitly analyzed files. |
</p> |
- </dd><dt class="field"><b><i>implicitFileCount ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>implicitFileCount (int)</b></dt><dd> |
<p> |
Implicitly analyzed files. |
</p> |
- </dd><dt class="field"><b><i>workItemQueueLength ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>workItemQueueLength (int)</b></dt><dd> |
<p> |
The number of work items in the queue. |
</p> |
- </dd><dt class="field"><b><i>cacheEntryExceptions ( List<String> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>cacheEntryExceptions (List<String>)</b></dt><dd> |
<p> |
Exceptions associated with cache entries. |
@@ -2831,24 +2881,24 @@ dt.typeDefinition { |
in code). |
</p> |
- <dl><dt class="field"><b><i>kind ( <a href="#type_ElementKind">ElementKind</a> )</i></b></dt><dd> |
+ <dl><dt class="field"><b>kind (<a href="#type_ElementKind">ElementKind</a>)</b></dt><dd> |
<p> |
The kind of the element. |
</p> |
- </dd><dt class="field"><b><i>name ( String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>name (String)</b></dt><dd> |
<p> |
The name of the element. This is typically used as the |
label in the outline. |
</p> |
- </dd><dt class="field"><b><i>location ( <span style="color:#999999">optional</span> <a href="#type_Location">Location</a> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>location (<span style="color:#999999">optional</span> <a href="#type_Location">Location</a>)</b></dt><dd> |
<p> |
The location of the name in the declaration of the |
element. |
</p> |
- </dd><dt class="field"><b><i>flags ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>flags (int)</b></dt><dd> |
<p> |
A bit-map containing the following flags: |
@@ -2861,7 +2911,7 @@ dt.typeDefinition { |
<li>0x10 - set if the element is private</li> |
<li>0x20 - set if the element is deprecated</li> |
</ul> |
- </dd><dt class="field"><b><i>parameters ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>parameters (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
The parameter list for the element. If the element is not |
@@ -2870,7 +2920,7 @@ dt.typeDefinition { |
will not be defined. If the element has zero parameters, this |
field will have a value of "()". |
</p> |
- </dd><dt class="field"><b><i>returnType ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>returnType (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
The return type of the element. If the element is not a |
@@ -2878,7 +2928,7 @@ dt.typeDefinition { |
element does not have a declared return type, this field |
will contain an empty string. |
</p> |
- </dd><dt class="field"><b><i>typeParameters ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>typeParameters (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
The type parameter list for the element. If the element doesn't |
@@ -2900,12 +2950,12 @@ dt.typeDefinition { |
A description of an executable file. |
</p> |
- <dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The path of the executable file. |
</p> |
- </dd><dt class="field"><b><i>kind ( <a href="#type_ExecutableKind">ExecutableKind</a> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>kind (<a href="#type_ExecutableKind">ExecutableKind</a>)</b></dt><dd> |
<p> |
The kind of the executable file. |
@@ -2951,17 +3001,17 @@ dt.typeDefinition { |
A description of a region that can be folded. |
</p> |
- <dl><dt class="field"><b><i>kind ( <a href="#type_FoldingKind">FoldingKind</a> )</i></b></dt><dd> |
+ <dl><dt class="field"><b>kind (<a href="#type_FoldingKind">FoldingKind</a>)</b></dt><dd> |
<p> |
The kind of the region. |
</p> |
- </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>offset (int)</b></dt><dd> |
<p> |
The offset of the region to be folded. |
</p> |
- </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>length (int)</b></dt><dd> |
<p> |
The length of the region to be folded. |
@@ -2978,17 +3028,17 @@ dt.typeDefinition { |
associated with it. |
</p> |
- <dl><dt class="field"><b><i>type ( <a href="#type_HighlightRegionType">HighlightRegionType</a> )</i></b></dt><dd> |
+ <dl><dt class="field"><b>type (<a href="#type_HighlightRegionType">HighlightRegionType</a>)</b></dt><dd> |
<p> |
The type of highlight associated with the region. |
</p> |
- </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>offset (int)</b></dt><dd> |
<p> |
The offset of the region to be highlighted. |
</p> |
- </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>length (int)</b></dt><dd> |
<p> |
The length of the region to be highlighted. |
@@ -3151,21 +3201,21 @@ dt.typeDefinition { |
The hover information associated with a specific location. |
</p> |
- <dl><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
+ <dl><dt class="field"><b>offset (int)</b></dt><dd> |
<p> |
The offset of the range of characters that encompasses the |
cursor position and has the same hover information as the |
cursor position. |
</p> |
- </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>length (int)</b></dt><dd> |
<p> |
The length of the range of characters that encompasses the |
cursor position and has the same hover information as the |
cursor position. |
</p> |
- </dd><dt class="field"><b><i>containingLibraryPath ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>containingLibraryPath (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
The path to the defining compilation unit of the library |
@@ -3173,7 +3223,7 @@ dt.typeDefinition { |
omitted if there is no referenced element, or if the |
element is declared inside an HTML file. |
</p> |
- </dd><dt class="field"><b><i>containingLibraryName ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>containingLibraryName (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
The name of the library in which the referenced element is |
@@ -3181,14 +3231,14 @@ dt.typeDefinition { |
element, or if the element is declared inside an HTML |
file. |
</p> |
- </dd><dt class="field"><b><i>containingClassDescription ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>containingClassDescription (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
A human-readable description of the class declaring the element |
being referenced. This data is omitted if there is no referenced |
element, or if the element is not a class member. |
</p> |
- </dd><dt class="field"><b><i>dartdoc ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>dartdoc (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
The dartdoc associated with the referenced element. Other |
@@ -3198,14 +3248,14 @@ dt.typeDefinition { |
there is no referenced element, or if the element has no |
dartdoc. |
</p> |
- </dd><dt class="field"><b><i>elementDescription ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>elementDescription (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
A human-readable description of the element being |
referenced. This data is omitted if there is no referenced |
element. |
</p> |
- </dd><dt class="field"><b><i>elementKind ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>elementKind (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
A human-readable description of the kind of element being |
@@ -3213,7 +3263,7 @@ dt.typeDefinition { |
alias”). This data is omitted if there is no referenced |
element. |
</p> |
- </dd><dt class="field"><b><i>parameter ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>parameter (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
A human-readable description of the parameter |
@@ -3221,14 +3271,14 @@ dt.typeDefinition { |
data is omitted if the location is not in an argument to a |
function. |
</p> |
- </dd><dt class="field"><b><i>propagatedType ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>propagatedType (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
The name of the propagated type of the expression. This |
data is omitted if the location does not correspond to an |
expression or if there is no propagated type information. |
</p> |
- </dd><dt class="field"><b><i>staticType ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>staticType (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
The name of the static type of the expression. This data |
@@ -3240,12 +3290,12 @@ dt.typeDefinition { |
A description of a class that is implemented or extended. |
</p> |
- <dl><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
+ <dl><dt class="field"><b>offset (int)</b></dt><dd> |
<p> |
The offset of the name of the implemented class. |
</p> |
- </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>length (int)</b></dt><dd> |
<p> |
The length of the name of the implemented class. |
@@ -3255,12 +3305,12 @@ dt.typeDefinition { |
A description of a class member that is implemented or overridden. |
</p> |
- <dl><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
+ <dl><dt class="field"><b>offset (int)</b></dt><dd> |
<p> |
The offset of the name of the implemented member. |
</p> |
- </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>length (int)</b></dt><dd> |
<p> |
The length of the name of the implemented member. |
@@ -3276,19 +3326,19 @@ dt.typeDefinition { |
all occurrences of the name could be edited simultaneously. |
</p> |
- <dl><dt class="field"><b><i>positions ( List<<a href="#type_Position">Position</a>> )</i></b></dt><dd> |
+ <dl><dt class="field"><b>positions (List<<a href="#type_Position">Position</a>>)</b></dt><dd> |
<p> |
The positions of the regions that should be edited |
simultaneously. |
</p> |
- </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>length (int)</b></dt><dd> |
<p> |
The length of the regions that should be edited |
simultaneously. |
</p> |
- </dd><dt class="field"><b><i>suggestions ( List<<a href="#type_LinkedEditSuggestion">LinkedEditSuggestion</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>suggestions (List<<a href="#type_LinkedEditSuggestion">LinkedEditSuggestion</a>>)</b></dt><dd> |
<p> |
Pre-computed suggestions for what every region might |
@@ -3300,13 +3350,13 @@ dt.typeDefinition { |
the linked edit regions in a LinkedEditGroup. |
</p> |
- <dl><dt class="field"><b><i>value ( String )</i></b></dt><dd> |
+ <dl><dt class="field"><b>value (String)</b></dt><dd> |
<p> |
The value that could be used to replace all of the linked |
edit regions. |
</p> |
- </dd><dt class="field"><b><i>kind ( <a href="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKind</a> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>kind (<a href="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKind</a>)</b></dt><dd> |
<p> |
The kind of value being proposed. |
@@ -3322,28 +3372,28 @@ dt.typeDefinition { |
A location (character range) within a file. |
</p> |
- <dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file containing the range. |
</p> |
- </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>offset (int)</b></dt><dd> |
<p> |
The offset of the range. |
</p> |
- </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>length (int)</b></dt><dd> |
<p> |
The length of the range. |
</p> |
- </dd><dt class="field"><b><i>startLine ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>startLine (int)</b></dt><dd> |
<p> |
The one-based index of the line containing the first |
character of the range. |
</p> |
- </dd><dt class="field"><b><i>startColumn ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>startColumn (int)</b></dt><dd> |
<p> |
The one-based index of the column containing the first |
@@ -3355,17 +3405,17 @@ dt.typeDefinition { |
the declaration of an element. |
</p> |
- <dl><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
+ <dl><dt class="field"><b>offset (int)</b></dt><dd> |
<p> |
The offset of the region from which the user can navigate. |
</p> |
- </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>length (int)</b></dt><dd> |
<p> |
The length of the region from which the user can navigate. |
</p> |
- </dd><dt class="field"><b><i>targets ( List<int> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>targets (List<int>)</b></dt><dd> |
<p> |
The indexes of the targets (in the enclosing navigation response) |
@@ -3377,34 +3427,34 @@ dt.typeDefinition { |
A description of a target to which the user can navigate. |
</p> |
- <dl><dt class="field"><b><i>kind ( <a href="#type_ElementKind">ElementKind</a> )</i></b></dt><dd> |
+ <dl><dt class="field"><b>kind (<a href="#type_ElementKind">ElementKind</a>)</b></dt><dd> |
<p> |
The kind of the element. |
</p> |
- </dd><dt class="field"><b><i>fileIndex ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>fileIndex (int)</b></dt><dd> |
<p> |
The index of the file (in the enclosing navigation response) to |
navigate to. |
</p> |
- </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>offset (int)</b></dt><dd> |
<p> |
The offset of the region from which the user can navigate. |
</p> |
- </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>length (int)</b></dt><dd> |
<p> |
The length of the region from which the user can navigate. |
</p> |
- </dd><dt class="field"><b><i>startLine ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>startLine (int)</b></dt><dd> |
<p> |
The one-based index of the line containing the first |
character of the region. |
</p> |
- </dd><dt class="field"><b><i>startColumn ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>startColumn (int)</b></dt><dd> |
<p> |
The one-based index of the column containing the first |
@@ -3416,18 +3466,18 @@ dt.typeDefinition { |
single file. |
</p> |
- <dl><dt class="field"><b><i>element ( <a href="#type_Element">Element</a> )</i></b></dt><dd> |
+ <dl><dt class="field"><b>element (<a href="#type_Element">Element</a>)</b></dt><dd> |
<p> |
The element that was referenced. |
</p> |
- </dd><dt class="field"><b><i>offsets ( List<int> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>offsets (List<int>)</b></dt><dd> |
<p> |
The offsets of the name of the referenced element within |
the file. |
</p> |
- </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>length (int)</b></dt><dd> |
<p> |
The length of the name of the referenced element. |
@@ -3437,12 +3487,12 @@ dt.typeDefinition { |
An node in the outline structure of a file. |
</p> |
- <dl><dt class="field"><b><i>element ( <a href="#type_Element">Element</a> )</i></b></dt><dd> |
+ <dl><dt class="field"><b>element (<a href="#type_Element">Element</a>)</b></dt><dd> |
<p> |
A description of the element represented by this node. |
</p> |
- </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>offset (int)</b></dt><dd> |
<p> |
The offset of the first character of the element. This is |
@@ -3450,12 +3500,12 @@ dt.typeDefinition { |
offset of the name of the element. It can be used, for |
example, to map locations in the file back to an outline. |
</p> |
- </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>length (int)</b></dt><dd> |
<p> |
The length of the element. |
</p> |
- </dd><dt class="field"><b><i>children ( <span style="color:#999999">optional</span> List<<a href="#type_Outline">Outline</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>children (<span style="color:#999999">optional</span> List<<a href="#type_Outline">Outline</a>>)</b></dt><dd> |
<p> |
The children of the node. The field will be omitted if the |
@@ -3466,17 +3516,17 @@ dt.typeDefinition { |
A description of a member that overrides an inherited member. |
</p> |
- <dl><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
+ <dl><dt class="field"><b>offset (int)</b></dt><dd> |
<p> |
The offset of the name of the overriding member. |
</p> |
- </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>length (int)</b></dt><dd> |
<p> |
The length of the name of the overriding member. |
</p> |
- </dd><dt class="field"><b><i>superclassMember ( <span style="color:#999999">optional</span> <a href="#type_OverriddenMember">OverriddenMember</a> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>superclassMember (<span style="color:#999999">optional</span> <a href="#type_OverriddenMember">OverriddenMember</a>)</b></dt><dd> |
<p> |
The member inherited from a superclass that is overridden |
@@ -3484,7 +3534,7 @@ dt.typeDefinition { |
no superclass member, in which case there must be at least |
one interface member. |
</p> |
- </dd><dt class="field"><b><i>interfaceMembers ( <span style="color:#999999">optional</span> List<<a href="#type_OverriddenMember">OverriddenMember</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>interfaceMembers (<span style="color:#999999">optional</span> List<<a href="#type_OverriddenMember">OverriddenMember</a>>)</b></dt><dd> |
<p> |
The members inherited from interfaces that are overridden |
@@ -3497,12 +3547,12 @@ dt.typeDefinition { |
A description of a member that is being overridden. |
</p> |
- <dl><dt class="field"><b><i>element ( <a href="#type_Element">Element</a> )</i></b></dt><dd> |
+ <dl><dt class="field"><b>element (<a href="#type_Element">Element</a>)</b></dt><dd> |
<p> |
The element that is being overridden. |
</p> |
- </dd><dt class="field"><b><i>className ( String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>className (String)</b></dt><dd> |
<p> |
The name of the class in which the member is defined. |
@@ -3512,12 +3562,12 @@ dt.typeDefinition { |
A position within a file. |
</p> |
- <dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file containing the position. |
</p> |
- </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>offset (int)</b></dt><dd> |
<p> |
The offset of the position. |
@@ -3527,7 +3577,7 @@ dt.typeDefinition { |
An indication of the current state of pub execution. |
</p> |
- <dl><dt class="field"><b><i>isListingPackageDirs ( bool )</i></b></dt><dd> |
+ <dl><dt class="field"><b>isListingPackageDirs (bool)</b></dt><dd> |
<p> |
True if the server is currently running pub to produce a list of |
@@ -3544,29 +3594,29 @@ dt.typeDefinition { |
A description of a parameter in a method refactoring. |
</p> |
- <dl><dt class="field"><b><i>id ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ <dl><dt class="field"><b>id (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
The unique identifier of the parameter. |
Clients may omit this field for the parameters they want to add. |
</p> |
- </dd><dt class="field"><b><i>kind ( <a href="#type_RefactoringMethodParameterKind">RefactoringMethodParameterKind</a> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>kind (<a href="#type_RefactoringMethodParameterKind">RefactoringMethodParameterKind</a>)</b></dt><dd> |
<p> |
The kind of the parameter. |
</p> |
- </dd><dt class="field"><b><i>type ( String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>type (String)</b></dt><dd> |
<p> |
The type that should be given to the parameter, or the return type |
of the parameter's function type. |
</p> |
- </dd><dt class="field"><b><i>name ( String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>name (String)</b></dt><dd> |
<p> |
The name that should be given to the parameter. |
</p> |
- </dd><dt class="field"><b><i>parameters ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>parameters (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
The parameter list of the parameter's function type. |
@@ -3594,18 +3644,18 @@ dt.typeDefinition { |
A description of a problem related to a refactoring. |
</p> |
- <dl><dt class="field"><b><i>severity ( <a href="#type_RefactoringProblemSeverity">RefactoringProblemSeverity</a> )</i></b></dt><dd> |
+ <dl><dt class="field"><b>severity (<a href="#type_RefactoringProblemSeverity">RefactoringProblemSeverity</a>)</b></dt><dd> |
<p> |
The severity of the problem being represented. |
</p> |
- </dd><dt class="field"><b><i>message ( String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>message (String)</b></dt><dd> |
<p> |
A human-readable description of the problem being |
represented. |
</p> |
- </dd><dt class="field"><b><i>location ( <span style="color:#999999">optional</span> <a href="#type_Location">Location</a> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>location (<span style="color:#999999">optional</span> <a href="#type_Location">Location</a>)</b></dt><dd> |
<p> |
The location of the problem being represented. |
@@ -3630,23 +3680,23 @@ dt.typeDefinition { |
have a content overlay, it has no effect. |
</p> |
- <dl><dt class="field"><b><i>type = "remove"</i></b></dt><dd></dd></dl></dd><dt class="typeDefinition"><a name="type_RequestError">RequestError: object</a></dt><dd> |
+ <dl><dt class="field"><b>type = "remove"</b></dt><dd></dd></dl></dd><dt class="typeDefinition"><a name="type_RequestError">RequestError: object</a></dt><dd> |
<p> |
An indication of a problem with the execution of the server, |
typically in response to a request. |
</p> |
- <dl><dt class="field"><b><i>code ( <a href="#type_RequestErrorCode">RequestErrorCode</a> )</i></b></dt><dd> |
+ <dl><dt class="field"><b>code (<a href="#type_RequestErrorCode">RequestErrorCode</a>)</b></dt><dd> |
<p> |
A code that uniquely identifies the error that occurred. |
</p> |
- </dd><dt class="field"><b><i>message ( String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>message (String)</b></dt><dd> |
<p> |
A short description of the error. |
</p> |
- </dd><dt class="field"><b><i>stackTrace ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>stackTrace (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
The stack trace associated with processing the request, |
@@ -3834,18 +3884,18 @@ dt.typeDefinition { |
A single result from a search request. |
</p> |
- <dl><dt class="field"><b><i>location ( <a href="#type_Location">Location</a> )</i></b></dt><dd> |
+ <dl><dt class="field"><b>location (<a href="#type_Location">Location</a>)</b></dt><dd> |
<p> |
The location of the code that matched the search criteria. |
</p> |
- </dd><dt class="field"><b><i>kind ( <a href="#type_SearchResultKind">SearchResultKind</a> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>kind (<a href="#type_SearchResultKind">SearchResultKind</a>)</b></dt><dd> |
<p> |
The kind of element that was found or the kind of |
reference that was found. |
</p> |
- </dd><dt class="field"><b><i>isPotential ( bool )</i></b></dt><dd> |
+ </dd><dt class="field"><b>isPotential (bool)</b></dt><dd> |
<p> |
True if the result is a potential match but cannot be |
@@ -3854,7 +3904,7 @@ dt.typeDefinition { |
reference to a method m from an unknown class were found, |
it would be marked as being a potential match. |
</p> |
- </dd><dt class="field"><b><i>path ( List<<a href="#type_Element">Element</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>path (List<<a href="#type_Element">Element</a>>)</b></dt><dd> |
<p> |
The elements that contain the result, starting with the |
@@ -3913,24 +3963,24 @@ dt.typeDefinition { |
conceptual change. |
</p> |
- <dl><dt class="field"><b><i>message ( String )</i></b></dt><dd> |
+ <dl><dt class="field"><b>message (String)</b></dt><dd> |
<p> |
A human-readable description of the change to be applied. |
</p> |
- </dd><dt class="field"><b><i>edits ( List<<a href="#type_SourceFileEdit">SourceFileEdit</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>edits (List<<a href="#type_SourceFileEdit">SourceFileEdit</a>>)</b></dt><dd> |
<p> |
A list of the edits used to effect the change, grouped by |
file. |
</p> |
- </dd><dt class="field"><b><i>linkedEditGroups ( List<<a href="#type_LinkedEditGroup">LinkedEditGroup</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>linkedEditGroups (List<<a href="#type_LinkedEditGroup">LinkedEditGroup</a>>)</b></dt><dd> |
<p> |
A list of the linked editing groups used to customize |
the changes that were made. |
</p> |
- </dd><dt class="field"><b><i>selection ( <span style="color:#999999">optional</span> <a href="#type_Position">Position</a> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>selection (<span style="color:#999999">optional</span> <a href="#type_Position">Position</a>)</b></dt><dd> |
<p> |
The position that should be selected after the edits |
@@ -3941,23 +3991,23 @@ dt.typeDefinition { |
A description of a single change to a single file. |
</p> |
- <dl><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
+ <dl><dt class="field"><b>offset (int)</b></dt><dd> |
<p> |
The offset of the region to be modified. |
</p> |
- </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>length (int)</b></dt><dd> |
<p> |
The length of the region to be modified. |
</p> |
- </dd><dt class="field"><b><i>replacement ( String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>replacement (String)</b></dt><dd> |
<p> |
The code that is to replace the specified region in the |
original code. |
</p> |
- </dd><dt class="field"><b><i>id ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>id (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
An identifier that uniquely identifies this source edit from other |
@@ -3977,12 +4027,12 @@ dt.typeDefinition { |
A description of a set of changes to a single file. |
</p> |
- <dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The file containing the code to be modified. |
</p> |
- </dd><dt class="field"><b><i>fileStamp ( long )</i></b></dt><dd> |
+ </dd><dt class="field"><b>fileStamp (long)</b></dt><dd> |
<p> |
The modification stamp of the file at the moment when the change |
@@ -3991,7 +4041,7 @@ dt.typeDefinition { |
this field to make sure that the file was not changed since then, |
so it is safe to apply the change. |
</p> |
- </dd><dt class="field"><b><i>edits ( List<<a href="#type_SourceEdit">SourceEdit</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>edits (List<<a href="#type_SourceEdit">SourceEdit</a>>)</b></dt><dd> |
<p> |
A list of the edits used to effect the change. |
@@ -4001,12 +4051,12 @@ dt.typeDefinition { |
A representation of a class in a type hierarchy. |
</p> |
- <dl><dt class="field"><b><i>classElement ( <a href="#type_Element">Element</a> )</i></b></dt><dd> |
+ <dl><dt class="field"><b>classElement (<a href="#type_Element">Element</a>)</b></dt><dd> |
<p> |
The class element represented by this item. |
</p> |
- </dd><dt class="field"><b><i>displayName ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>displayName (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
The name to be displayed for the class. This field will be |
@@ -4015,7 +4065,7 @@ dt.typeDefinition { |
additional type information to be displayed, such as type |
arguments. |
</p> |
- </dd><dt class="field"><b><i>memberElement ( <span style="color:#999999">optional</span> <a href="#type_Element">Element</a> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>memberElement (<span style="color:#999999">optional</span> <a href="#type_Element">Element</a>)</b></dt><dd> |
<p> |
The member in the class corresponding to the member on |
@@ -4023,28 +4073,28 @@ dt.typeDefinition { |
omitted if the hierarchy was not requested for a member or |
if the class does not have a corresponding member. |
</p> |
- </dd><dt class="field"><b><i>superclass ( <span style="color:#999999">optional</span> int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>superclass (<span style="color:#999999">optional</span> int)</b></dt><dd> |
<p> |
The index of the item representing the superclass of |
this class. This field will be omitted if this item |
represents the class Object. |
</p> |
- </dd><dt class="field"><b><i>interfaces ( List<int> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>interfaces (List<int>)</b></dt><dd> |
<p> |
The indexes of the items representing the interfaces |
implemented by this class. The list will be empty if |
there are no implemented interfaces. |
</p> |
- </dd><dt class="field"><b><i>mixins ( List<int> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>mixins (List<int>)</b></dt><dd> |
<p> |
The indexes of the items representing the mixins |
referenced by this class. The list will be empty if |
there are no classes mixed in to this class. |
</p> |
- </dd><dt class="field"><b><i>subclasses ( List<int> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>subclasses (List<int>)</b></dt><dd> |
<p> |
The indexes of the items representing the subtypes of |
@@ -4080,7 +4130,7 @@ dt.typeDefinition { |
It is an error if the range contains anything other than all |
or part of the name of a single getter. |
</p> |
- <h4>Feedback</h4><p>none</p><h4>Options</h4><p>none</p></dd><dt class="refactoring">CONVERT_METHOD_TO_GETTER</dt><dd> |
+ <h4>Feedback:</h4><p>none</p><h4>Options:</h4><p>none</p></dd><dt class="refactoring">CONVERT_METHOD_TO_GETTER</dt><dd> |
<p> |
Convert a method into a getter by adding the keyword get and |
removing the parameter list. |
@@ -4090,7 +4140,7 @@ dt.typeDefinition { |
or part of the name of a single method or if the method has |
a non-empty parameter list. |
</p> |
- <h4>Feedback</h4><p>none</p><h4>Options</h4><p>none</p></dd><dt class="refactoring">EXTRACT_LOCAL_VARIABLE</dt><dd> |
+ <h4>Feedback:</h4><p>none</p><h4>Options:</h4><p>none</p></dd><dt class="refactoring">EXTRACT_LOCAL_VARIABLE</dt><dd> |
<p> |
Create a local variable initialized by the expression that covers |
the specified selection. |
@@ -4101,30 +4151,30 @@ dt.typeDefinition { |
</p> |
- <h4>Feedback</h4><dl><dt class="field"><b><i>coveringExpressionOffsets ( <span style="color:#999999">optional</span> List<int> )</i></b></dt><dd> |
+ <h4>Feedback:</h4><dl><dt class="field"><b>coveringExpressionOffsets (<span style="color:#999999">optional</span> List<int>)</b></dt><dd> |
<p> |
The offsets of the expressions that cover the specified |
selection, from the down most to the up most. |
</p> |
- </dd><dt class="field"><b><i>coveringExpressionLengths ( <span style="color:#999999">optional</span> List<int> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>coveringExpressionLengths (<span style="color:#999999">optional</span> List<int>)</b></dt><dd> |
<p> |
The lengths of the expressions that cover the specified |
selection, from the down most to the up most. |
</p> |
- </dd><dt class="field"><b><i>names ( List<String> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>names (List<String>)</b></dt><dd> |
<p> |
The proposed names for the local variable. |
</p> |
- </dd><dt class="field"><b><i>offsets ( List<int> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>offsets (List<int>)</b></dt><dd> |
<p> |
The offsets of the expressions that would be replaced by |
a reference to the variable. |
</p> |
- </dd><dt class="field"><b><i>lengths ( List<int> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>lengths (List<int>)</b></dt><dd> |
<p> |
The lengths of the expressions that would be replaced by |
@@ -4133,12 +4183,12 @@ dt.typeDefinition { |
the offset of that expression is offsets[i], then the |
length of that expression is lengths[i]. |
</p> |
- </dd></dl><h4>Options</h4><dl><dt class="field"><b><i>name ( String )</i></b></dt><dd> |
+ </dd></dl><h4>Options:</h4><dl><dt class="field"><b>name (String)</b></dt><dd> |
<p> |
The name that the local variable should be given. |
</p> |
- </dd><dt class="field"><b><i>extractAll ( bool )</i></b></dt><dd> |
+ </dd><dt class="field"><b>extractAll (bool)</b></dt><dd> |
<p> |
True if all occurrences of the expression within the |
@@ -4160,47 +4210,47 @@ dt.typeDefinition { |
</p> |
- <h4>Feedback</h4><dl><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
+ <h4>Feedback:</h4><dl><dt class="field"><b>offset (int)</b></dt><dd> |
<p> |
The offset to the beginning of the expression or |
statements that will be extracted. |
</p> |
- </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>length (int)</b></dt><dd> |
<p> |
The length of the expression or statements that will be |
extracted. |
</p> |
- </dd><dt class="field"><b><i>returnType ( String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>returnType (String)</b></dt><dd> |
<p> |
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. |
</p> |
- </dd><dt class="field"><b><i>names ( List<String> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>names (List<String>)</b></dt><dd> |
<p> |
The proposed names for the method. |
</p> |
- </dd><dt class="field"><b><i>canCreateGetter ( bool )</i></b></dt><dd> |
+ </dd><dt class="field"><b>canCreateGetter (bool)</b></dt><dd> |
<p> |
True if a getter could be created rather than a method. |
</p> |
- </dd><dt class="field"><b><i>parameters ( List<<a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>parameters (List<<a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a>>)</b></dt><dd> |
<p> |
The proposed parameters for the method. |
</p> |
- </dd><dt class="field"><b><i>offsets ( List<int> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>offsets (List<int>)</b></dt><dd> |
<p> |
The offsets of the expressions or statements that would |
be replaced by an invocation of the method. |
</p> |
- </dd><dt class="field"><b><i>lengths ( List<int> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>lengths (List<int>)</b></dt><dd> |
<p> |
The lengths of the expressions or statements that would |
@@ -4210,24 +4260,24 @@ dt.typeDefinition { |
that expression is offsets[i], then the length of that |
expression is lengths[i]. |
</p> |
- </dd></dl><h4>Options</h4><dl><dt class="field"><b><i>returnType ( String )</i></b></dt><dd> |
+ </dd></dl><h4>Options:</h4><dl><dt class="field"><b>returnType (String)</b></dt><dd> |
<p> |
The return type that should be defined for the method. |
</p> |
- </dd><dt class="field"><b><i>createGetter ( bool )</i></b></dt><dd> |
+ </dd><dt class="field"><b>createGetter (bool)</b></dt><dd> |
<p> |
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. |
</p> |
- </dd><dt class="field"><b><i>name ( String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>name (String)</b></dt><dd> |
<p> |
The name that the method should be given. |
</p> |
- </dd><dt class="field"><b><i>parameters ( List<<a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a>> )</i></b></dt><dd> |
+ </dd><dt class="field"><b>parameters (List<<a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a>>)</b></dt><dd> |
<p> |
The parameters that should be defined for the method. |
@@ -4246,7 +4296,7 @@ dt.typeDefinition { |
<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> |
+ </dd><dt class="field"><b>extractAll (bool)</b></dt><dd> |
<p> |
True if all occurrences of the expression or statements |
@@ -4264,17 +4314,17 @@ dt.typeDefinition { |
or part of the name of a single local variable. |
</p> |
- <h4>Feedback</h4><dl><dt class="field"><b><i>name ( String )</i></b></dt><dd> |
+ <h4>Feedback:</h4><dl><dt class="field"><b>name (String)</b></dt><dd> |
<p> |
The name of the variable being inlined. |
</p> |
- </dd><dt class="field"><b><i>occurrences ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>occurrences (int)</b></dt><dd> |
<p> |
The number of times the variable occurs. |
</p> |
- </dd></dl><h4>Options</h4><p>none</p></dd><dt class="refactoring">INLINE_METHOD</dt><dd> |
+ </dd></dl><h4>Options:</h4><p>none</p></dd><dt class="refactoring">INLINE_METHOD</dt><dd> |
<p> |
Inline a method in place of one or all references to that |
method. |
@@ -4285,30 +4335,30 @@ dt.typeDefinition { |
</p> |
- <h4>Feedback</h4><dl><dt class="field"><b><i>className ( <span style="color:#999999">optional</span> String )</i></b></dt><dd> |
+ <h4>Feedback:</h4><dl><dt class="field"><b>className (<span style="color:#999999">optional</span> String)</b></dt><dd> |
<p> |
The name of the class enclosing the method being inlined. |
If not a class member is being inlined, this field will be absent. |
</p> |
- </dd><dt class="field"><b><i>methodName ( String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>methodName (String)</b></dt><dd> |
<p> |
The name of the method (or function) being inlined. |
</p> |
- </dd><dt class="field"><b><i>isDeclaration ( bool )</i></b></dt><dd> |
+ </dd><dt class="field"><b>isDeclaration (bool)</b></dt><dd> |
<p> |
True if the declaration of the method is selected. |
So all references should be inlined. |
</p> |
- </dd></dl><h4>Options</h4><dl><dt class="field"><b><i>deleteSource ( bool )</i></b></dt><dd> |
+ </dd></dl><h4>Options:</h4><dl><dt class="field"><b>deleteSource (bool)</b></dt><dd> |
<p> |
True if the method being inlined should be removed. |
It is an error if this field is true and inlineAll is false. |
</p> |
- </dd><dt class="field"><b><i>inlineAll ( bool )</i></b></dt><dd> |
+ </dd><dt class="field"><b>inlineAll (bool)</b></dt><dd> |
<p> |
True if all invocations of the method should be inlined, |
@@ -4331,7 +4381,7 @@ dt.typeDefinition { |
file specified in the request specifies the file to be moved. |
</p> |
- <h4>Feedback</h4><p>none</p><h4>Options</h4><dl><dt class="field"><b><i>newFile ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> |
+ <h4>Feedback:</h4><p>none</p><h4>Options:</h4><dl><dt class="field"><b>newFile (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> |
<p> |
The new file path to which the given file is being moved. |
@@ -4349,30 +4399,30 @@ dt.typeDefinition { |
</p> |
- <h4>Feedback</h4><dl><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
+ <h4>Feedback:</h4><dl><dt class="field"><b>offset (int)</b></dt><dd> |
<p> |
The offset to the beginning of the name selected to be |
renamed. |
</p> |
- </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
+ </dd><dt class="field"><b>length (int)</b></dt><dd> |
<p> |
The length of the name selected to be renamed. |
</p> |
- </dd><dt class="field"><b><i>elementKindName ( String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>elementKindName (String)</b></dt><dd> |
<p> |
The human-readable description of the kind of element being |
renamed (such as “class” or “function type |
alias”). |
</p> |
- </dd><dt class="field"><b><i>oldName ( String )</i></b></dt><dd> |
+ </dd><dt class="field"><b>oldName (String)</b></dt><dd> |
<p> |
The old name of the element before the refactoring. |
</p> |
- </dd></dl><h4>Options</h4><dl><dt class="field"><b><i>newName ( String )</i></b></dt><dd> |
+ </dd></dl><h4>Options:</h4><dl><dt class="field"><b>newName (String)</b></dt><dd> |
<p> |
The name that the element should have after the |
@@ -4385,7 +4435,7 @@ dt.typeDefinition { |
produced by the server and the data that is returned with each. |
</p> |
<p> |
- TBD |
+ TODO: TBD |
</p> |
<h2 class="domain"><a name="index">Index</a></h2> |
<h3>Domains</h3><h4>server (<a href="#domain_server">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_server.getVersion">getVersion</a></li><li><a href="#request_server.shutdown">shutdown</a></li><li><a href="#request_server.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications</h5><div class="subindex"><ul><li><a href="#notification_server.connected">connected</a></li><li><a href="#notification_server.error">error</a></li><li><a href="#notification_server.status">status</a></li></ul></div></div><h4>analysis (<a href="#domain_analysis">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_analysis.getErrors">getErrors</a></li><li><a href="#request_analysis.getHover">getHover</a></li><li><a href="#request_analysis.getReachableSources">getReachableSources</a></li><li><a href="#request_analysis.getLibraryDependencies">getLibraryDependencies</a></li><li><a href="#request_analysis.getNavigation">getNavigation</a></li><li><a href="#request_analysis.reanalyze">reanalyze</a></li><li><a href="#request_analysis.setAnalysisRoots">setAnalysisRoots</a></li><li><a href="#request_analysis.setGeneralSubscriptions">setGeneralSubscriptions</a></li><li><a href="#request_analysis.setPriorityFiles">setPriorityFiles</a></li><li><a href="#request_analysis.setSubscriptions">setSubscriptions</a></li><li><a href="#request_analysis.updateContent">updateContent</a></li><li><a href="#request_analysis.updateOptions">updateOptions</a></li></ul><h5>Notifications</h5><div class="subindex"><ul><li><a href="#notification_analysis.analyzedFiles">analyzedFiles</a></li><li><a href="#notification_analysis.errors">errors</a></li><li><a href="#notification_analysis.flushResults">flushResults</a></li><li><a href="#notification_analysis.folding">folding</a></li><li><a href="#notification_analysis.highlights">highlights</a></li><li><a href="#notification_analysis.implemented">implemented</a></li><li><a href="#notification_analysis.invalidate">invalidate</a></li><li><a href="#notification_analysis.navigation">navigation</a></li><li><a href="#notification_analysis.occurrences">occurrences</a></li><li><a href="#notification_analysis.outline">outline</a></li><li><a href="#notification_analysis.overrides">overrides</a></li></ul></div></div><h4>completion (<a href="#domain_completion">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_completion.getSuggestions">getSuggestions</a></li></ul><h5>Notifications</h5><div class="subindex"><ul><li><a href="#notification_completion.results">results</a></li></ul></div></div><h4>search (<a href="#domain_search">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_search.findElementReferences">findElementReferences</a></li><li><a href="#request_search.findMemberDeclarations">findMemberDeclarations</a></li><li><a href="#request_search.findMemberReferences">findMemberReferences</a></li><li><a href="#request_search.findTopLevelDeclarations">findTopLevelDeclarations</a></li><li><a href="#request_search.getTypeHierarchy">getTypeHierarchy</a></li></ul><h5>Notifications</h5><div class="subindex"><ul><li><a href="#notification_search.results">results</a></li></ul></div></div><h4>edit (<a href="#domain_edit">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_edit.format">format</a></li><li><a href="#request_edit.getAssists">getAssists</a></li><li><a href="#request_edit.getAvailableRefactorings">getAvailableRefactorings</a></li><li><a href="#request_edit.getFixes">getFixes</a></li><li><a href="#request_edit.getRefactoring">getRefactoring</a></li><li><a href="#request_edit.sortMembers">sortMembers</a></li><li><a href="#request_edit.organizeDirectives">organizeDirectives</a></li></ul></div><h4>execution (<a href="#domain_execution">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_execution.createContext">createContext</a></li><li><a href="#request_execution.deleteContext">deleteContext</a></li><li><a href="#request_execution.mapUri">mapUri</a></li><li><a href="#request_execution.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications</h5><div class="subindex"><ul><li><a href="#notification_execution.launchData">launchData</a></li></ul></div></div><h4>diagnostic (<a href="#domain_diagnostic">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_diagnostic.getDiagnostics">getDiagnostics</a></li></ul></div><h3>Types (<a href="#types">↑</a>)</h3><div class="subindex"><ul><li><a href="#type_AddContentOverlay">AddContentOverlay</a></li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a href="#type_AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_AnalysisErrorSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErrorType">AnalysisErrorType</a></li><li><a href="#type_AnalysisOptions">AnalysisOptions</a></li><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a href="#type_AnalysisStatus">AnalysisStatus</a></li><li><a href="#type_ChangeContentOverlay">ChangeContentOverlay</a></li><li><a href="#type_CompletionId">CompletionId</a></li><li><a href="#type_CompletionSuggestion">CompletionSuggestion</a></li><li><a href="#type_CompletionSuggestionKind">CompletionSuggestionKind</a></li><li><a href="#type_ContextData">ContextData</a></li><li><a href="#type_Element">Element</a></li><li><a href="#type_ElementKind">ElementKind</a></li><li><a href="#type_ExecutableFile">ExecutableFile</a></li><li><a href="#type_ExecutableKind">ExecutableKind</a></li><li><a href="#type_ExecutionContextId">ExecutionContextId</a></li><li><a href="#type_ExecutionService">ExecutionService</a></li><li><a href="#type_FileKind">FileKind</a></li><li><a href="#type_FilePath">FilePath</a></li><li><a href="#type_FoldingKind">FoldingKind</a></li><li><a href="#type_FoldingRegion">FoldingRegion</a></li><li><a href="#type_GeneralAnalysisService">GeneralAnalysisService</a></li><li><a href="#type_HighlightRegion">HighlightRegion</a></li><li><a href="#type_HighlightRegionType">HighlightRegionType</a></li><li><a href="#type_HoverInformation">HoverInformation</a></li><li><a href="#type_ImplementedClass">ImplementedClass</a></li><li><a href="#type_ImplementedMember">ImplementedMember</a></li><li><a href="#type_LinkedEditGroup">LinkedEditGroup</a></li><li><a href="#type_LinkedEditSuggestion">LinkedEditSuggestion</a></li><li><a href="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKind</a></li><li><a href="#type_Location">Location</a></li><li><a href="#type_NavigationRegion">NavigationRegion</a></li><li><a href="#type_NavigationTarget">NavigationTarget</a></li><li><a href="#type_Occurrences">Occurrences</a></li><li><a href="#type_Outline">Outline</a></li><li><a href="#type_Override">Override</a></li><li><a href="#type_OverriddenMember">OverriddenMember</a></li><li><a href="#type_Position">Position</a></li><li><a href="#type_PubStatus">PubStatus</a></li><li><a href="#type_RefactoringKind">RefactoringKind</a></li><li><a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a></li><li><a href="#type_RefactoringFeedback">RefactoringFeedback</a></li><li><a href="#type_RefactoringOptions">RefactoringOptions</a></li><li><a href="#type_RefactoringMethodParameterKind">RefactoringMethodParameterKind</a></li><li><a href="#type_RefactoringProblem">RefactoringProblem</a></li><li><a href="#type_RefactoringProblemSeverity">RefactoringProblemSeverity</a></li><li><a href="#type_RemoveContentOverlay">RemoveContentOverlay</a></li><li><a href="#type_RequestError">RequestError</a></li><li><a href="#type_RequestErrorCode">RequestErrorCode</a></li><li><a href="#type_SearchId">SearchId</a></li><li><a href="#type_SearchResult">SearchResult</a></li><li><a href="#type_SearchResultKind">SearchResultKind</a></li><li><a href="#type_ServerService">ServerService</a></li><li><a href="#type_SourceChange">SourceChange</a></li><li><a href="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_SourceFileEdit">SourceFileEdit</a></li><li><a href="#type_TypeHierarchyItem">TypeHierarchyItem</a></li></ul></div><h3>Refactorings (<a href="#refactorings">↑</a>)</h3><div class="subindex"><ul><li><a href="#refactoring_CONVERT_GETTER_TO_METHOD">CONVERT_GETTER_TO_METHOD</a></li><li><a href="#refactoring_CONVERT_METHOD_TO_GETTER">CONVERT_METHOD_TO_GETTER</a></li><li><a href="#refactoring_EXTRACT_LOCAL_VARIABLE">EXTRACT_LOCAL_VARIABLE</a></li><li><a href="#refactoring_EXTRACT_METHOD">EXTRACT_METHOD</a></li><li><a href="#refactoring_INLINE_LOCAL_VARIABLE">INLINE_LOCAL_VARIABLE</a></li><li><a href="#refactoring_INLINE_METHOD">INLINE_METHOD</a></li><li><a href="#refactoring_MOVE_FILE">MOVE_FILE</a></li><li><a href="#refactoring_RENAME">RENAME</a></li></ul></div> |