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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 547753002: Rename debug domain to execution (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/DebugService.java ('k') | pkg/analysis_server/lib/src/generated_protocol.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 134 matching lines...) Expand 10 before | Expand all | Expand 10 after
145 <p> 145 <p>
146 For convenience, the API is divided into domains. Each domain is 146 For convenience, the API is divided into domains. Each domain is
147 specified in a separate section below: 147 specified in a separate section below:
148 </p> 148 </p>
149 <ul> 149 <ul>
150 <li><a href="#domain_server">Server</a></li> 150 <li><a href="#domain_server">Server</a></li>
151 <li><a href="#domain_analysis">Analysis</a></li> 151 <li><a href="#domain_analysis">Analysis</a></li>
152 <li><a href="#domain_completion">Code Completion</a></li> 152 <li><a href="#domain_completion">Code Completion</a></li>
153 <li><a href="#domain_search">Search</a></li> 153 <li><a href="#domain_search">Search</a></li>
154 <li><a href="#domain_edit">Edit</a></li> 154 <li><a href="#domain_edit">Edit</a></li>
155 <li><a href="#domain_debug">Debugging</a></li> 155 <li><a href="#domain_execution">Execution</a></li>
156 </ul> 156 </ul>
157 <p> 157 <p>
158 The specifications of the API’s refer to data structures beyond 158 The specifications of the API’s refer to data structures beyond
159 the standard JSON primitives. These data structures are 159 the standard JSON primitives. These data structures are
160 documented in the section titled <a href="#types">Types</a>. 160 documented in the section titled <a href="#types">Types</a>.
161 </p> 161 </p>
162 <h3>Command-line Arguments</h3> 162 <h3>Command-line Arguments</h3>
163 <p> 163 <p>
164 The command-line arguments that can be passed to the server. 164 The command-line arguments that can be passed to the server.
165 </p> 165 </p>
(...skipping 200 matching lines...) Expand 10 before | Expand all | Expand 10 after
366 asynchronously apply updated error information. Clients that 366 asynchronously apply updated error information. Clients that
367 <b>can</b> apply error information as it becomes available 367 <b>can</b> apply error information as it becomes available
368 should use the information provided by the 'analysis.errors' 368 should use the information provided by the 'analysis.errors'
369 notification. 369 notification.
370 </p> 370 </p>
371 <p> 371 <p>
372 If a request is made for a file which does not exist, or 372 If a request is made for a file which does not exist, or
373 which is not currently subject to analysis (e.g. because it 373 which is not currently subject to analysis (e.g. because it
374 is not associated with any analysis root specified to 374 is not associated with any analysis root specified to
375 analysis.setAnalysisRoots), an error of type 375 analysis.setAnalysisRoots), an error of type
376 GET_ERRORS_INVALID_FILE will be generated. 376 <tt>GET_ERRORS_INVALID_FILE</tt> will be generated.
377 </p> 377 </p>
378 378
379 379
380 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd> 380 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>
381 381
382 <p> 382 <p>
383 The file for which errors are being requested. 383 The file for which errors are being requested.
384 </p> 384 </p>
385 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>errors ( List&lt ;<a href="#type_AnalysisError">AnalysisError</a>&gt; )</i></b></dt><dd> 385 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>errors ( List&lt ;<a href="#type_AnalysisError">AnalysisError</a>&gt; )</i></b></dt><dd>
386 386
(...skipping 986 matching lines...) Expand 10 before | Expand all | Expand 10 after
1373 </p> 1373 </p>
1374 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> 1374 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>
1375 1375
1376 <p> 1376 <p>
1377 The offset used to select the errors for which fixes 1377 The offset used to select the errors for which fixes
1378 will be returned. 1378 will be returned.
1379 </p> 1379 </p>
1380 </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> 1380 </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>
1381 1381
1382 <p> 1382 <p>
1383 The fixes that are available for each of the analysis 1383 The fixes that are available for the errors at the given offset.
1384 errors. There is a one-to-one correspondence between the
1385 analysis errors in the request and the lists of changes
1386 in the response. In particular, it is always the case
1387 that errors.length == fixes.length and that fixes[i] is
1388 the list of fixes for the error in errors[i]. The list
1389 of changes corresponding to an error can be empty if
1390 there are no fixes available for that error.
1391 </p> 1384 </p>
1392 </dd></dl></dd><dt class="request">edit.getRefactoring</dt><dd><div cl ass="box"><pre>request: { 1385 </dd></dl></dd><dt class="request">edit.getRefactoring</dt><dd><div cl ass="box"><pre>request: {
1393 "id": String 1386 "id": String
1394 "method": "edit.getRefactoring" 1387 "method": "edit.getRefactoring"
1395 "params": { 1388 "params": {
1396 "<b>kind</b>": <a href="#type_RefactoringKind">RefactoringKind</a> 1389 "<b>kind</b>": <a href="#type_RefactoringKind">RefactoringKind</a>
1397 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 1390 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
1398 "<b>offset</b>": int 1391 "<b>offset</b>": int
1399 "<b>length</b>": int 1392 "<b>length</b>": int
1400 "<b>validateOnly</b>": bool 1393 "<b>validateOnly</b>": bool
(...skipping 82 matching lines...) Expand 10 before | Expand all | Expand 10 after
1483 <p> 1476 <p>
1484 The ids of source edits that are not known to be valid. An edit is 1477 The ids of source edits that are not known to be valid. An edit is
1485 not known to be valid if there was insufficient type information 1478 not known to be valid if there was insufficient type information
1486 for the server to be able to determine whether or not the code 1479 for the server to be able to determine whether or not the code
1487 needs to be modified, such as when a member is being renamed and 1480 needs to be modified, such as when a member is being renamed and
1488 there is a reference to a member from an unknown type. This field 1481 there is a reference to a member from an unknown type. This field
1489 will be omitted if the change field is omitted or if there are no 1482 will be omitted if the change field is omitted or if there are no
1490 potential edits for the refactoring. 1483 potential edits for the refactoring.
1491 </p> 1484 </p>
1492 </dd></dl></dd></dl> 1485 </dd></dl></dd></dl>
1493 <h2 class="domain"><a name="domain_debug">Domain: debug</a></h2> 1486 <h2 class="domain"><a name="domain_execution">Domain: execution</a></h2>
1494 <p> 1487 <p>
1495 The debugging domain contains commands related to providing a 1488 The execution domain contains commands related to providing an execution
1496 debugging experience. 1489 or debugging experience.
1497 </p> 1490 </p>
1498 1491
1499 1492
1500 1493
1501 1494
1502 1495
1503 <h3>Requests</h3><dl><dt class="request">debug.createContext</dt><dd><div cl ass="box"><pre>request: { 1496 <h3>Requests</h3><dl><dt class="request">execution.createContext</dt><dd><di v class="box"><pre>request: {
1504 "id": String 1497 "id": String
1505 "method": "debug.createContext" 1498 "method": "execution.createContext"
1506 "params": { 1499 "params": {
1507 "<b>contextRoot</b>": <a href="#type_FilePath">FilePath</a> 1500 "<b>contextRoot</b>": <a href="#type_FilePath">FilePath</a>
1508 } 1501 }
1509 }</pre><br><pre>response: { 1502 }</pre><br><pre>response: {
1510 "<b>id</b>": String 1503 "<b>id</b>": String
1511 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 1504 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
1512 "result": { 1505 "result": {
1513 "<b>id</b>": <a href="#type_DebugContextId">DebugContextId</a> 1506 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a>
1514 } 1507 }
1515 }</pre></div> 1508 }</pre></div>
1516 <p> 1509 <p>
1517 Create a debugging context for the executable file with the 1510 Create an execution context for the executable file with the given
1518 given path. The context that is created will persist until 1511 path. The context that is created will persist until
1519 debug.deleteContext is used to delete it. Clients, 1512 execution.deleteContext is used to delete it. Clients, therefore, are
1520 therefore, are responsible for managing the lifetime of 1513 responsible for managing the lifetime of execution contexts.
1521 debugging contexts.
1522 </p> 1514 </p>
1523 1515
1524 1516
1525 <h4>Parameters</h4><dl><dt class="field"><b><i>contextRoot ( <a href="#typ e_FilePath">FilePath</a> )</i></b></dt><dd> 1517 <h4>Parameters</h4><dl><dt class="field"><b><i>contextRoot ( <a href="#typ e_FilePath">FilePath</a> )</i></b></dt><dd>
1526 1518
1527 <p> 1519 <p>
1528 The path of the Dart or HTML file that will be launched. 1520 The path of the Dart or HTML file that will be launched.
1529 </p> 1521 </p>
1530 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <a href="#t ype_DebugContextId">DebugContextId</a> )</i></b></dt><dd> 1522 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <a href="#t ype_ExecutionContextId">ExecutionContextId</a> )</i></b></dt><dd>
1531 1523
1532 <p> 1524 <p>
1533 The identifier used to refer to the debugging context 1525 The identifier used to refer to the execution context that was
1534 that was created. 1526 created.
1535 </p> 1527 </p>
1536 </dd></dl></dd><dt class="request">debug.deleteContext</dt><dd><div cl ass="box"><pre>request: { 1528 </dd></dl></dd><dt class="request">execution.deleteContext</dt><dd><di v class="box"><pre>request: {
1537 "<b>id</b>": String 1529 "<b>id</b>": String
1538 "method": "debug.deleteContext" 1530 "method": "execution.deleteContext"
1539 "params": { 1531 "params": {
1540 "<b>id</b>": <a href="#type_DebugContextId">DebugContextId</a> 1532 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a>
1541 } 1533 }
1542 }</pre><br><pre>response: { 1534 }</pre><br><pre>response: {
1543 "id": String 1535 "id": String
1544 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 1536 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
1545 }</pre></div> 1537 }</pre></div>
1546 <p> 1538 <p>
1547 Delete the debugging context with the given identifier. The 1539 Delete the execution context with the given identifier. The context id
1548 context id is no longer valid after this command. The server 1540 is no longer valid after this command. The server is allowed to re-use
1549 is allowed to re-use ids when they are no longer valid. 1541 ids when they are no longer valid.
1550 </p> 1542 </p>
1551 1543
1552 <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_DebugCo ntextId">DebugContextId</a> )</i></b></dt><dd> 1544 <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_Executi onContextId">ExecutionContextId</a> )</i></b></dt><dd>
1553 1545
1554 <p> 1546 <p>
1555 The identifier of the debugging context that is to be 1547 The identifier of the execution context that is to be deleted.
1556 deleted.
1557 </p> 1548 </p>
1558 </dd></dl></dd><dt class="request">debug.mapUri</dt><dd><div class="bo x"><pre>request: { 1549 </dd></dl></dd><dt class="request">execution.mapUri</dt><dd><div class ="box"><pre>request: {
1559 "<b>id</b>": String 1550 "<b>id</b>": String
1560 "method": "debug.mapUri" 1551 "method": "execution.mapUri"
1561 "params": { 1552 "params": {
1562 "<b>id</b>": <a href="#type_DebugContextId">DebugContextId</a> 1553 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a>
1563 "<b>file</b>": <span style="color:#999999">optional</span> <a href="#type_Fi lePath">FilePath</a> 1554 "<b>file</b>": <span style="color:#999999">optional</span> <a href="#type_Fi lePath">FilePath</a>
1564 "<b>uri</b>": <span style="color:#999999">optional</span> String 1555 "<b>uri</b>": <span style="color:#999999">optional</span> String
1565 } 1556 }
1566 }</pre><br><pre>response: { 1557 }</pre><br><pre>response: {
1567 "id": String 1558 "id": String
1568 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 1559 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
1569 "result": { 1560 "result": {
1570 "<b>file</b>": <span style="color:#999999">optional</span> <a href="#type_Fi lePath">FilePath</a> 1561 "<b>file</b>": <span style="color:#999999">optional</span> <a href="#type_Fi lePath">FilePath</a>
1571 "<b>uri</b>": <span style="color:#999999">optional</span> String 1562 "<b>uri</b>": <span style="color:#999999">optional</span> String
1572 } 1563 }
1573 }</pre></div> 1564 }</pre></div>
1574 <p> 1565 <p>
1575 Map a URI from the debugging context to the file that it 1566 Map a URI from the execution context to the file that it corresponds
1576 corresponds to, or map a file to the URI that it corresponds 1567 to, or map a file to the URI that it corresponds to in the execution
1577 to in the debugging context. 1568 context.
1578 </p> 1569 </p>
1579 <p> 1570 <p>
1580 Exactly one of the file and uri fields must be provided. 1571 Exactly one of the file and uri fields must be provided.
1581 </p> 1572 </p>
1582 1573
1583 1574
1584 <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_DebugCo ntextId">DebugContextId</a> )</i></b></dt><dd> 1575 <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_Executi onContextId">ExecutionContextId</a> )</i></b></dt><dd>
1585 1576
1586 <p> 1577 <p>
1587 The identifier of the debugging context in which the URI 1578 The identifier of the execution context in which the URI is to be
1588 is to be mapped. 1579 mapped.
1589 </p> 1580 </p>
1590 </dd><dt class="field"><b><i>file ( <span style="color:#999999">option al</span> <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd> 1581 </dd><dt class="field"><b><i>file ( <span style="color:#999999">option al</span> <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd>
1591 1582
1592 <p> 1583 <p>
1593 The path of the file to be mapped into a URI. 1584 The path of the file to be mapped into a URI.
1594 </p> 1585 </p>
1595 </dd><dt class="field"><b><i>uri ( <span style="color:#999999">optiona l</span> String )</i></b></dt><dd> 1586 </dd><dt class="field"><b><i>uri ( <span style="color:#999999">optiona l</span> String )</i></b></dt><dd>
1596 1587
1597 <p> 1588 <p>
1598 The URI to be mapped into a file path. 1589 The URI to be mapped into a file path.
1599 </p> 1590 </p>
1600 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>file ( <span sty le="color:#999999">optional</span> <a href="#type_FilePath">FilePath</a> )</i></ b></dt><dd> 1591 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>file ( <span sty le="color:#999999">optional</span> <a href="#type_FilePath">FilePath</a> )</i></ b></dt><dd>
1601 1592
1602 <p> 1593 <p>
1603 The file to which the URI was mapped. This field is 1594 The file to which the URI was mapped. This field is omitted if the
1604 omitted if the uri field was not given in the request. 1595 uri field was not given in the request.
1605 </p> 1596 </p>
1606 </dd><dt class="field"><b><i>uri ( <span style="color:#999999">optiona l</span> String )</i></b></dt><dd> 1597 </dd><dt class="field"><b><i>uri ( <span style="color:#999999">optiona l</span> String )</i></b></dt><dd>
1607 1598
1608 <p> 1599 <p>
1609 The URI to which the file path was mapped. This field is 1600 The URI to which the file path was mapped. This field is omitted
1610 omitted if the file field was not given in the request. 1601 if the file field was not given in the request.
1611 </p> 1602 </p>
1612 </dd></dl></dd><dt class="request">debug.setSubscriptions</dt><dd><div class="box"><pre>request: { 1603 </dd></dl></dd><dt class="request">execution.setSubscriptions</dt><dd> <div class="box"><pre>request: {
1613 "id": String 1604 "id": String
1614 "method": "debug.setSubscriptions" 1605 "method": "execution.setSubscriptions"
1615 "params": { 1606 "params": {
1616 "<b>subscriptions</b>": List&lt;<a href="#type_DebugService">DebugService</a >&gt; 1607 "<b>subscriptions</b>": List&lt;<a href="#type_ExecutionService">ExecutionSe rvice</a>&gt;
1617 } 1608 }
1618 }</pre><br><pre>response: { 1609 }</pre><br><pre>response: {
1619 "id": String 1610 "id": String
1620 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 1611 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
1621 }</pre></div> 1612 }</pre></div>
1622 <p> 1613 <p>
1623 Subscribe for services. All previous subscriptions are 1614 Subscribe for services. All previous subscriptions are replaced by the
1624 replaced by the given set of services. 1615 given set of services.
1625 </p> 1616 </p>
1626 <p> 1617 <p>
1627 It is an error if any of the elements in the list are not 1618 It is an error if any of the elements in the list are not valid
1628 valid services. If there is an error, then the current 1619 services. If there is an error, then the current subscriptions will
1629 subscriptions will remain unchanged. 1620 remain unchanged.
1630 </p> 1621 </p>
1631 1622
1632 <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( List&lt;<a href="#type_DebugService">DebugService</a>&gt; )</i></b></dt><dd> 1623 <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( List&lt;<a href="#type_ExecutionService">ExecutionService</a>&gt; )</i></b></dt><dd>
1633 1624
1634 <p> 1625 <p>
1635 A list of the services being subscribed to. 1626 A list of the services being subscribed to.
1636 </p> 1627 </p>
1637 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" >debug.launchData</dt><dd><div class="box"><pre>notification: { 1628 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" >execution.launchData</dt><dd><div class="box"><pre>notification: {
1638 "event": "debug.launchData" 1629 "event": "execution.launchData"
1639 "params": { 1630 "params": {
1640 "<b>executables</b>": List&lt;<a href="#type_ExecutableFile">ExecutableFile< /a>&gt; 1631 "<b>executables</b>": List&lt;<a href="#type_ExecutableFile">ExecutableFile< /a>&gt;
1641 "<b>dartToHtml</b>": Map&lt;<a href="#type_FilePath">FilePath</a>, List&lt;< a href="#type_FilePath">FilePath</a>&gt;&gt; 1632 "<b>dartToHtml</b>": Map&lt;<a href="#type_FilePath">FilePath</a>, List&lt;< a href="#type_FilePath">FilePath</a>&gt;&gt;
1642 "<b>htmlToDart</b>": Map&lt;<a href="#type_FilePath">FilePath</a>, List&lt;< a href="#type_FilePath">FilePath</a>&gt;&gt; 1633 "<b>htmlToDart</b>": Map&lt;<a href="#type_FilePath">FilePath</a>, List&lt;< a href="#type_FilePath">FilePath</a>&gt;&gt;
1643 } 1634 }
1644 }</pre></div> 1635 }</pre></div>
1645 <p> 1636 <p>
1646 Reports information needed to allow applications within the 1637 Reports information needed to allow applications within the given
1647 given context to be launched. 1638 context to be launched.
1648 </p> 1639 </p>
1649 <p> 1640 <p>
1650 This notification is not subscribed to by default. Clients 1641 This notification is not subscribed to by default. Clients can
1651 can subscribe by including the value "LAUNCH_DATA" in the 1642 subscribe by including the value "LAUNCH_DATA" in the list of services
1652 list of services passed in a debug.setSubscriptions request. 1643 passed in a execution.setSubscriptions request.
1653 </p> 1644 </p>
1654 1645
1655 <h4>Parameters</h4><dl><dt class="field"><b><i>executables ( List&lt;<a hr ef="#type_ExecutableFile">ExecutableFile</a>&gt; )</i></b></dt><dd> 1646 <h4>Parameters</h4><dl><dt class="field"><b><i>executables ( List&lt;<a hr ef="#type_ExecutableFile">ExecutableFile</a>&gt; )</i></b></dt><dd>
1656 1647
1657 <p> 1648 <p>
1658 A list of the files that are executable in the given 1649 A list of the files that are executable in the given context. This
1659 context. This list replaces any previous list provided 1650 list replaces any previous list provided for the given context.
1660 for the given context.
1661 </p> 1651 </p>
1662 </dd><dt class="field"><b><i>dartToHtml ( Map&lt;<a href="#type_FilePa th">FilePath</a>, List&lt;<a href="#type_FilePath">FilePath</a>&gt;&gt; )</i></b ></dt><dd> 1652 </dd><dt class="field"><b><i>dartToHtml ( Map&lt;<a href="#type_FilePa th">FilePath</a>, List&lt;<a href="#type_FilePath">FilePath</a>&gt;&gt; )</i></b ></dt><dd>
1663 1653
1664 <p> 1654 <p>
1665 A mapping from the paths of Dart files that are 1655 A mapping from the paths of Dart files that are referenced by HTML
1666 referenced by HTML files to a list of the HTML files 1656 files to a list of the HTML files that reference the Dart files.
1667 that reference the Dart files.
1668 </p> 1657 </p>
1669 </dd><dt class="field"><b><i>htmlToDart ( Map&lt;<a href="#type_FilePa th">FilePath</a>, List&lt;<a href="#type_FilePath">FilePath</a>&gt;&gt; )</i></b ></dt><dd> 1658 </dd><dt class="field"><b><i>htmlToDart ( Map&lt;<a href="#type_FilePa th">FilePath</a>, List&lt;<a href="#type_FilePath">FilePath</a>&gt;&gt; )</i></b ></dt><dd>
1670 1659
1671 <p> 1660 <p>
1672 A mapping from the paths of HTML files that reference 1661 A mapping from the paths of HTML files that reference Dart files
1673 Dart files to a list of the Dart files they reference. 1662 to a list of the Dart files they reference.
1674 </p> 1663 </p>
1675 </dd></dl></dd></dl> 1664 </dd></dl></dd></dl>
1676 1665
1677 <h2><a name="types">Types</a></h2> 1666 <h2><a name="types">Types</a></h2>
1678 <p> 1667 <p>
1679 This section contains descriptions of the data types referenced 1668 This section contains descriptions of the data types referenced
1680 in the API’s of the various domains. 1669 in the API’s of the various domains.
1681 </p> 1670 </p>
1682 1671
1683 1672
(...skipping 335 matching lines...) Expand 10 before | Expand all | Expand 10 after
2019 <p> 2008 <p>
2020 The type of the options parameter being suggested. This 2009 The type of the options parameter being suggested. This
2021 field is omitted if the parameterName field is omitted. 2010 field is omitted if the parameterName field is omitted.
2022 </p> 2011 </p>
2023 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionSugg estionKind">CompletionSuggestionKind: String</a></dt><dd> 2012 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionSugg estionKind">CompletionSuggestionKind: String</a></dt><dd>
2024 <p> 2013 <p>
2025 An enumeration of the kinds of elements that can be included 2014 An enumeration of the kinds of elements that can be included
2026 in a completion suggestion. 2015 in a completion suggestion.
2027 </p> 2016 </p>
2028 2017
2029 <dl><dt class="value">ARGUMENT_LIST</dt><dt class="value">CLASS</dt><dt cl ass="value">CLASS_ALIAS</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">IMPORT</dt><dt class="value">K EYWORD</dt><dt class="value">LIBRARY_PREFIX</dt><dt class="value">LOCAL_VARIABLE </dt><dt class="value">METHOD</dt><dt class="value">METHOD_NAME</dt><dt class="v alue">NAMED_ARGUMENT</dt><dt class="value">OPTIONAL_ARGUMENT</dt><dt class="valu e">PARAMETER</dt><dt class="value">SETTER</dt><dt class="value">TOP_LEVEL_VARIAB LE</dt><dt class="value">TYPE_PARAMETER</dt></dl></dd><dt class="typeDefinition" ><a name="type_DebugContextId">DebugContextId: String</a></dt><dd> 2018 <dl><dt class="value">ARGUMENT_LIST</dt><dt class="value">CLASS</dt><dt cl ass="value">CLASS_ALIAS</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">IMPORT</dt><dt class="value">K EYWORD</dt><dt class="value">LIBRARY_PREFIX</dt><dt class="value">LOCAL_VARIABLE </dt><dt class="value">METHOD</dt><dt class="value">METHOD_NAME</dt><dt class="v alue">NAMED_ARGUMENT</dt><dt class="value">OPTIONAL_ARGUMENT</dt><dt class="valu e">PARAMETER</dt><dt class="value">SETTER</dt><dt class="value">TOP_LEVEL_VARIAB LE</dt><dt class="value">TYPE_PARAMETER</dt></dl></dd><dt class="typeDefinition" ><a name="type_Element">Element: object</a></dt><dd>
2030
2031 <p>
2032 The identifier for a debug context.
2033 </p>
2034 </dd><dt class="typeDefinition"><a name="type_DebugService">DebugService: String</a></dt><dd>
2035 <p>
2036 An enumeration of the services provided by the debug
2037 domain.
2038 </p>
2039
2040 <dl><dt class="value">LAUNCH_DATA</dt></dl></dd><dt class="typeDefinition" ><a name="type_Element">Element: object</a></dt><dd>
2041 <p> 2019 <p>
2042 Information about an element (something that can be declared 2020 Information about an element (something that can be declared
2043 in code). 2021 in code).
2044 </p> 2022 </p>
2045 2023
2046 <dl><dt class="field"><b><i>kind ( <a href="#type_ElementKind">ElementKind </a> )</i></b></dt><dd> 2024 <dl><dt class="field"><b><i>kind ( <a href="#type_ElementKind">ElementKind </a> )</i></b></dt><dd>
2047 2025
2048 <p> 2026 <p>
2049 The kind of the element. 2027 The kind of the element.
2050 </p> 2028 </p>
(...skipping 56 matching lines...) Expand 10 before | Expand all | Expand 10 after
2107 </dd><dt class="field"><b><i>kind ( <a href="#type_ExecutableKind">Exe cutableKind</a> )</i></b></dt><dd> 2085 </dd><dt class="field"><b><i>kind ( <a href="#type_ExecutableKind">Exe cutableKind</a> )</i></b></dt><dd>
2108 2086
2109 <p> 2087 <p>
2110 The kind of the executable file. 2088 The kind of the executable file.
2111 </p> 2089 </p>
2112 </dd></dl></dd><dt class="typeDefinition"><a name="type_ExecutableKind ">ExecutableKind: String</a></dt><dd> 2090 </dd></dl></dd><dt class="typeDefinition"><a name="type_ExecutableKind ">ExecutableKind: String</a></dt><dd>
2113 <p> 2091 <p>
2114 An enumeration of the kinds of executable files. 2092 An enumeration of the kinds of executable files.
2115 </p> 2093 </p>
2116 2094
2117 <dl><dt class="value">CLIENT</dt><dt class="value">EITHER</dt><dt class="v alue">SERVER</dt></dl></dd><dt class="typeDefinition"><a name="type_FilePath">Fi lePath: String</a></dt><dd> 2095 <dl><dt class="value">CLIENT</dt><dt class="value">EITHER</dt><dt class="v alue">SERVER</dt></dl></dd><dt class="typeDefinition"><a name="type_ExecutionCon textId">ExecutionContextId: String</a></dt><dd>
2096
2097 <p>
2098 The identifier for a execution context.
2099 </p>
2100 </dd><dt class="typeDefinition"><a name="type_ExecutionService">ExecutionS ervice: String</a></dt><dd>
2101 <p>
2102 An enumeration of the services provided by the execution
2103 domain.
2104 </p>
2105
2106 <dl><dt class="value">LAUNCH_DATA</dt></dl></dd><dt class="typeDefinition" ><a name="type_FilePath">FilePath: String</a></dt><dd>
2118 2107
2119 <p> 2108 <p>
2120 The absolute path of a file. 2109 The absolute path of a file.
2121 </p> 2110 </p>
2122 </dd><dt class="typeDefinition"><a name="type_FoldingKind">FoldingKind: St ring</a></dt><dd> 2111 </dd><dt class="typeDefinition"><a name="type_FoldingKind">FoldingKind: St ring</a></dt><dd>
2123 <p> 2112 <p>
2124 An enumeration of the kinds of folding regions. 2113 An enumeration of the kinds of folding regions.
2125 </p> 2114 </p>
2126 2115
2127 <dl><dt class="value">COMMENT</dt><dt class="value">CLASS_MEMBER</dt><dt c lass="value">DIRECTIVES</dt><dt class="value">DOCUMENTATION_COMMENT</dt><dt clas s="value">TOP_LEVEL_DECLARATION</dt></dl></dd><dt class="typeDefinition"><a name ="type_FoldingRegion">FoldingRegion: object</a></dt><dd> 2116 <dl><dt class="value">COMMENT</dt><dt class="value">CLASS_MEMBER</dt><dt c lass="value">DIRECTIVES</dt><dt class="value">DOCUMENTATION_COMMENT</dt><dt clas s="value">TOP_LEVEL_DECLARATION</dt></dl></dd><dt class="typeDefinition"><a name ="type_FoldingRegion">FoldingRegion: object</a></dt><dd>
(...skipping 903 matching lines...) Expand 10 before | Expand all | Expand 10 after
3031 </p> 3020 </p>
3032 </dd><dt class="field"><b><i>name ( String )</i></b></dt><dd> 3021 </dd><dt class="field"><b><i>name ( String )</i></b></dt><dd>
3033 3022
3034 <p> 3023 <p>
3035 The name that the method should be given. 3024 The name that the method should be given.
3036 </p> 3025 </p>
3037 </dd><dt class="field"><b><i>parameters ( List&lt;<a href="#type_Refac toringMethodParameter">RefactoringMethodParameter</a>&gt; )</i></b></dt><dd> 3026 </dd><dt class="field"><b><i>parameters ( List&lt;<a href="#type_Refac toringMethodParameter">RefactoringMethodParameter</a>&gt; )</i></b></dt><dd>
3038 3027
3039 <p> 3028 <p>
3040 The parameters that should be defined for the method. 3029 The parameters that should be defined for the method.
3041 </p><p> 3030 </p>
3042 It is an error if a REQUIRED or NAMED parameter follows a 3031 <p>
3043 POSITIONAL parameter. 3032 It is an error if a REQUIRED or NAMED parameter follows a
3044 It is an error if a REQUIRED or POSITIONAL parameter follows a 3033 POSITIONAL parameter.
3045 NAMED parameter. 3034 It is an error if a REQUIRED or POSITIONAL parameter follows a
3046 </p> 3035 NAMED parameter.
3047 <ul> 3036 </p>
3048 <li> 3037 <ul>
3049 To change the order and/or update proposed paramerers, add 3038 <li>
3050 parameters with the same identifiers as proposed. 3039 To change the order and/or update proposed paramerers, add
3051 </li> 3040 parameters with the same identifiers as proposed.
3052 <li>To add new parameters, omit their identifier.</li> 3041 </li>
3053 <li>To remove some parameters, omit them in this list.</li> 3042 <li>To add new parameters, omit their identifier.</li>
3054 </ul> 3043 <li>To remove some parameters, omit them in this list.</li>
3055 <p></p> 3044 </ul>
3056 </dd><dt class="field"><b><i>extractAll ( bool )</i></b></dt><dd> 3045 </dd><dt class="field"><b><i>extractAll ( bool )</i></b></dt><dd>
3057 3046
3058 <p> 3047 <p>
3059 True if all occurrences of the expression or statements 3048 True if all occurrences of the expression or statements
3060 should be replaced by an invocation of the method. The 3049 should be replaced by an invocation of the method. The
3061 expression or statements used to initiate the 3050 expression or statements used to initiate the
3062 refactoring will always be replaced. 3051 refactoring will always be replaced.
3063 </p> 3052 </p>
3064 </dd></dl></dd><dt class="refactoring">INLINE_LOCAL_VARIABLE</dt><dd> 3053 </dd></dl></dd><dt class="refactoring">INLINE_LOCAL_VARIABLE</dt><dd>
3065 <p> 3054 <p>
(...skipping 75 matching lines...) Expand 10 before | Expand all | Expand 10 after
3141 <p> 3130 <p>
3142 This section contains a list of all of the errors that are 3131 This section contains a list of all of the errors that are
3143 produced by the server and the data that is returned with each. 3132 produced by the server and the data that is returned with each.
3144 </p> 3133 </p>
3145 <p> 3134 <p>
3146 TBD 3135 TBD
3147 </p> 3136 </p>
3148 3137
3149 3138
3150 </body></html> 3139 </body></html>
OLDNEW
« no previous file with comments | « editor/tools/plugins/com.google.dart.server/src/com/google/dart/server/generated/types/DebugService.java ('k') | pkg/analysis_server/lib/src/generated_protocol.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698