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 Plugin API Specification</title> | 5 <title>Analysis Server Plugin API Specification</title> |
6 </head> | 6 </head> |
7 <body> | 7 <body> |
8 <h1>Analysis Server Plugin API Specification</h1> | 8 <h1>Analysis Server Plugin API Specification</h1> |
9 <h1 style="color:#999999">Version | 9 <h1 style="color:#999999">Version |
10 <version>1.0.0-alpha.0</version> | 10 <version>1.0.0-alpha.0</version> |
(...skipping 811 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
822 plugin to be able to determine whether or not the code needs to be | 822 plugin to be able to determine whether or not the code needs to be |
823 modified, such as when a member is being renamed and there is a | 823 modified, such as when a member is being renamed and there is a |
824 reference to a member from an unknown type. This field can be omitted | 824 reference to a member from an unknown type. This field can be omitted |
825 if the change field is omitted or if there are no potential edits for | 825 if the change field is omitted or if there are no potential edits for |
826 the refactoring. | 826 the refactoring. |
827 </p> | 827 </p> |
828 </field> | 828 </field> |
829 </result> | 829 </result> |
830 </request> | 830 </request> |
831 </domain> | 831 </domain> |
| 832 <domain name="kythe" experimental="true"> |
| 833 <p> |
| 834 The kythe domain contains APIs related to generating Dart content in the |
| 835 <a href="http://kythe.io/">Kythe</a> format. |
| 836 </p> |
| 837 <request method="getKytheEntries"> |
| 838 <p> |
| 839 Return the list of <tt>KytheEntry</tt> objects for some file, given the |
| 840 current state of the file system populated by "analysis.updateContent". |
| 841 </p> |
| 842 <params> |
| 843 <field name="file"> |
| 844 <ref>FilePath</ref> |
| 845 <p> |
| 846 The file containing the code for which the Kythe Entry objects are |
| 847 being requested. |
| 848 </p> |
| 849 </field> |
| 850 </params> |
| 851 <result> |
| 852 <field name="entries"> |
| 853 <list> |
| 854 <ref>KytheEntry</ref> |
| 855 </list> |
| 856 <p> |
| 857 The list of <tt>KytheEntry</tt> objects for the queried file. |
| 858 </p> |
| 859 </field> |
| 860 <field name="files"> |
| 861 <list> |
| 862 <ref>FilePath</ref> |
| 863 </list> |
| 864 <p> |
| 865 The set of files paths that were required, but not in the file system, |
| 866 to give a complete and accurate Kythe graph for the file. This could |
| 867 be due to a referenced file that does not exist or generated files not |
| 868 being generated or passed before the call to "getKytheEntries". |
| 869 </p> |
| 870 </field> |
| 871 </result> |
| 872 </request> |
| 873 </domain> |
832 <types> | 874 <types> |
833 <h2 class="domain"><a name="types">Types</a></h2> | 875 <h2 class="domain"><a name="types">Types</a></h2> |
834 <p> | 876 <p> |
835 This section contains descriptions of the data types referenced in the API’s | 877 This section contains descriptions of the data types referenced in the API’s |
836 of the various domains. | 878 of the various domains. |
837 </p> | 879 </p> |
838 <include path="common_types_spec.html" | 880 <include path="common_types_spec.html" |
839 import="package:analyzer_plugin/protocol/protocol_common.dart"></incl
ude> | 881 import="package:analyzer_plugin/protocol/protocol_common.dart"></incl
ude> |
840 <type name="AnalysisErrorFixes"> | 882 <type name="AnalysisErrorFixes"> |
841 <p> | 883 <p> |
(...skipping 698 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1540 The name that the element should have after the refactoring. | 1582 The name that the element should have after the refactoring. |
1541 </p> | 1583 </p> |
1542 </field> | 1584 </field> |
1543 </options> | 1585 </options> |
1544 </refactoring> | 1586 </refactoring> |
1545 </refactorings> | 1587 </refactorings> |
1546 <h2 class="domain"><a name="index">Index</a></h2> | 1588 <h2 class="domain"><a name="index">Index</a></h2> |
1547 <index></index> | 1589 <index></index> |
1548 </body> | 1590 </body> |
1549 </html> | 1591 </html> |
OLD | NEW |