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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 531153002: Clarify type names in 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.ui/src/com/google/dart/tools/ui/internal/text/correction/QuickFixProcessor_OLD.java ('k') | pkg/analysis_server/lib/src/edit/edit_domain.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 1326 matching lines...) Expand 10 before | Expand all | Expand 10 after
1337 "id": String 1337 "id": String
1338 "method": "edit.getFixes" 1338 "method": "edit.getFixes"
1339 "params": { 1339 "params": {
1340 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 1340 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
1341 "<b>offset</b>": int 1341 "<b>offset</b>": int
1342 } 1342 }
1343 }</pre><br><pre>response: { 1343 }</pre><br><pre>response: {
1344 "id": String 1344 "id": String
1345 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 1345 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
1346 "result": { 1346 "result": {
1347 "<b>fixes</b>": List&lt;<a href="#type_ErrorFixes">ErrorFixes</a>&gt; 1347 "<b>fixes</b>": List&lt;<a href="#type_AnalysisErrorFixes">AnalysisErrorFixe s</a>&gt;
1348 } 1348 }
1349 }</pre></div> 1349 }</pre></div>
1350 <p> 1350 <p>
1351 Return the set of fixes that are available for the errors at 1351 Return the set of fixes that are available for the errors at
1352 a given offset in a given file. 1352 a given offset in a given file.
1353 </p> 1353 </p>
1354 1354
1355 1355
1356 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd> 1356 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>
1357 1357
1358 <p> 1358 <p>
1359 The file containing the errors for which fixes are being 1359 The file containing the errors for which fixes are being
1360 requested. 1360 requested.
1361 </p> 1361 </p>
1362 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> 1362 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>
1363 1363
1364 <p> 1364 <p>
1365 The offset used to select the errors for which fixes 1365 The offset used to select the errors for which fixes
1366 will be returned. 1366 will be returned.
1367 </p> 1367 </p>
1368 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>fixes ( List&lt; <a href="#type_ErrorFixes">ErrorFixes</a>&gt; )</i></b></dt><dd> 1368 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>fixes ( List&lt; <a href="#type_AnalysisErrorFixes">AnalysisErrorFixes</a>&gt; )</i></b></dt><dd>
1369 1369
1370 <p> 1370 <p>
1371 The fixes that are available for each of the analysis 1371 The fixes that are available for each of the analysis
1372 errors. There is a one-to-one correspondence between the 1372 errors. There is a one-to-one correspondence between the
1373 analysis errors in the request and the lists of changes 1373 analysis errors in the request and the lists of changes
1374 in the response. In particular, it is always the case 1374 in the response. In particular, it is always the case
1375 that errors.length == fixes.length and that fixes[i] is 1375 that errors.length == fixes.length and that fixes[i] is
1376 the list of fixes for the error in errors[i]. The list 1376 the list of fixes for the error in errors[i]. The list
1377 of changes corresponding to an error can be empty if 1377 of changes corresponding to an error can be empty if
1378 there are no fixes available for that error. 1378 there are no fixes available for that error.
(...skipping 355 matching lines...) Expand 10 before | Expand all | Expand 10 after
1734 1734
1735 <p> 1735 <p>
1736 The new content of the file. 1736 The new content of the file.
1737 </p> 1737 </p>
1738 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisError" >AnalysisError: object</a></dt><dd> 1738 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisError" >AnalysisError: object</a></dt><dd>
1739 <p> 1739 <p>
1740 An indication of an error, warning, or hint that was produced 1740 An indication of an error, warning, or hint that was produced
1741 by the analysis. 1741 by the analysis.
1742 </p> 1742 </p>
1743 1743
1744 <dl><dt class="field"><b><i>severity ( <a href="#type_ErrorSeverity">Error Severity</a> )</i></b></dt><dd> 1744 <dl><dt class="field"><b><i>severity ( <a href="#type_AnalysisErrorSeverit y">AnalysisErrorSeverity</a> )</i></b></dt><dd>
1745 1745
1746 <p> 1746 <p>
1747 The severity of the error. 1747 The severity of the error.
1748 </p> 1748 </p>
1749 </dd><dt class="field"><b><i>type ( <a href="#type_ErrorType">ErrorTyp e</a> )</i></b></dt><dd> 1749 </dd><dt class="field"><b><i>type ( <a href="#type_AnalysisErrorType"> AnalysisErrorType</a> )</i></b></dt><dd>
1750 1750
1751 <p> 1751 <p>
1752 The type of the error. 1752 The type of the error.
1753 </p> 1753 </p>
1754 </dd><dt class="field"><b><i>location ( <a href="#type_Location">Locat ion</a> )</i></b></dt><dd> 1754 </dd><dt class="field"><b><i>location ( <a href="#type_Location">Locat ion</a> )</i></b></dt><dd>
1755 1755
1756 <p> 1756 <p>
1757 The location associated with the error. 1757 The location associated with the error.
1758 </p> 1758 </p>
1759 </dd><dt class="field"><b><i>message ( String )</i></b></dt><dd> 1759 </dd><dt class="field"><b><i>message ( String )</i></b></dt><dd>
1760 1760
1761 <p> 1761 <p>
1762 The message to be displayed for this error. The message 1762 The message to be displayed for this error. The message
1763 should indicate what is wrong with the code and why it is 1763 should indicate what is wrong with the code and why it is
1764 wrong. 1764 wrong.
1765 </p> 1765 </p>
1766 </dd><dt class="field"><b><i>correction ( <span style="color:#999999"> optional</span> String )</i></b></dt><dd> 1766 </dd><dt class="field"><b><i>correction ( <span style="color:#999999"> optional</span> String )</i></b></dt><dd>
1767 1767
1768 <p> 1768 <p>
1769 The correction message to be displayed for this error. The 1769 The correction message to be displayed for this error. The
1770 correction message should indicate how the user can fix 1770 correction message should indicate how the user can fix
1771 the error. The field is omitted if there is no correction 1771 the error. The field is omitted if there is no correction
1772 message associated with the error code. 1772 message associated with the error code.
1773 </p> 1773 </p>
1774 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisOption s">AnalysisOptions: object</a></dt><dd> 1774 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorF ixes">AnalysisErrorFixes: object</a></dt><dd>
1775 <p>
1776 A list of fixes associated with a specific error
1777 </p>
1778
1779 <dl><dt class="field"><b><i>error ( <a href="#type_AnalysisError">Analysis Error</a> )</i></b></dt><dd>
1780
1781 <p>
1782 The error with which the fixes are associated.
1783 </p>
1784 </dd><dt class="field"><b><i>fixes ( List&lt;<a href="#type_SourceChan ge">SourceChange</a>&gt; )</i></b></dt><dd>
1785
1786 <p>
1787 The fixes associated with the error.
1788 </p>
1789 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorS everity">AnalysisErrorSeverity: String</a></dt><dd>
1790 <p>
1791 An enumeration of the possible severities of analysis
1792 errors.
1793 </p>
1794
1795 <dl><dt class="value">INFO</dt><dt class="value">WARNING</dt><dt class="va lue">ERROR</dt></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorT ype">AnalysisErrorType: String</a></dt><dd>
1796 <p>
1797 An enumeration of the possible types of analysis errors.
1798 </p>
1799
1800 <dl><dt class="value">COMPILE_TIME_ERROR</dt><dt class="value">HINT</dt><d t class="value">STATIC_TYPE_WARNING</dt><dt class="value">STATIC_WARNING</dt><dt class="value">SYNTACTIC_ERROR</dt><dt class="value">TODO</dt></dl></dd><dt clas s="typeDefinition"><a name="type_AnalysisOptions">AnalysisOptions: object</a></d t><dd>
1775 <p> 1801 <p>
1776 A set of options controlling what kind of analysis is to be 1802 A set of options controlling what kind of analysis is to be
1777 performed. If the value of a field is omitted the value of the 1803 performed. If the value of a field is omitted the value of the
1778 option will not be changed. 1804 option will not be changed.
1779 </p> 1805 </p>
1780 1806
1781 <dl><dt class="field"><b><i>enableAsync ( <span style="color:#999999">opti onal</span> bool )</i></b></dt><dd> 1807 <dl><dt class="field"><b><i>enableAsync ( <span style="color:#999999">opti onal</span> bool )</i></b></dt><dd>
1782 1808
1783 <p> 1809 <p>
1784 True if the client wants to enable support for the 1810 True if the client wants to enable support for the
(...skipping 262 matching lines...) Expand 10 before | Expand all | Expand 10 after
2047 The return type of the element. If the element is not a 2073 The return type of the element. If the element is not a
2048 method or function this field will not be defined. If the 2074 method or function this field will not be defined. If the
2049 element does not have a declared return type, this field 2075 element does not have a declared return type, this field
2050 will contain an empty string. 2076 will contain an empty string.
2051 </p> 2077 </p>
2052 </dd></dl></dd><dt class="typeDefinition"><a name="type_ElementKind">E lementKind: String</a></dt><dd> 2078 </dd></dl></dd><dt class="typeDefinition"><a name="type_ElementKind">E lementKind: String</a></dt><dd>
2053 <p> 2079 <p>
2054 An enumeration of the kinds of elements. 2080 An enumeration of the kinds of elements.
2055 </p> 2081 </p>
2056 2082
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_ErrorFixes">ErrorFixes: object</a></dt><dd> 2083 <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_ExecutableFile">ExecutableFile: object</a></dt><d d>
2058 <p>
2059 A list of fixes associated with a specific error
2060 </p>
2061
2062 <dl><dt class="field"><b><i>error ( <a href="#type_AnalysisError">Analysis Error</a> )</i></b></dt><dd>
2063
2064 <p>
2065 The error with which the fixes are associated.
2066 </p>
2067 </dd><dt class="field"><b><i>fixes ( List&lt;<a href="#type_SourceChan ge">SourceChange</a>&gt; )</i></b></dt><dd>
2068
2069 <p>
2070 The fixes associated with the error.
2071 </p>
2072 </dd></dl></dd><dt class="typeDefinition"><a name="type_ErrorSeverity" >ErrorSeverity: String</a></dt><dd>
2073 <p>
2074 An enumeration of the possible severities of analysis
2075 errors.
2076 </p>
2077
2078 <dl><dt class="value">INFO</dt><dt class="value">WARNING</dt><dt class="va lue">ERROR</dt></dl></dd><dt class="typeDefinition"><a name="type_ErrorType">Err orType: String</a></dt><dd>
2079 <p>
2080 An enumeration of the possible types of analysis errors.
2081 </p>
2082
2083 <dl><dt class="value">COMPILE_TIME_ERROR</dt><dt class="value">HINT</dt><d t class="value">STATIC_TYPE_WARNING</dt><dt class="value">STATIC_WARNING</dt><dt class="value">SYNTACTIC_ERROR</dt><dt class="value">TODO</dt></dl></dd><dt clas s="typeDefinition"><a name="type_ExecutableFile">ExecutableFile: object</a></dt> <dd>
2084 <p> 2084 <p>
2085 A description of an executable file. 2085 A description of an executable file.
2086 </p> 2086 </p>
2087 2087
2088 <dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> ) </i></b></dt><dd> 2088 <dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> ) </i></b></dt><dd>
2089 2089
2090 <p> 2090 <p>
2091 The path of the executable file. 2091 The path of the executable file.
2092 </p> 2092 </p>
2093 </dd><dt class="field"><b><i>offset ( <a href="#type_ExecutableKind">E xecutableKind</a> )</i></b></dt><dd> 2093 </dd><dt class="field"><b><i>offset ( <a href="#type_ExecutableKind">E xecutableKind</a> )</i></b></dt><dd>
(...skipping 996 matching lines...) Expand 10 before | Expand all | Expand 10 after
3090 <p> 3090 <p>
3091 This section contains a list of all of the errors that are 3091 This section contains a list of all of the errors that are
3092 produced by the server and the data that is returned with each. 3092 produced by the server and the data that is returned with each.
3093 </p> 3093 </p>
3094 <p> 3094 <p>
3095 TBD 3095 TBD
3096 </p> 3096 </p>
3097 3097
3098 3098
3099 </body></html> 3099 </body></html>
OLDNEW
« no previous file with comments | « editor/tools/plugins/com.google.dart.tools.ui/src/com/google/dart/tools/ui/internal/text/correction/QuickFixProcessor_OLD.java ('k') | pkg/analysis_server/lib/src/edit/edit_domain.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698