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

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

Issue 800913002: Report pub status (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Address comments 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
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 277 matching lines...) Expand 10 before | Expand all | Expand 10 after
288 </dd><dt class="field"><b><i>stackTrace ( String )</i></b></dt><dd> 288 </dd><dt class="field"><b><i>stackTrace ( String )</i></b></dt><dd>
289 289
290 <p> 290 <p>
291 The stack trace associated with the generation of the 291 The stack trace associated with the generation of the
292 error, used for debugging the server. 292 error, used for debugging the server.
293 </p> 293 </p>
294 </dd></dl></dd><dt class="notification">server.status</dt><dd><div cla ss="box"><pre>notification: { 294 </dd></dl></dd><dt class="notification">server.status</dt><dd><div cla ss="box"><pre>notification: {
295 "event": "server.status" 295 "event": "server.status"
296 "params": { 296 "params": {
297 "<b>analysis</b>": <span style="color:#999999">optional</span> <a href="#typ e_AnalysisStatus">AnalysisStatus</a> 297 "<b>analysis</b>": <span style="color:#999999">optional</span> <a href="#typ e_AnalysisStatus">AnalysisStatus</a>
298 "<b>pub</b>": <span style="color:#999999">optional</span> <a href="#type_Pub Status">PubStatus</a>
298 } 299 }
299 }</pre></div> 300 }</pre></div>
300 <p> 301 <p>
301 Reports the current status of the server. Parameters are 302 Reports the current status of the server. Parameters are
302 omitted if there has been no change in the status 303 omitted if there has been no change in the status
303 represented by that parameter. 304 represented by that parameter.
304 </p> 305 </p>
305 <p> 306 <p>
306 This notification is not subscribed to by default. Clients 307 This notification is not subscribed to by default. Clients
307 can subscribe by including the value <tt>"STATUS"</tt> in 308 can subscribe by including the value <tt>"STATUS"</tt> in
308 the list of services passed in a server.setSubscriptions 309 the list of services passed in a server.setSubscriptions
309 request. 310 request.
310 </p> 311 </p>
311 312
312 <h4>Parameters</h4><dl><dt class="field"><b><i>analysis ( <span style="col or:#999999">optional</span> <a href="#type_AnalysisStatus">AnalysisStatus</a> )< /i></b></dt><dd> 313 <h4>Parameters</h4><dl><dt class="field"><b><i>analysis ( <span style="col or:#999999">optional</span> <a href="#type_AnalysisStatus">AnalysisStatus</a> )< /i></b></dt><dd>
313 314
314 <p> 315 <p>
315 The current status of analysis, including whether 316 The current status of analysis, including whether
316 analysis is being performed and if so what is being 317 analysis is being performed and if so what is being
317 analyzed. 318 analyzed.
318 </p> 319 </p>
320 </dd><dt class="field"><b><i>pub ( <span style="color:#999999">optiona l</span> <a href="#type_PubStatus">PubStatus</a> )</i></b></dt><dd>
321
322 <p>
323 The current status of pub execution, indicating whether we are
324 currently running pub.
325 </p>
319 </dd></dl></dd></dl> 326 </dd></dl></dd></dl>
320 <h2 class="domain"><a name="domain_analysis">Domain: analysis</a></h2> 327 <h2 class="domain"><a name="domain_analysis">Domain: analysis</a></h2>
321 <p> 328 <p>
322 The analysis domain contains API’s related to the analysis of 329 The analysis domain contains API’s related to the analysis of
323 files. 330 files.
324 </p> 331 </p>
325 332
326 333
327 334
328 335
(...skipping 1598 matching lines...) Expand 10 before | Expand all | Expand 10 after
1927 1934
1928 1935
1929 1936
1930 1937
1931 1938
1932 1939
1933 1940
1934 1941
1935 1942
1936 1943
1944
1937 <dl><dt class="typeDefinition"><a name="type_AddContentOverlay">AddContentOv erlay: object</a></dt><dd> 1945 <dl><dt class="typeDefinition"><a name="type_AddContentOverlay">AddContentOv erlay: object</a></dt><dd>
1938 <p> 1946 <p>
1939 A directive to begin overlaying the contents of a file. The 1947 A directive to begin overlaying the contents of a file. The
1940 supplied content will be used for analysis in place of the 1948 supplied content will be used for analysis in place of the
1941 file contents in the filesystem. 1949 file contents in the filesystem.
1942 </p> 1950 </p>
1943 <p> 1951 <p>
1944 If this directive is used on a file that already has a file 1952 If this directive is used on a file that already has a file
1945 content overlay, the old overlay is discarded and replaced 1953 content overlay, the old overlay is discarded and replaced
1946 with the new one. 1954 with the new one.
(...skipping 799 matching lines...) Expand 10 before | Expand all | Expand 10 after
2746 <dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> ) </i></b></dt><dd> 2754 <dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> ) </i></b></dt><dd>
2747 2755
2748 <p> 2756 <p>
2749 The file containing the position. 2757 The file containing the position.
2750 </p> 2758 </p>
2751 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> 2759 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>
2752 2760
2753 <p> 2761 <p>
2754 The offset of the position. 2762 The offset of the position.
2755 </p> 2763 </p>
2764 </dd></dl></dd><dt class="typeDefinition"><a name="type_PubStatus">Pub Status: object</a></dt><dd>
2765 <p>
2766 An indication of the current state of pub execution.
2767 </p>
2768
2769 <dl><dt class="field"><b><i>isListingPackageDirs ( bool )</i></b></dt><dd>
2770
2771 <p>
2772 True if the server is currently running pub to produce a list of
2773 package directories.
2774 </p>
2756 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringKin d">RefactoringKind: String</a></dt><dd> 2775 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringKin d">RefactoringKind: String</a></dt><dd>
2757 <p> 2776 <p>
2758 An enumeration of the kinds of refactorings that can be 2777 An enumeration of the kinds of refactorings that can be
2759 created. 2778 created.
2760 </p> 2779 </p>
2761 2780
2762 <dl><dt class="value">CONVERT_GETTER_TO_METHOD</dt><dt class="value">CONVE RT_METHOD_TO_GETTER</dt><dt class="value">EXTRACT_LOCAL_VARIABLE</dt><dt class=" value">EXTRACT_METHOD</dt><dt class="value">INLINE_LOCAL_VARIABLE</dt><dt class= "value">INLINE_METHOD</dt><dt class="value">MOVE_FILE</dt><dt class="value">RENA ME</dt><dt class="value">SORT_MEMBERS</dt></dl></dd><dt class="typeDefinition">< a name="type_RefactoringMethodParameter">RefactoringMethodParameter: object</a>< /dt><dd> 2781 <dl><dt class="value">CONVERT_GETTER_TO_METHOD</dt><dt class="value">CONVE RT_METHOD_TO_GETTER</dt><dt class="value">EXTRACT_LOCAL_VARIABLE</dt><dt class=" value">EXTRACT_METHOD</dt><dt class="value">INLINE_LOCAL_VARIABLE</dt><dt class= "value">INLINE_METHOD</dt><dt class="value">MOVE_FILE</dt><dt class="value">RENA ME</dt><dt class="value">SORT_MEMBERS</dt></dl></dd><dt class="typeDefinition">< a name="type_RefactoringMethodParameter">RefactoringMethodParameter: object</a>< /dt><dd>
2763 <p> 2782 <p>
2764 A description of a parameter in a method refactoring. 2783 A description of a parameter in a method refactoring.
2765 </p> 2784 </p>
(...skipping 748 matching lines...) Expand 10 before | Expand all | Expand 10 after
3514 <p> 3533 <p>
3515 This section contains a list of all of the errors that are 3534 This section contains a list of all of the errors that are
3516 produced by the server and the data that is returned with each. 3535 produced by the server and the data that is returned with each.
3517 </p> 3536 </p>
3518 <p> 3537 <p>
3519 TBD 3538 TBD
3520 </p> 3539 </p>
3521 3540
3522 3541
3523 </body></html> 3542 </body></html>
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698