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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: pkg/analysis_server/tool/spec/spec_input.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 | « pkg/analysis_server/tool/spec/codegen_dart_protocol.dart ('k') | no next file » | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <html> 1 <html>
2 <head> 2 <head>
3 <meta charset="UTF-8"/> 3 <meta charset="UTF-8"/>
4 <title>Analysis Server API Specification</title> 4 <title>Analysis Server API Specification</title>
5 </head> 5 </head>
6 <body> 6 <body>
7 <h1>Analysis Server API Specification</h1> 7 <h1>Analysis Server API Specification</h1>
8 <h1 style="color:#999999">WORKING DRAFT - Version <version>0.3</version></h1 > 8 <h1 style="color:#999999">WORKING DRAFT - Version <version>0.3</version></h1 >
9 <p> 9 <p>
10 This document contains a specification of the API provided by 10 This document contains a specification of the API provided by
(...skipping 1133 matching lines...) Expand 10 before | Expand all | Expand 10 after
1144 <field name="offset"> 1144 <field name="offset">
1145 <ref>int</ref> 1145 <ref>int</ref>
1146 <p> 1146 <p>
1147 The offset used to select the errors for which fixes 1147 The offset used to select the errors for which fixes
1148 will be returned. 1148 will be returned.
1149 </p> 1149 </p>
1150 </field> 1150 </field>
1151 </params> 1151 </params>
1152 <result> 1152 <result>
1153 <field name="fixes"> 1153 <field name="fixes">
1154 <list><ref>ErrorFixes</ref></list> 1154 <list><ref>AnalysisErrorFixes</ref></list>
1155 <p> 1155 <p>
1156 The fixes that are available for each of the analysis 1156 The fixes that are available for each of the analysis
1157 errors. There is a one-to-one correspondence between the 1157 errors. There is a one-to-one correspondence between the
1158 analysis errors in the request and the lists of changes 1158 analysis errors in the request and the lists of changes
1159 in the response. In particular, it is always the case 1159 in the response. In particular, it is always the case
1160 that errors.length == fixes.length and that fixes[i] is 1160 that errors.length == fixes.length and that fixes[i] is
1161 the list of fixes for the error in errors[i]. The list 1161 the list of fixes for the error in errors[i]. The list
1162 of changes corresponding to an error can be empty if 1162 of changes corresponding to an error can be empty if
1163 there are no fixes available for that error. 1163 there are no fixes available for that error.
1164 </p> 1164 </p>
(...skipping 283 matching lines...) Expand 10 before | Expand all | Expand 10 after
1448 </field> 1448 </field>
1449 </object> 1449 </object>
1450 </type> 1450 </type>
1451 <type name="AnalysisError"> 1451 <type name="AnalysisError">
1452 <p> 1452 <p>
1453 An indication of an error, warning, or hint that was produced 1453 An indication of an error, warning, or hint that was produced
1454 by the analysis. 1454 by the analysis.
1455 </p> 1455 </p>
1456 <object> 1456 <object>
1457 <field name="severity"> 1457 <field name="severity">
1458 <ref>ErrorSeverity</ref> 1458 <ref>AnalysisErrorSeverity</ref>
1459 <p> 1459 <p>
1460 The severity of the error. 1460 The severity of the error.
1461 </p> 1461 </p>
1462 </field> 1462 </field>
1463 <field name="type"> 1463 <field name="type">
1464 <ref>ErrorType</ref> 1464 <ref>AnalysisErrorType</ref>
1465 <p> 1465 <p>
1466 The type of the error. 1466 The type of the error.
1467 </p> 1467 </p>
1468 </field> 1468 </field>
1469 <field name="location"> 1469 <field name="location">
1470 <ref>Location</ref> 1470 <ref>Location</ref>
1471 <p> 1471 <p>
1472 The location associated with the error. 1472 The location associated with the error.
1473 </p> 1473 </p>
1474 </field> 1474 </field>
1475 <field name="message"> 1475 <field name="message">
1476 <ref>String</ref> 1476 <ref>String</ref>
1477 <p> 1477 <p>
1478 The message to be displayed for this error. The message 1478 The message to be displayed for this error. The message
1479 should indicate what is wrong with the code and why it is 1479 should indicate what is wrong with the code and why it is
1480 wrong. 1480 wrong.
1481 </p> 1481 </p>
1482 </field> 1482 </field>
1483 <field name="correction" optional="true"> 1483 <field name="correction" optional="true">
1484 <ref>String</ref> 1484 <ref>String</ref>
1485 <p> 1485 <p>
1486 The correction message to be displayed for this error. The 1486 The correction message to be displayed for this error. The
1487 correction message should indicate how the user can fix 1487 correction message should indicate how the user can fix
1488 the error. The field is omitted if there is no correction 1488 the error. The field is omitted if there is no correction
1489 message associated with the error code. 1489 message associated with the error code.
1490 </p> 1490 </p>
1491 </field> 1491 </field>
1492 </object> 1492 </object>
1493 </type> 1493 </type>
1494 <type name="AnalysisErrorFixes">
1495 <p>
1496 A list of fixes associated with a specific error
1497 </p>
1498 <object>
1499 <field name="error">
1500 <ref>AnalysisError</ref>
1501 <p>
1502 The error with which the fixes are associated.
1503 </p>
1504 </field>
1505 <field name="fixes">
1506 <list><ref>SourceChange</ref></list>
1507 <p>
1508 The fixes associated with the error.
1509 </p>
1510 </field>
1511 </object>
1512 </type>
1513 <type name="AnalysisErrorSeverity">
1514 <p>
1515 An enumeration of the possible severities of analysis
1516 errors.
1517 </p>
1518 <enum>
1519 <value><code>INFO</code></value>
1520 <value><code>WARNING</code></value>
1521 <value><code>ERROR</code></value>
1522 </enum>
1523 </type>
1524 <type name="AnalysisErrorType">
1525 <p>
1526 An enumeration of the possible types of analysis errors.
1527 </p>
1528 <enum>
1529 <value><code>COMPILE_TIME_ERROR</code></value>
1530 <value><code>HINT</code></value>
1531 <value><code>STATIC_TYPE_WARNING</code></value>
1532 <value><code>STATIC_WARNING</code></value>
1533 <value><code>SYNTACTIC_ERROR</code></value>
1534 <value><code>TODO</code></value>
1535 </enum>
1536 </type>
1494 <type name="AnalysisOptions"> 1537 <type name="AnalysisOptions">
1495 <p> 1538 <p>
1496 A set of options controlling what kind of analysis is to be 1539 A set of options controlling what kind of analysis is to be
1497 performed. If the value of a field is omitted the value of the 1540 performed. If the value of a field is omitted the value of the
1498 option will not be changed. 1541 option will not be changed.
1499 </p> 1542 </p>
1500 <object> 1543 <object>
1501 <field name="enableAsync" optional="true"> 1544 <field name="enableAsync" optional="true">
1502 <ref>bool</ref> 1545 <ref>bool</ref>
1503 <p> 1546 <p>
(...skipping 365 matching lines...) Expand 10 before | Expand all | Expand 10 after
1869 <value><code>METHOD</code></value> 1912 <value><code>METHOD</code></value>
1870 <value><code>PARAMETER</code></value> 1913 <value><code>PARAMETER</code></value>
1871 <value><code>SETTER</code></value> 1914 <value><code>SETTER</code></value>
1872 <value><code>TOP_LEVEL_VARIABLE</code></value> 1915 <value><code>TOP_LEVEL_VARIABLE</code></value>
1873 <value><code>TYPE_PARAMETER</code></value> 1916 <value><code>TYPE_PARAMETER</code></value>
1874 <value><code>UNIT_TEST_GROUP</code></value> 1917 <value><code>UNIT_TEST_GROUP</code></value>
1875 <value><code>UNIT_TEST_TEST</code></value> 1918 <value><code>UNIT_TEST_TEST</code></value>
1876 <value><code>UNKNOWN</code></value> 1919 <value><code>UNKNOWN</code></value>
1877 </enum> 1920 </enum>
1878 </type> 1921 </type>
1879 <type name="ErrorFixes">
1880 <p>
1881 A list of fixes associated with a specific error
1882 </p>
1883 <object>
1884 <field name="error">
1885 <ref>AnalysisError</ref>
1886 <p>
1887 The error with which the fixes are associated.
1888 </p>
1889 </field>
1890 <field name="fixes">
1891 <list><ref>SourceChange</ref></list>
1892 <p>
1893 The fixes associated with the error.
1894 </p>
1895 </field>
1896 </object>
1897 </type>
1898 <type name="ErrorSeverity">
1899 <p>
1900 An enumeration of the possible severities of analysis
1901 errors.
1902 </p>
1903 <enum>
1904 <value><code>INFO</code></value>
1905 <value><code>WARNING</code></value>
1906 <value><code>ERROR</code></value>
1907 </enum>
1908 </type>
1909 <type name="ErrorType">
1910 <p>
1911 An enumeration of the possible types of analysis errors.
1912 </p>
1913 <enum>
1914 <value><code>COMPILE_TIME_ERROR</code></value>
1915 <value><code>HINT</code></value>
1916 <value><code>STATIC_TYPE_WARNING</code></value>
1917 <value><code>STATIC_WARNING</code></value>
1918 <value><code>SYNTACTIC_ERROR</code></value>
1919 <value><code>TODO</code></value>
1920 </enum>
1921 </type>
1922 <type name="ExecutableFile"> 1922 <type name="ExecutableFile">
1923 <p> 1923 <p>
1924 A description of an executable file. 1924 A description of an executable file.
1925 </p> 1925 </p>
1926 <object> 1926 <object>
1927 <field name="file"> 1927 <field name="file">
1928 <ref>FilePath</ref> 1928 <ref>FilePath</ref>
1929 <p> 1929 <p>
1930 The path of the executable file. 1930 The path of the executable file.
1931 </p> 1931 </p>
(...skipping 1251 matching lines...) Expand 10 before | Expand all | Expand 10 after
3183 <h2>Errors</h2> 3183 <h2>Errors</h2>
3184 <p> 3184 <p>
3185 This section contains a list of all of the errors that are 3185 This section contains a list of all of the errors that are
3186 produced by the server and the data that is returned with each. 3186 produced by the server and the data that is returned with each.
3187 </p> 3187 </p>
3188 <p> 3188 <p>
3189 TBD 3189 TBD
3190 </p> 3190 </p>
3191 </body> 3191 </body>
3192 </html> 3192 </html>
OLDNEW
« no previous file with comments | « pkg/analysis_server/tool/spec/codegen_dart_protocol.dart ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698