Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(96)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: pkg/analysis_server/doc/api.html

Issue 508203002: Rename some bools in the analysis server API. (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Created 6 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « editor/tools/plugins/com.google.dart.tools.core/src/com/google/dart/tools/core/internal/analysis/model/WorkspaceAnalysisServerListener.java ('k') | pkg/analysis_server/lib/src/generated_protocol.dart » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <html><head> 1 <html><head>
2 <meta charset="UTF-8"> 2 <meta charset="UTF-8">
3 <title>Analysis Server API Specification</title> 3 <title>Analysis Server API Specification</title>
4 <style>body { 4 <style>body {
5 font-family: sans-serif, serif; 5 font-family: sans-serif, serif;
6 padding-left: 5%; 6 padding-left: 5%;
7 padding-right: 5%; 7 padding-right: 5%;
8 } 8 }
9 h1 { 9 h1 {
10 text-align: center; 10 text-align: center;
(...skipping 235 matching lines...) Expand 10 before | Expand all | Expand 10 after
246 any requests are processed to let the client know that it 246 any requests are processed to let the client know that it
247 started correctly. 247 started correctly.
248 </p> 248 </p>
249 <p> 249 <p>
250 It is not possible to subscribe to or unsubscribe from this 250 It is not possible to subscribe to or unsubscribe from this
251 notification. 251 notification.
252 </p> 252 </p>
253 </dd><dt class="notification">server.error</dt><dd><div class="box"><pre>n otification: { 253 </dd><dt class="notification">server.error</dt><dd><div class="box"><pre>n otification: {
254 "event": "server.error" 254 "event": "server.error"
255 "params": { 255 "params": {
256 "<b>fatal</b>": bool 256 "<b>isFatal</b>": bool
257 "<b>message</b>": String 257 "<b>message</b>": String
258 "<b>stackTrace</b>": String 258 "<b>stackTrace</b>": String
259 } 259 }
260 }</pre></div> 260 }</pre></div>
261 <p> 261 <p>
262 Reports that an unexpected error has occurred while 262 Reports that an unexpected error has occurred while
263 executing the server. This notification is not used for 263 executing the server. This notification is not used for
264 problems with specific requests (which are returned as part 264 problems with specific requests (which are returned as part
265 of the response) but is used for exceptions that occur while 265 of the response) but is used for exceptions that occur while
266 performing other tasks, such as analysis or preparing 266 performing other tasks, such as analysis or preparing
267 notifications. 267 notifications.
268 </p> 268 </p>
269 <p> 269 <p>
270 It is not possible to subscribe to or unsubscribe from this 270 It is not possible to subscribe to or unsubscribe from this
271 notification. 271 notification.
272 </p> 272 </p>
273 273
274 <h4>Parameters</h4><dl><dt class="field"><b><i>fatal ( bool )</i></b></dt> <dd> 274 <h4>Parameters</h4><dl><dt class="field"><b><i>isFatal ( bool )</i></b></d t><dd>
275 275
276 <p> 276 <p>
277 True if the error is a fatal error, meaning that the 277 True if the error is a fatal error, meaning that the
278 server will shutdown automatically after sending this 278 server will shutdown automatically after sending this
279 notification. 279 notification.
280 </p> 280 </p>
281 </dd><dt class="field"><b><i>message ( String )</i></b></dt><dd> 281 </dd><dt class="field"><b><i>message ( String )</i></b></dt><dd>
282 282
283 <p> 283 <p>
284 The error message indicating what kind of error was 284 The error message indicating what kind of error was
(...skipping 629 matching lines...) Expand 10 before | Expand all | Expand 10 after
914 The identifier used to associate results with this 914 The identifier used to associate results with this
915 completion request. 915 completion request.
916 </p> 916 </p>
917 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" >completion.results</dt><dd><div class="box"><pre>notification: { 917 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" >completion.results</dt><dd><div class="box"><pre>notification: {
918 "event": "completion.results" 918 "event": "completion.results"
919 "params": { 919 "params": {
920 "<b>id</b>": <a href="#type_CompletionId">CompletionId</a> 920 "<b>id</b>": <a href="#type_CompletionId">CompletionId</a>
921 "<b>replacementOffset</b>": int 921 "<b>replacementOffset</b>": int
922 "<b>replacementLength</b>": int 922 "<b>replacementLength</b>": int
923 "<b>results</b>": List&lt;<a href="#type_CompletionSuggestion">CompletionSug gestion</a>&gt; 923 "<b>results</b>": List&lt;<a href="#type_CompletionSuggestion">CompletionSug gestion</a>&gt;
924 "<b>last</b>": bool 924 "<b>isLast</b>": bool
925 } 925 }
926 }</pre></div> 926 }</pre></div>
927 <p> 927 <p>
928 Reports the completion suggestions that should be presented 928 Reports the completion suggestions that should be presented
929 to the user. The set of suggestions included in the 929 to the user. The set of suggestions included in the
930 notification is always a complete list that supersedes any 930 notification is always a complete list that supersedes any
931 previously reported suggestions. 931 previously reported suggestions.
932 </p> 932 </p>
933 933
934 <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_Complet ionId">CompletionId</a> )</i></b></dt><dd> 934 <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_Complet ionId">CompletionId</a> )</i></b></dt><dd>
(...skipping 22 matching lines...) Expand all
957 </dd><dt class="field"><b><i>results ( List&lt;<a href="#type_Completi onSuggestion">CompletionSuggestion</a>&gt; )</i></b></dt><dd> 957 </dd><dt class="field"><b><i>results ( List&lt;<a href="#type_Completi onSuggestion">CompletionSuggestion</a>&gt; )</i></b></dt><dd>
958 958
959 <p> 959 <p>
960 The completion suggestions being reported. The 960 The completion suggestions being reported. The
961 notification contains all possible completions at the 961 notification contains all possible completions at the
962 requested cursor position, even those that do not match 962 requested cursor position, even those that do not match
963 the characters the user has already typed. This allows 963 the characters the user has already typed. This allows
964 the client to respond to further keystrokes from the 964 the client to respond to further keystrokes from the
965 user without having to make additional requests. 965 user without having to make additional requests.
966 </p> 966 </p>
967 </dd><dt class="field"><b><i>last ( bool )</i></b></dt><dd> 967 </dd><dt class="field"><b><i>isLast ( bool )</i></b></dt><dd>
968 968
969 <p> 969 <p>
970 True if this is that last set of results that will be 970 True if this is that last set of results that will be
971 returned for the indicated completion. 971 returned for the indicated completion.
972 </p> 972 </p>
973 </dd></dl></dd></dl> 973 </dd></dl></dd></dl>
974 <h2 class="domain"><a name="domain_search">Domain: search</a></h2> 974 <h2 class="domain"><a name="domain_search">Domain: search</a></h2>
975 <p> 975 <p>
976 The search domain contains commands related to searches that 976 The search domain contains commands related to searches that
977 can be performed against the code base. 977 can be performed against the code base.
(...skipping 220 matching lines...) Expand 10 before | Expand all | Expand 10 after
1198 This field will be absent if the code at the given file 1198 This field will be absent if the code at the given file
1199 and offset does not represent a type, or if the file has 1199 and offset does not represent a type, or if the file has
1200 not been sufficiently analyzed to allow a type hierarchy 1200 not been sufficiently analyzed to allow a type hierarchy
1201 to be produced. 1201 to be produced.
1202 </p> 1202 </p>
1203 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" >search.results</dt><dd><div class="box"><pre>notification: { 1203 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" >search.results</dt><dd><div class="box"><pre>notification: {
1204 "event": "search.results" 1204 "event": "search.results"
1205 "params": { 1205 "params": {
1206 "<b>id</b>": <a href="#type_SearchId">SearchId</a> 1206 "<b>id</b>": <a href="#type_SearchId">SearchId</a>
1207 "<b>results</b>": List&lt;<a href="#type_SearchResult">SearchResult</a>&gt; 1207 "<b>results</b>": List&lt;<a href="#type_SearchResult">SearchResult</a>&gt;
1208 "<b>last</b>": bool 1208 "<b>isLast</b>": bool
1209 } 1209 }
1210 }</pre></div> 1210 }</pre></div>
1211 <p> 1211 <p>
1212 Reports some or all of the results of performing a requested 1212 Reports some or all of the results of performing a requested
1213 search. Unlike other notifications, this notification 1213 search. Unlike other notifications, this notification
1214 contains search results that should be added to any 1214 contains search results that should be added to any
1215 previously received search results associated with the same 1215 previously received search results associated with the same
1216 search id. 1216 search id.
1217 </p> 1217 </p>
1218 1218
1219 <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_SearchI d">SearchId</a> )</i></b></dt><dd> 1219 <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_SearchI d">SearchId</a> )</i></b></dt><dd>
1220 1220
1221 <p> 1221 <p>
1222 The id associated with the search. 1222 The id associated with the search.
1223 </p> 1223 </p>
1224 </dd><dt class="field"><b><i>results ( List&lt;<a href="#type_SearchRe sult">SearchResult</a>&gt; )</i></b></dt><dd> 1224 </dd><dt class="field"><b><i>results ( List&lt;<a href="#type_SearchRe sult">SearchResult</a>&gt; )</i></b></dt><dd>
1225 1225
1226 <p> 1226 <p>
1227 The search results being reported. 1227 The search results being reported.
1228 </p> 1228 </p>
1229 </dd><dt class="field"><b><i>last ( bool )</i></b></dt><dd> 1229 </dd><dt class="field"><b><i>isLast ( bool )</i></b></dt><dd>
1230 1230
1231 <p> 1231 <p>
1232 True if this is that last set of results that will be 1232 True if this is that last set of results that will be
1233 returned for the indicated search. 1233 returned for the indicated search.
1234 </p> 1234 </p>
1235 </dd></dl></dd></dl> 1235 </dd></dl></dd></dl>
1236 <h2 class="domain"><a name="domain_edit">Domain: edit</a></h2> 1236 <h2 class="domain"><a name="domain_edit">Domain: edit</a></h2>
1237 <p> 1237 <p>
1238 The edit domain contains commands related to edits that can be 1238 The edit domain contains commands related to edits that can be
1239 applied to the code. 1239 applied to the code.
(...skipping 571 matching lines...) Expand 10 before | Expand all | Expand 10 after
1811 <p> 1811 <p>
1812 An enumeration of the services provided by the analysis 1812 An enumeration of the services provided by the analysis
1813 domain. 1813 domain.
1814 </p> 1814 </p>
1815 1815
1816 <dl><dt class="value">FOLDING</dt><dt class="value">HIGHLIGHTS</dt><dt cla ss="value">NAVIGATION</dt><dt class="value">OCCURRENCES</dt><dt class="value">OU TLINE</dt><dt class="value">OVERRIDES</dt></dl></dd><dt class="typeDefinition">< a name="type_AnalysisStatus">AnalysisStatus: object</a></dt><dd> 1816 <dl><dt class="value">FOLDING</dt><dt class="value">HIGHLIGHTS</dt><dt cla ss="value">NAVIGATION</dt><dt class="value">OCCURRENCES</dt><dt class="value">OU TLINE</dt><dt class="value">OVERRIDES</dt></dl></dd><dt class="typeDefinition">< a name="type_AnalysisStatus">AnalysisStatus: object</a></dt><dd>
1817 <p> 1817 <p>
1818 An indication of the current state of analysis. 1818 An indication of the current state of analysis.
1819 </p> 1819 </p>
1820 1820
1821 <dl><dt class="field"><b><i>analyzing ( bool )</i></b></dt><dd> 1821 <dl><dt class="field"><b><i>isAnalyzing ( bool )</i></b></dt><dd>
1822 1822
1823 <p>True if analysis is currently being performed.</p> 1823 <p>True if analysis is currently being performed.</p>
1824 </dd><dt class="field"><b><i>analysisTarget ( <span style="color:#9999 99">optional</span> String )</i></b></dt><dd> 1824 </dd><dt class="field"><b><i>analysisTarget ( <span style="color:#9999 99">optional</span> String )</i></b></dt><dd>
1825 1825
1826 <p> 1826 <p>
1827 The name of the current target of analysis. This field is 1827 The name of the current target of analysis. This field is
1828 omitted if analyzing is false. 1828 omitted if analyzing is false.
1829 </p> 1829 </p>
1830 </dd></dl></dd><dt class="typeDefinition"><a name="type_ChangeContentO verlay">ChangeContentOverlay: object</a></dt><dd> 1830 </dd></dl></dd><dt class="typeDefinition"><a name="type_ChangeContentO verlay">ChangeContentOverlay: object</a></dt><dd>
1831 <p> 1831 <p>
(...skipping 1214 matching lines...) Expand 10 before | Expand all | Expand 10 after
3046 <p> 3046 <p>
3047 This section contains a list of all of the errors that are 3047 This section contains a list of all of the errors that are
3048 produced by the server and the data that is returned with each. 3048 produced by the server and the data that is returned with each.
3049 </p> 3049 </p>
3050 <p> 3050 <p>
3051 TBD 3051 TBD
3052 </p> 3052 </p>
3053 3053
3054 3054
3055 </body></html> 3055 </body></html>
OLDNEW
« no previous file with comments | « editor/tools/plugins/com.google.dart.tools.core/src/com/google/dart/tools/core/internal/analysis/model/WorkspaceAnalysisServerListener.java ('k') | pkg/analysis_server/lib/src/generated_protocol.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698