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 537 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
548 <tt>CONTENT_MODIFIED</tt> will be generated. | 548 <tt>CONTENT_MODIFIED</tt> will be generated. |
549 </p> | 549 </p> |
550 <p> | 550 <p> |
551 If a navigation region overlaps (but extends either before or after) | 551 If a navigation region overlaps (but extends either before or after) |
552 the given region of the file it will be included in the result. This | 552 the given region of the file it will be included in the result. This |
553 means that it is theoretically possible to get the same navigation | 553 means that it is theoretically possible to get the same navigation |
554 region in response to multiple requests. Clients can avoid this by | 554 region in response to multiple requests. Clients can avoid this by |
555 always choosing a region that starts at the beginning of a line and | 555 always choosing a region that starts at the beginning of a line and |
556 ends at the end of a (possibly different) line in the file. | 556 ends at the end of a (possibly different) line in the file. |
557 </p> | 557 </p> |
| 558 <p> |
| 559 If a request is made for a file which does not exist, or |
| 560 which is not currently subject to analysis (e.g. because it |
| 561 is not associated with any analysis root specified to |
| 562 analysis.setAnalysisRoots), an error of type |
| 563 <tt>GET_NAVIGATION_INVALID_FILE</tt> will be generated. |
| 564 </p> |
558 | 565 |
559 | 566 |
560 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> | 567 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> |
561 | 568 |
562 <p> | 569 <p> |
563 The file in which navigation information is being requested. | 570 The file in which navigation information is being requested. |
564 </p> | 571 </p> |
565 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> | 572 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
566 | 573 |
567 <p> | 574 <p> |
(...skipping 2586 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3154 An "edit.format" request specified a file that contains syntax | 3161 An "edit.format" request specified a file that contains syntax |
3155 errors. | 3162 errors. |
3156 </p> | 3163 </p> |
3157 </dd><dt class="value">GET_ERRORS_INVALID_FILE</dt><dd> | 3164 </dd><dt class="value">GET_ERRORS_INVALID_FILE</dt><dd> |
3158 | 3165 |
3159 <p> | 3166 <p> |
3160 An "analysis.getErrors" request specified a FilePath | 3167 An "analysis.getErrors" request specified a FilePath |
3161 which does not match a file currently subject to | 3168 which does not match a file currently subject to |
3162 analysis. | 3169 analysis. |
3163 </p> | 3170 </p> |
| 3171 </dd><dt class="value">GET_NAVIGATION_INVALID_FILE</dt><dd> |
| 3172 |
| 3173 <p> |
| 3174 An "analysis.getErrors" request specified a FilePath |
| 3175 which does not match a file currently subject to |
| 3176 analysis. |
| 3177 </p> |
3164 </dd><dt class="value">INVALID_ANALYSIS_ROOT</dt><dd> | 3178 </dd><dt class="value">INVALID_ANALYSIS_ROOT</dt><dd> |
3165 | 3179 |
3166 <p> | 3180 <p> |
3167 A path passed as an argument to a request (such as | 3181 A path passed as an argument to a request (such as |
3168 analysis.reanalyze) is required to be an analysis root, but isn't. | 3182 analysis.reanalyze) is required to be an analysis root, but isn't. |
3169 </p> | 3183 </p> |
3170 </dd><dt class="value">INVALID_EXECUTION_CONTEXT</dt><dd> | 3184 </dd><dt class="value">INVALID_EXECUTION_CONTEXT</dt><dd> |
3171 | 3185 |
3172 <p> | 3186 <p> |
3173 The context root used to create an execution context does not | 3187 The context root used to create an execution context does not |
(...skipping 641 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3815 <p> | 3829 <p> |
3816 This section contains a list of all of the errors that are | 3830 This section contains a list of all of the errors that are |
3817 produced by the server and the data that is returned with each. | 3831 produced by the server and the data that is returned with each. |
3818 </p> | 3832 </p> |
3819 <p> | 3833 <p> |
3820 TBD | 3834 TBD |
3821 </p> | 3835 </p> |
3822 | 3836 |
3823 | 3837 |
3824 </body></html> | 3838 </body></html> |
OLD | NEW |