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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 513853002: In the analysis server API, change RequestError.code to an enum. (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.server/src/com/google/dart/server/generated/types/RequestErrorCode.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 1699 matching lines...) Expand 10 before | Expand all | Expand 10 after
1710 1710
1711 1711
1712 1712
1713 1713
1714 1714
1715 1715
1716 1716
1717 1717
1718 1718
1719 1719
1720
1720 <dl><dt class="typeDefinition"><a name="type_AddContentOverlay">AddContentOv erlay: object</a></dt><dd> 1721 <dl><dt class="typeDefinition"><a name="type_AddContentOverlay">AddContentOv erlay: object</a></dt><dd>
1721 <p> 1722 <p>
1722 A directive to begin overlaying the contents of a file. The 1723 A directive to begin overlaying the contents of a file. The
1723 supplied content will be used for analysis in place of the 1724 supplied content will be used for analysis in place of the
1724 file contents in the filesystem. 1725 file contents in the filesystem.
1725 </p> 1726 </p>
1726 <p> 1727 <p>
1727 If this directive is used on a file that already has a file 1728 If this directive is used on a file that already has a file
1728 content overlay, the old overlay is discarded and replaced 1729 content overlay, the old overlay is discarded and replaced
1729 with the new one. 1730 with the new one.
(...skipping 319 matching lines...) Expand 10 before | Expand all | Expand 10 after
2049 will contain an empty string. 2050 will contain an empty string.
2050 </p> 2051 </p>
2051 </dd></dl></dd><dt class="typeDefinition"><a name="type_ElementKind">E lementKind: String</a></dt><dd> 2052 </dd></dl></dd><dt class="typeDefinition"><a name="type_ElementKind">E lementKind: String</a></dt><dd>
2052 <p> 2053 <p>
2053 An enumeration of the kinds of elements. 2054 An enumeration of the kinds of elements.
2054 </p> 2055 </p>
2055 2056
2056 <dl><dt class="value">CLASS</dt><dt class="value">CLASS_TYPE_ALIAS</dt><dt class="value">COMPILATION_UNIT</dt><dt class="value">CONSTRUCTOR</dt><dt class= "value">FIELD</dt><dt class="value">FUNCTION</dt><dt class="value">FUNCTION_TYPE _ALIAS</dt><dt class="value">GETTER</dt><dt class="value">LIBRARY</dt><dt class= "value">LOCAL_VARIABLE</dt><dt class="value">METHOD</dt><dt class="value">PARAME TER</dt><dt class="value">SETTER</dt><dt class="value">TOP_LEVEL_VARIABLE</dt><d t class="value">TYPE_PARAMETER</dt><dt class="value">UNIT_TEST_GROUP</dt><dt cla ss="value">UNIT_TEST_TEST</dt><dt class="value">UNKNOWN</dt></dl></dd><dt class= "typeDefinition"><a name="type_Error">Error: object</a></dt><dd> 2057 <dl><dt class="value">CLASS</dt><dt class="value">CLASS_TYPE_ALIAS</dt><dt class="value">COMPILATION_UNIT</dt><dt class="value">CONSTRUCTOR</dt><dt class= "value">FIELD</dt><dt class="value">FUNCTION</dt><dt class="value">FUNCTION_TYPE _ALIAS</dt><dt class="value">GETTER</dt><dt class="value">LIBRARY</dt><dt class= "value">LOCAL_VARIABLE</dt><dt class="value">METHOD</dt><dt class="value">PARAME TER</dt><dt class="value">SETTER</dt><dt class="value">TOP_LEVEL_VARIABLE</dt><d t class="value">TYPE_PARAMETER</dt><dt class="value">UNIT_TEST_GROUP</dt><dt cla ss="value">UNIT_TEST_TEST</dt><dt class="value">UNKNOWN</dt></dl></dd><dt class= "typeDefinition"><a name="type_Error">Error: object</a></dt><dd>
2057 <p> 2058 <p>
2058 An indication of a problem with the execution of the server, 2059 An indication of a problem with the execution of the server,
2059 typically in response to a request. The error codes that can 2060 typically in response to a request.
2060 be returned are documented in the section titled Errors.
2061 </p> 2061 </p>
2062 2062
2063 <dl><dt class="field"><b><i>code ( String )</i></b></dt><dd> 2063 <dl><dt class="field"><b><i>code ( <a href="#type_RequestErrorCode">Reques tErrorCode</a> )</i></b></dt><dd>
2064 2064
2065 <p> 2065 <p>
2066 A code that uniquely identifies the error that occurred. 2066 A code that uniquely identifies the error that occurred.
2067 </p> 2067 </p>
2068 </dd><dt class="field"><b><i>message ( String )</i></b></dt><dd> 2068 </dd><dt class="field"><b><i>message ( String )</i></b></dt><dd>
2069 2069
2070 <p> 2070 <p>
2071 A short description of the error. 2071 A short description of the error.
2072 </p> 2072 </p>
2073 </dd><dt class="field"><b><i>data ( <span style="color:#999999">option al</span> object )</i></b></dt><dd> 2073 </dd><dt class="field"><b><i>data ( <span style="color:#999999">option al</span> object )</i></b></dt><dd>
(...skipping 483 matching lines...) Expand 10 before | Expand all | Expand 10 after
2557 <p> 2557 <p>
2558 A directive to remove an existing file content overlay. 2558 A directive to remove an existing file content overlay.
2559 After processing this directive, the file contents will once 2559 After processing this directive, the file contents will once
2560 again be read from the file system. 2560 again be read from the file system.
2561 </p> 2561 </p>
2562 <p> 2562 <p>
2563 If this directive is used on a file that doesn't currently 2563 If this directive is used on a file that doesn't currently
2564 have a content overlay, it has no effect. 2564 have a content overlay, it has no effect.
2565 </p> 2565 </p>
2566 2566
2567 <dl><dt class="field"><b><i>type = "remove"</i></b></dt><dd></dd></dl></dd ><dt class="typeDefinition"><a name="type_SearchId">SearchId: String</a></dt><dd > 2567 <dl><dt class="field"><b><i>type = "remove"</i></b></dt><dd></dd></dl></dd ><dt class="typeDefinition"><a name="type_RequestErrorCode">RequestErrorCode: St ring</a></dt><dd>
2568 <p>
2569 An enumeration of the types of errors that can occur in the
2570 execution of the server.
2571 </p>
2572
2573 <dl><dt class="value">GET_ERRORS_ERROR</dt><dd>
2574
2575 <p>
2576 An error occurred during the processing of an
2577 "analysis.getErrors" request.
2578 </p>
2579 </dd><dt class="value">INVALID_PARAMETER</dt><dd>
2580
2581 <p>
2582 One of the method parameters was invalid.
2583 </p>
2584 </dd><dt class="value">INVALID_REQUEST</dt><dd>
2585
2586 <p>
2587 A malformed request was received.
2588 </p>
2589 </dd><dt class="value">SERVER_ALREADY_STARTED</dt><dd>
2590
2591
2592 <p>
2593 The analysis server has already been started (and hence
2594 won't accept new connections).
2595 </p>
2596 </dd><dt class="value">UNANALYZED_PRIORITY_FILES</dt><dd>
2597
2598
2599 <p>
2600 An "analysis.setPriorityFiles" request includes one or
2601 more files that are not being analyzed.
2602 </p>
2603 </dd><dt class="value">UNKNOWN_REQUEST</dt><dd>
2604
2605 <p>
2606 A request was received which the analysis server does
2607 not recognize, or cannot handle in its current
2608 configuation.
2609 </p>
2610 </dd><dt class="value">UNSUPPORTED_FEATURE</dt><dd>
2611
2612 <p>
2613 The analysis server was requested to perform an action
2614 which is not supported.
2615 </p>
2616 </dd></dl></dd><dt class="typeDefinition"><a name="type_SearchId">Sear chId: String</a></dt><dd>
2568 2617
2569 <p> 2618 <p>
2570 An identifier used to associate search results with a search 2619 An identifier used to associate search results with a search
2571 request. 2620 request.
2572 </p> 2621 </p>
2573 </dd><dt class="typeDefinition"><a name="type_SearchResult">SearchResult: object</a></dt><dd> 2622 </dd><dt class="typeDefinition"><a name="type_SearchResult">SearchResult: object</a></dt><dd>
2574 <p> 2623 <p>
2575 A single result from a search request. 2624 A single result from a search request.
2576 </p> 2625 </p>
2577 2626
(...skipping 468 matching lines...) Expand 10 before | Expand all | Expand 10 after
3046 <p> 3095 <p>
3047 This section contains a list of all of the errors that are 3096 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. 3097 produced by the server and the data that is returned with each.
3049 </p> 3098 </p>
3050 <p> 3099 <p>
3051 TBD 3100 TBD
3052 </p> 3101 </p>
3053 3102
3054 3103
3055 </body></html> 3104 </body></html>
OLDNEW
« no previous file with comments | « editor/tools/plugins/com.google.dart.server/src/com/google/dart/server/generated/types/RequestErrorCode.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