| OLD | NEW |
| 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 577 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 588 "params": { | 588 "params": { |
| 589 "<b>included</b>": List<<a href="#type_FilePath">FilePath</a>> | 589 "<b>included</b>": List<<a href="#type_FilePath">FilePath</a>> |
| 590 "<b>excluded</b>": List<<a href="#type_FilePath">FilePath</a>> | 590 "<b>excluded</b>": List<<a href="#type_FilePath">FilePath</a>> |
| 591 "<b>packageRoots</b>": <span style="color:#999999">optional</span> Map<<a
href="#type_FilePath">FilePath</a>, <a href="#type_FilePath">FilePath</a>> | 591 "<b>packageRoots</b>": <span style="color:#999999">optional</span> Map<<a
href="#type_FilePath">FilePath</a>, <a href="#type_FilePath">FilePath</a>> |
| 592 } | 592 } |
| 593 }</pre><br><pre>response: { | 593 }</pre><br><pre>response: { |
| 594 "id": String | 594 "id": String |
| 595 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 595 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
| 596 }</pre></div> | 596 }</pre></div> |
| 597 <p> | 597 <p> |
| 598 Sets the root paths used to determine which files to | 598 Sets the root paths used to determine which files to analyze. The set |
| 599 analyze. The set of files to be analyzed are all of the | 599 of files to be analyzed are all of the files in one of the root paths |
| 600 files in one of the root paths that are not also in one of | 600 that are not also in one of the excluded paths and do not start with |
| 601 the excluded paths. | 601 a dot ('.'). |
| 602 </p> | 602 </p> |
| 603 <p> | 603 <p> |
| 604 Note that this request determines the set of requested | 604 Note that this request determines the set of requested |
| 605 analysis roots. The actual set of analysis roots at any | 605 analysis roots. The actual set of analysis roots at any |
| 606 given time is the intersection of this set with the set of | 606 given time is the intersection of this set with the set of |
| 607 files and directories actually present on the | 607 files and directories actually present on the |
| 608 filesystem. When the filesystem changes, the actual set of | 608 filesystem. When the filesystem changes, the actual set of |
| 609 analysis roots is automatically updated, but the set of | 609 analysis roots is automatically updated, but the set of |
| 610 requested analysis roots is unchanged. This means that if | 610 requested analysis roots is unchanged. This means that if |
| 611 the client sets an analysis root before the root becomes | 611 the client sets an analysis root before the root becomes |
| (...skipping 898 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1510 | 1510 |
| 1511 | 1511 |
| 1512 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> | 1512 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> |
| 1513 | 1513 |
| 1514 <p> | 1514 <p> |
| 1515 The file containing the code to be formatted. | 1515 The file containing the code to be formatted. |
| 1516 </p> | 1516 </p> |
| 1517 </dd><dt class="field"><b><i>selectionOffset ( int )</i></b></dt><dd> | 1517 </dd><dt class="field"><b><i>selectionOffset ( int )</i></b></dt><dd> |
| 1518 | 1518 |
| 1519 <p> | 1519 <p> |
| 1520 The offset of the current selection in the file. In case | 1520 The offset of the current selection in the file. In case |
| 1521 preserving, selection information is not required, 0 can be | 1521 preserving, selection information is not required, 0 can be |
| 1522 specified for both selection offset and length. | 1522 specified for both selection offset and length. |
| 1523 </p> | 1523 </p> |
| 1524 </dd><dt class="field"><b><i>selectionLength ( int )</i></b></dt><dd> | 1524 </dd><dt class="field"><b><i>selectionLength ( int )</i></b></dt><dd> |
| 1525 | 1525 |
| 1526 <p> | 1526 <p> |
| 1527 The length of the current selection in the file. In case | 1527 The length of the current selection in the file. In case |
| 1528 preserving, selection information is not required, 0 can be | 1528 preserving, selection information is not required, 0 can be |
| 1529 specified for both selection offset and length. | 1529 specified for both selection offset and length. |
| 1530 </p> | 1530 </p> |
| 1531 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>edits ( List<
<a href="#type_SourceEdit">SourceEdit</a>> )</i></b></dt><dd> | 1531 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>edits ( List<
<a href="#type_SourceEdit">SourceEdit</a>> )</i></b></dt><dd> |
| 1532 | 1532 |
| 1533 <p> | 1533 <p> |
| 1534 The edit(s) to be applied in order to format the code. The list | 1534 The edit(s) to be applied in order to format the code. The list |
| 1535 will be empty if the code was already formatted (there are no | 1535 will be empty if the code was already formatted (there are no |
| 1536 changes). | 1536 changes). |
| 1537 </p> | 1537 </p> |
| (...skipping 2163 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 3701 <p> | 3701 <p> |
| 3702 This section contains a list of all of the errors that are | 3702 This section contains a list of all of the errors that are |
| 3703 produced by the server and the data that is returned with each. | 3703 produced by the server and the data that is returned with each. |
| 3704 </p> | 3704 </p> |
| 3705 <p> | 3705 <p> |
| 3706 TBD | 3706 TBD |
| 3707 </p> | 3707 </p> |
| 3708 | 3708 |
| 3709 | 3709 |
| 3710 </body></html> | 3710 </body></html> |
| OLD | NEW |