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">Version <version>2.0.0</version></h1> | 8 <h1 style="color:#999999">Version <version>2.0.0</version></h1> |
9 <p> | 9 <p> |
10 This document contains a specification of the API provided by the | 10 This document contains a specification of the API provided by the |
(...skipping 423 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
434 <tt>CONTENT_MODIFIED</tt> will be generated. | 434 <tt>CONTENT_MODIFIED</tt> will be generated. |
435 </p> | 435 </p> |
436 <p> | 436 <p> |
437 If a navigation region overlaps (but extends either before or after) | 437 If a navigation region overlaps (but extends either before or after) |
438 the given region of the file it will be included in the result. This | 438 the given region of the file it will be included in the result. This |
439 means that it is theoretically possible to get the same navigation | 439 means that it is theoretically possible to get the same navigation |
440 region in response to multiple requests. Clients can avoid this by | 440 region in response to multiple requests. Clients can avoid this by |
441 always choosing a region that starts at the beginning of a line and | 441 always choosing a region that starts at the beginning of a line and |
442 ends at the end of a (possibly different) line in the file. | 442 ends at the end of a (possibly different) line in the file. |
443 </p> | 443 </p> |
444 <p> | |
445 If a request is made for a file which does not exist, or | |
446 which is not currently subject to analysis (e.g. because it | |
447 is not associated with any analysis root specified to | |
448 analysis.setAnalysisRoots), an error of type | |
449 <tt>GET_NAVIGATION_INVALID_FILE</tt> will be generated. | |
450 </p> | |
444 <params> | 451 <params> |
445 <field name="file"> | 452 <field name="file"> |
446 <ref>FilePath</ref> | 453 <ref>FilePath</ref> |
447 <p> | 454 <p> |
448 The file in which navigation information is being requested. | 455 The file in which navigation information is being requested. |
449 </p> | 456 </p> |
450 </field> | 457 </field> |
451 <field name="offset"> | 458 <field name="offset"> |
452 <ref>int</ref> | 459 <ref>int</ref> |
453 <p> | 460 <p> |
(...skipping 2720 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
3174 </value> | 3181 </value> |
3175 <value> | 3182 <value> |
3176 <code>GET_ERRORS_INVALID_FILE</code> | 3183 <code>GET_ERRORS_INVALID_FILE</code> |
3177 <p> | 3184 <p> |
3178 An "analysis.getErrors" request specified a FilePath | 3185 An "analysis.getErrors" request specified a FilePath |
3179 which does not match a file currently subject to | 3186 which does not match a file currently subject to |
3180 analysis. | 3187 analysis. |
3181 </p> | 3188 </p> |
3182 </value> | 3189 </value> |
3183 <value> | 3190 <value> |
3191 <code>GET_NAVIGATION_INVALID_FILE</code> | |
3192 <p> | |
3193 An "analysis.getErrors" request specified a FilePath | |
devoncarew
2015/07/14 16:34:35
DBC: This looks like a copy/paste issue - this sho
scheglov
2015/07/21 15:05:53
Thanks!
https://codereview.chromium.org/1243073004
| |
3194 which does not match a file currently subject to | |
3195 analysis. | |
3196 </p> | |
3197 </value> | |
3198 <value> | |
3184 <code>INVALID_ANALYSIS_ROOT</code> | 3199 <code>INVALID_ANALYSIS_ROOT</code> |
3185 <p> | 3200 <p> |
3186 A path passed as an argument to a request (such as | 3201 A path passed as an argument to a request (such as |
3187 analysis.reanalyze) is required to be an analysis root, but isn't. | 3202 analysis.reanalyze) is required to be an analysis root, but isn't. |
3188 </p> | 3203 </p> |
3189 </value> | 3204 </value> |
3190 <value> | 3205 <value> |
3191 <code>INVALID_EXECUTION_CONTEXT</code> | 3206 <code>INVALID_EXECUTION_CONTEXT</code> |
3192 <p> | 3207 <p> |
3193 The context root used to create an execution context does not | 3208 The context root used to create an execution context does not |
(...skipping 744 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
3938 <h2>Errors</h2> | 3953 <h2>Errors</h2> |
3939 <p> | 3954 <p> |
3940 This section contains a list of all of the errors that are | 3955 This section contains a list of all of the errors that are |
3941 produced by the server and the data that is returned with each. | 3956 produced by the server and the data that is returned with each. |
3942 </p> | 3957 </p> |
3943 <p> | 3958 <p> |
3944 TBD | 3959 TBD |
3945 </p> | 3960 </p> |
3946 </body> | 3961 </body> |
3947 </html> | 3962 </html> |
OLD | NEW |