| OLD | NEW |
| 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 1462 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1473 </p> | 1473 </p> |
| 1474 </field> | 1474 </field> |
| 1475 </object> | 1475 </object> |
| 1476 </type> | 1476 </type> |
| 1477 <type name="AnalysisOptions"> | 1477 <type name="AnalysisOptions"> |
| 1478 <p> | 1478 <p> |
| 1479 A set of options controlling what kind of analysis is to be | 1479 A set of options controlling what kind of analysis is to be |
| 1480 performed. If the value of a field is omitted the value of the | 1480 performed. If the value of a field is omitted the value of the |
| 1481 option will not be changed. | 1481 option will not be changed. |
| 1482 </p> | 1482 </p> |
| 1483 <p> | |
| 1484 NOTE: These options need to change. | |
| 1485 </p> | |
| 1486 <object> | 1483 <object> |
| 1487 <field name="analyzeAngular" optional="true"> | |
| 1488 <ref>bool</ref> | |
| 1489 <p> | |
| 1490 True if the client wants Angular code to be analyzed. | |
| 1491 </p> | |
| 1492 </field> | |
| 1493 <field name="analyzePolymer" optional="true"> | |
| 1494 <ref>bool</ref> | |
| 1495 <p> | |
| 1496 True if the client wants Polymer code to be analyzed. | |
| 1497 </p> | |
| 1498 </field> | |
| 1499 <field name="enableAsync" optional="true"> | 1484 <field name="enableAsync" optional="true"> |
| 1500 <ref>bool</ref> | 1485 <ref>bool</ref> |
| 1501 <p> | 1486 <p> |
| 1502 True if the client wants to enable support for the | 1487 True if the client wants to enable support for the |
| 1503 proposed async feature. | 1488 proposed async feature. |
| 1504 </p> | 1489 </p> |
| 1505 </field> | 1490 </field> |
| 1506 <field name="enableDeferredLoading" optional="true"> | 1491 <field name="enableDeferredLoading" optional="true"> |
| 1507 <ref>bool</ref> | 1492 <ref>bool</ref> |
| 1508 <p> | 1493 <p> |
| 1509 True if the client wants to enable support for the | 1494 True if the client wants to enable support for the |
| 1510 proposed deferred loading feature. | 1495 proposed deferred loading feature. |
| 1511 </p> | 1496 </p> |
| 1512 </field> | 1497 </field> |
| 1513 <field name="enableEnums" optional="true"> | 1498 <field name="enableEnums" optional="true"> |
| 1514 <ref>bool</ref> | 1499 <ref>bool</ref> |
| 1515 <p> | 1500 <p> |
| 1516 True if the client wants to enable support for the | 1501 True if the client wants to enable support for the |
| 1517 proposed enum feature. | 1502 proposed enum feature. |
| 1518 </p> | 1503 </p> |
| 1519 </field> | 1504 </field> |
| 1520 <field name="generateDart2jsHints" optional="true"> | 1505 <field name="generateDart2jsHints" optional="true"> |
| 1521 <ref>bool</ref> | 1506 <ref>bool</ref> |
| 1522 <p> | 1507 <p> |
| 1523 True if hints that are specific to dart2js should be | 1508 True if hints that are specific to dart2js should be |
| 1524 generated. This option is ignored if either provideErrors | 1509 generated. This option is ignored if generateHints is false. |
| 1525 or generateHints is false. | |
| 1526 </p> | 1510 </p> |
| 1527 </field> | 1511 </field> |
| 1528 <field name="generateHints" optional="true"> | 1512 <field name="generateHints" optional="true"> |
| 1529 <ref>bool</ref> | 1513 <ref>bool</ref> |
| 1530 <p> | 1514 <p> |
| 1531 True is hints should be generated as part of generating | 1515 True is hints should be generated as part of generating |
| 1532 errors and warnings. This option is ignored if | 1516 errors and warnings. |
| 1533 provideErrors is false. | |
| 1534 </p> | 1517 </p> |
| 1535 </field> | 1518 </field> |
| 1536 </object> | 1519 </object> |
| 1537 </type> | 1520 </type> |
| 1538 <type name="AnalysisService"> | 1521 <type name="AnalysisService"> |
| 1539 <p> | 1522 <p> |
| 1540 An enumeration of the services provided by the analysis | 1523 An enumeration of the services provided by the analysis |
| 1541 domain. | 1524 domain. |
| 1542 </p> | 1525 </p> |
| 1543 <enum> | 1526 <enum> |
| (...skipping 18 matching lines...) Expand all Loading... |
| 1562 <ref>String</ref> | 1545 <ref>String</ref> |
| 1563 <p> | 1546 <p> |
| 1564 The name of the current target of analysis. This field is | 1547 The name of the current target of analysis. This field is |
| 1565 omitted if analyzing is false. | 1548 omitted if analyzing is false. |
| 1566 </p> | 1549 </p> |
| 1567 </field> | 1550 </field> |
| 1568 </object> | 1551 </object> |
| 1569 </type> | 1552 </type> |
| 1570 <type name="ChangeContentOverlay"> | 1553 <type name="ChangeContentOverlay"> |
| 1571 <p> | 1554 <p> |
| 1572 A directive to modify an existing file content overlay. A | 1555 A directive to modify an existing file content overlay. One or more |
| 1573 range of text is deleted from the old file content overlay | 1556 ranges of text are deleted from the old file content overlay and |
| 1574 and replaced with new text. | 1557 replaced with new text. |
| 1575 </p> | 1558 </p> |
| 1576 <p> | 1559 <p> |
| 1577 It is an error to use this directive is used on a file that | 1560 The edits are applied in the order in which they occur in the list. |
| 1578 does not yet have a file content overlay (or that has had | 1561 This means that the offset of each edit must be correct under the |
| 1579 its overlay removed via <a | 1562 assumption that all previous edits have been applied. |
| 1580 href="#type_RemoveContentOverlay">RemoveContentOverlay</a>). | 1563 </p> |
| 1564 <p> |
| 1565 It is an error to use this overlay on a file that does not yet have |
| 1566 a file content overlay or that has had its overlay removed via |
| 1567 <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a>. |
| 1581 </p> | 1568 </p> |
| 1582 <object> | 1569 <object> |
| 1583 <field name="type" value="change"><ref>String</ref></field> | 1570 <field name="type" value="change"><ref>String</ref></field> |
| 1584 <field name="offset"> | 1571 <field name="edits"> |
| 1585 <ref>int</ref> | 1572 <list><ref>SourceEdit</ref></list> |
| 1586 <p> | 1573 <p> |
| 1587 The offset of the text to be remove from the file | 1574 The edits to be applied to the file. |
| 1588 content overlay. | |
| 1589 </p> | |
| 1590 </field> | |
| 1591 <field name="length"> | |
| 1592 <ref>int</ref> | |
| 1593 <p> | |
| 1594 The length of the text to be removed from the file | |
| 1595 content overlay, or 0 if no text should be removed. | |
| 1596 </p> | |
| 1597 </field> | |
| 1598 <field name="replacement"> | |
| 1599 <ref>String</ref> | |
| 1600 <p> | |
| 1601 The new text which should be inserted in place of the | |
| 1602 removed text. | |
| 1603 </p> | 1575 </p> |
| 1604 </field> | 1576 </field> |
| 1605 </object> | 1577 </object> |
| 1606 </type> | 1578 </type> |
| 1607 <type name="CompletionId"> | 1579 <type name="CompletionId"> |
| 1608 <ref>String</ref> | 1580 <ref>String</ref> |
| 1609 <p> | 1581 <p> |
| 1610 An identifier used to associate completion results with a | 1582 An identifier used to associate completion results with a |
| 1611 completion request. | 1583 completion request. |
| 1612 </p> | 1584 </p> |
| (...skipping 1452 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 3065 <h2>Errors</h2> | 3037 <h2>Errors</h2> |
| 3066 <p> | 3038 <p> |
| 3067 This section contains a list of all of the errors that are | 3039 This section contains a list of all of the errors that are |
| 3068 produced by the server and the data that is returned with each. | 3040 produced by the server and the data that is returned with each. |
| 3069 </p> | 3041 </p> |
| 3070 <p> | 3042 <p> |
| 3071 TBD | 3043 TBD |
| 3072 </p> | 3044 </p> |
| 3073 </body> | 3045 </body> |
| 3074 </html> | 3046 </html> |
| OLD | NEW |