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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 769963003: Add paging support (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Created 6 years 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.server/src/com/google/dart/server/generated/types/AnalysisService.java ('k') | pkg/analysis_server/lib/src/generated_protocol.dart » ('j') | pkg/analysis_server/tool/spec/spec_input.html » ('J')
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 320 matching lines...) Expand 10 before | Expand all | Expand 10 after
331 331
332 332
333 333
334 334
335 335
336 336
337 337
338 338
339 339
340 340
341
342
341 <h3>Requests</h3><dl><dt class="request">analysis.getErrors</dt><dd><div cla ss="box"><pre>request: { 343 <h3>Requests</h3><dl><dt class="request">analysis.getErrors</dt><dd><div cla ss="box"><pre>request: {
342 "id": String 344 "id": String
343 "method": "analysis.getErrors" 345 "method": "analysis.getErrors"
344 "params": { 346 "params": {
345 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 347 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
346 } 348 }
347 }</pre><br><pre>response: { 349 }</pre><br><pre>response: {
348 "id": String 350 "id": String
349 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 351 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
350 "result": { 352 "result": {
(...skipping 55 matching lines...) Expand 10 before | Expand all | Expand 10 after
406 Return the hover information associate with the given 408 Return the hover information associate with the given
407 location. If some or all of the hover information is not 409 location. If some or all of the hover information is not
408 available at the time this request is processed the 410 available at the time this request is processed the
409 information will be omitted from the response. 411 information will be omitted from the response.
410 </p> 412 </p>
411 413
412 414
413 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd> 415 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>
414 416
415 <p> 417 <p>
416 The file in which hover information is being 418 The file in which hover information is being requested.
417 requested.
418 </p> 419 </p>
419 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> 420 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>
420 421
421 <p> 422 <p>
422 The offset for which hover information is being 423 The offset for which hover information is being requested.
423 requested.
424 </p> 424 </p>
425 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>hovers ( List&lt ;<a href="#type_HoverInformation">HoverInformation</a>&gt; )</i></b></dt><dd> 425 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>hovers ( List&lt ;<a href="#type_HoverInformation">HoverInformation</a>&gt; )</i></b></dt><dd>
426 426
427 <p> 427 <p>
428 The hover information associated with the 428 The hover information associated with the
429 location. The list will be empty if no information 429 location. The list will be empty if no information
430 could be determined for the location. The list can 430 could be determined for the location. The list can
431 contain multiple items if the file is being analyzed 431 contain multiple items if the file is being analyzed
432 in multiple contexts in conflicting ways (such as a 432 in multiple contexts in conflicting ways (such as a
433 part that is included in multiple libraries). 433 part that is included in multiple libraries).
434 </p> 434 </p>
435 </dd></dl></dd><dt class="request">analysis.getNavigation</dt><dd><div class="box"><pre>request: {
436 "id": String
437 "method": "analysis.getNavigation"
438 "params": {
439 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
440 "<b>start</b>": int
441 "<b>end</b>": int
442 }
443 }</pre><br><pre>response: {
444 "id": String
445 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
446 "result": {
447 "<b>files</b>": List&lt;<a href="#type_FilePath">FilePath</a>&gt;
448 "<b>targets</b>": List&lt;<a href="#type_NavigationTarget">NavigationTarget< /a>&gt;
449 "<b>regions</b>": List&lt;<a href="#type_NavigationRegion">NavigationRegion< /a>&gt;
450 }
451 }</pre></div>
452 <p>
453 Return the navigation information associated with the given region of
454 the given file.
455 </p>
456 <p>
457 If a navigation region is partially contained in (but extends either
458 before or after) the given region of the file it will be included in
459 the result. This means that it is theoretically possible to get the
460 same navigation region in response to multiple requests. Clients can
461 avoid this by always choosing a region that starts at the beginning of
462 a line and ends at the end of a line in the file.
463 </p>
464
465
466 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>
467
468 <p>
469 The file in which navigation information is being requested.
470 </p>
471 </dd><dt class="field"><b><i>start ( int )</i></b></dt><dd>
472
473 <p>
474 The offset of the start of the region for which hover information
475 is being requested.
476 </p>
477 </dd><dt class="field"><b><i>end ( int )</i></b></dt><dd>
478
479 <p>
480 The offset of the end of the region for which hover information is
481 being requested.
482 </p>
483 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>files ( List&lt; <a href="#type_FilePath">FilePath</a>&gt; )</i></b></dt><dd>
484
485 <p>
486 A list of the paths of files that are referenced by the navigation
487 targets.
488 </p>
489 </dd><dt class="field"><b><i>targets ( List&lt;<a href="#type_Navigati onTarget">NavigationTarget</a>&gt; )</i></b></dt><dd>
490
491 <p>
492 A list of the navigation targets that are referenced by the
493 navigation regions.
494 </p>
495 </dd><dt class="field"><b><i>regions ( List&lt;<a href="#type_Navigati onRegion">NavigationRegion</a>&gt; )</i></b></dt><dd>
496
497 <p>
498 A list of the navigation regions within the requested region of
499 the file.
500 </p>
435 </dd></dl></dd><dt class="request">analysis.reanalyze</dt><dd><div cla ss="box"><pre>request: { 501 </dd></dl></dd><dt class="request">analysis.reanalyze</dt><dd><div cla ss="box"><pre>request: {
436 "id": String 502 "id": String
437 "method": "analysis.reanalyze" 503 "method": "analysis.reanalyze"
438 }</pre><br><pre>response: { 504 }</pre><br><pre>response: {
439 "id": String 505 "id": String
440 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 506 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
441 }</pre></div> 507 }</pre></div>
442 <p> 508 <p>
443 Force the re-analysis of everything contained in the 509 Force the re-analysis of everything contained in the
444 existing analysis roots. This will cause all previously 510 existing analysis roots. This will cause all previously
(...skipping 327 matching lines...) Expand 10 before | Expand all | Expand 10 after
772 </dd><dt class="field"><b><i>regions ( List&lt;<a href="#type_Highligh tRegion">HighlightRegion</a>&gt; )</i></b></dt><dd> 838 </dd><dt class="field"><b><i>regions ( List&lt;<a href="#type_Highligh tRegion">HighlightRegion</a>&gt; )</i></b></dt><dd>
773 839
774 <p> 840 <p>
775 The highlight regions contained in the file. Each 841 The highlight regions contained in the file. Each
776 highlight region represents a particular syntactic or 842 highlight region represents a particular syntactic or
777 semantic meaning associated with some range. Note that 843 semantic meaning associated with some range. Note that
778 the highlight regions that are returned can overlap 844 the highlight regions that are returned can overlap
779 other highlight regions if there is more than one 845 other highlight regions if there is more than one
780 meaning associated with a particular region. 846 meaning associated with a particular region.
781 </p> 847 </p>
848 </dd></dl></dd><dt class="notification">analysis.invalidate</dt><dd><d iv class="box"><pre>notification: {
849 "event": "analysis.invalidate"
850 "params": {
851 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
852 "<b>start</b>": int
853 "<b>end</b>": int
854 "<b>delta</b>": int
855 }
856 }</pre></div>
857 <p>
858 Reports that the navigation information associated with a region of a
859 single file has become invalid and should be re-requested.
860 </p>
861 <p>
862 This notification is not subscribed to by default. Clients can
863 subscribe by including the value <tt>"INVALIDATE"</tt> in the list of
864 services passed in an analysis.setSubscriptions request.
865 </p>
866
867 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>
868
869 <p>
870 The file whose information has been invalidated.
871 </p>
872 </dd><dt class="field"><b><i>start ( int )</i></b></dt><dd>
873
874 <p>
875 The offset of the start of the invalidated region.
876 </p>
877 </dd><dt class="field"><b><i>end ( int )</i></b></dt><dd>
878
879 <p>
880 The offset of the end of the invalidated region.
881 </p>
882 </dd><dt class="field"><b><i>delta ( int )</i></b></dt><dd>
883
884 <p>
885 The delta to be applied to the offsets in information that follows
886 the invalidated region in order to update it so that it doesn't
887 need to be re-requested.
888 </p>
782 </dd></dl></dd><dt class="notification">analysis.navigation</dt><dd><d iv class="box"><pre>notification: { 889 </dd></dl></dd><dt class="notification">analysis.navigation</dt><dd><d iv class="box"><pre>notification: {
783 "event": "analysis.navigation" 890 "event": "analysis.navigation"
784 "params": { 891 "params": {
785 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 892 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
786 "<b>regions</b>": List&lt;<a href="#type_NavigationRegion">NavigationRegion< /a>&gt; 893 "<b>regions</b>": List&lt;<a href="#type_NavigationRegion">NavigationRegion< /a>&gt;
787 "<b>targets</b>": List&lt;<a href="#type_NavigationTarget">NavigationTarget< /a>&gt; 894 "<b>targets</b>": List&lt;<a href="#type_NavigationTarget">NavigationTarget< /a>&gt;
788 "<b>files</b>": List&lt;<a href="#type_FilePath">FilePath</a>&gt; 895 "<b>files</b>": List&lt;<a href="#type_FilePath">FilePath</a>&gt;
789 } 896 }
790 }</pre></div> 897 }</pre></div>
791 <p> 898 <p>
(...skipping 1142 matching lines...) Expand 10 before | Expand all | Expand 10 after
1934 <p> 2041 <p>
1935 True is hints should be generated as part of generating 2042 True is hints should be generated as part of generating
1936 errors and warnings. 2043 errors and warnings.
1937 </p> 2044 </p>
1938 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisServic e">AnalysisService: String</a></dt><dd> 2045 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisServic e">AnalysisService: String</a></dt><dd>
1939 <p> 2046 <p>
1940 An enumeration of the services provided by the analysis 2047 An enumeration of the services provided by the analysis
1941 domain. 2048 domain.
1942 </p> 2049 </p>
1943 2050
1944 <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> 2051 <dl><dt class="value">FOLDING</dt><dt class="value">HIGHLIGHTS</dt><dt cla ss="value">INVALIDATE</dt><dt class="value">NAVIGATION</dt><dt class="value">OCC URRENCES</dt><dt class="value">OUTLINE</dt><dt class="value">OVERRIDES</dt></dl> </dd><dt class="typeDefinition"><a name="type_AnalysisStatus">AnalysisStatus: ob ject</a></dt><dd>
1945 <p> 2052 <p>
1946 An indication of the current state of analysis. 2053 An indication of the current state of analysis.
1947 </p> 2054 </p>
1948 2055
1949 <dl><dt class="field"><b><i>isAnalyzing ( bool )</i></b></dt><dd> 2056 <dl><dt class="field"><b><i>isAnalyzing ( bool )</i></b></dt><dd>
1950 2057
1951 <p>True if analysis is currently being performed.</p> 2058 <p>True if analysis is currently being performed.</p>
1952 </dd><dt class="field"><b><i>analysisTarget ( <span style="color:#9999 99">optional</span> String )</i></b></dt><dd> 2059 </dd><dt class="field"><b><i>analysisTarget ( <span style="color:#9999 99">optional</span> String )</i></b></dt><dd>
1953 2060
1954 <p> 2061 <p>
(...skipping 1436 matching lines...) Expand 10 before | Expand all | Expand 10 after
3391 <p> 3498 <p>
3392 This section contains a list of all of the errors that are 3499 This section contains a list of all of the errors that are
3393 produced by the server and the data that is returned with each. 3500 produced by the server and the data that is returned with each.
3394 </p> 3501 </p>
3395 <p> 3502 <p>
3396 TBD 3503 TBD
3397 </p> 3504 </p>
3398 3505
3399 3506
3400 </body></html> 3507 </body></html>
OLDNEW
« no previous file with comments | « editor/tools/plugins/com.google.dart.server/src/com/google/dart/server/generated/types/AnalysisService.java ('k') | pkg/analysis_server/lib/src/generated_protocol.dart » ('j') | pkg/analysis_server/tool/spec/spec_input.html » ('J')

Powered by Google App Engine
This is Rietveld 408576698