OLD | NEW |
1 <!doctype html> | 1 <!doctype html> |
2 <html> | 2 <html> |
3 <head> | 3 <head> |
4 <meta charset="UTF-8"/> | 4 <meta charset="UTF-8"/> |
5 <title>Analysis Server API Specification</title> | 5 <title>Analysis Server API Specification</title> |
6 </head> | 6 </head> |
7 <body> | 7 <body> |
8 <h1>Analysis Server API Specification</h1> | 8 <h1>Analysis Server API Specification</h1> |
9 <h1 style="color:#999999">Version | 9 <h1 style="color:#999999">Version |
10 <version>1.18.3</version> | 10 <version>1.18.3</version> |
(...skipping 2523 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2534 <domain name="kythe" experimental="true"> | 2534 <domain name="kythe" experimental="true"> |
2535 <p> | 2535 <p> |
2536 The kythe domain contains APIs related to generating Dart content in the | 2536 The kythe domain contains APIs related to generating Dart content in the |
2537 <a href="http://kythe.io/">Kythe</a> format. | 2537 <a href="http://kythe.io/">Kythe</a> format. |
2538 </p> | 2538 </p> |
2539 <request method="getKytheEntries"> | 2539 <request method="getKytheEntries"> |
2540 <p> | 2540 <p> |
2541 Return the list of <tt>KytheEntry</tt> objects for some file, given the | 2541 Return the list of <tt>KytheEntry</tt> objects for some file, given the |
2542 current state of the file system populated by "analysis.updateContent". | 2542 current state of the file system populated by "analysis.updateContent". |
2543 </p> | 2543 </p> |
| 2544 <p> |
| 2545 If a request is made for a file that does not exist, or that is not |
| 2546 currently subject to analysis (e.g. because it is not associated with any |
| 2547 analysis root specified to analysis.setAnalysisRoots), an error of type |
| 2548 <tt>GET_KYTHE_ENTRIES_INVALID_FILE</tt> will be generated. |
| 2549 </p> |
2544 <params> | 2550 <params> |
2545 <field name="file"> | 2551 <field name="file"> |
2546 <ref>FilePath</ref> | 2552 <ref>FilePath</ref> |
2547 <p> | 2553 <p> |
2548 The file containing the code for which the Kythe Entry objects are | 2554 The file containing the code for which the Kythe Entry objects are |
2549 being requested. | 2555 being requested. |
2550 </p> | 2556 </p> |
2551 </field> | 2557 </field> |
2552 </params> | 2558 </params> |
2553 <result> | 2559 <result> |
(...skipping 664 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3218 </p> | 3224 </p> |
3219 </value> | 3225 </value> |
3220 <value> | 3226 <value> |
3221 <code>GET_IMPORTED_ELEMENTS_INVALID_FILE</code> | 3227 <code>GET_IMPORTED_ELEMENTS_INVALID_FILE</code> |
3222 <p> | 3228 <p> |
3223 An "analysis.getImportedElements" request specified a FilePath that | 3229 An "analysis.getImportedElements" request specified a FilePath that |
3224 does not match a file currently subject to analysis. | 3230 does not match a file currently subject to analysis. |
3225 </p> | 3231 </p> |
3226 </value> | 3232 </value> |
3227 <value> | 3233 <value> |
| 3234 <code>GET_KYTHE_ENTRIES_INVALID_FILE</code> |
| 3235 <p> |
| 3236 An "analysis.getKytheEntries" request specified a FilePath that does |
| 3237 not match a file that is currently subject to analysis. |
| 3238 </p> |
| 3239 </value> |
| 3240 <value> |
3228 <code>GET_NAVIGATION_INVALID_FILE</code> | 3241 <code>GET_NAVIGATION_INVALID_FILE</code> |
3229 <p> | 3242 <p> |
3230 An "analysis.getNavigation" request specified a FilePath | 3243 An "analysis.getNavigation" request specified a FilePath |
3231 which does not match a file currently subject to | 3244 which does not match a file currently subject to |
3232 analysis. | 3245 analysis. |
3233 </p> | 3246 </p> |
3234 </value> | 3247 </value> |
3235 <value> | 3248 <value> |
3236 <code>GET_REACHABLE_SOURCES_INVALID_FILE</code> | 3249 <code>GET_REACHABLE_SOURCES_INVALID_FILE</code> |
3237 <p> | 3250 <p> |
(...skipping 714 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3952 This section contains a list of all of the errors that are | 3965 This section contains a list of all of the errors that are |
3953 produced by the server and the data that is returned with each. | 3966 produced by the server and the data that is returned with each. |
3954 </p> | 3967 </p> |
3955 <p> | 3968 <p> |
3956 TODO: TBD | 3969 TODO: TBD |
3957 </p> | 3970 </p> |
3958 <h2 class="domain"><a name="index">Index</a></h2> | 3971 <h2 class="domain"><a name="index">Index</a></h2> |
3959 <index></index> | 3972 <index></index> |
3960 </body> | 3973 </body> |
3961 </html> | 3974 </html> |
OLD | NEW |