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 241 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
252 <p> | 252 <p> |
253 A list of the context roots that are to be re-analyzed. | 253 A list of the context roots that are to be re-analyzed. |
254 </p> | 254 </p> |
255 <p> | 255 <p> |
256 If no context roots are provided, then all current context roots | 256 If no context roots are provided, then all current context roots |
257 should be re-analyzed. | 257 should be re-analyzed. |
258 </p> | 258 </p> |
259 </field> | 259 </field> |
260 </params> | 260 </params> |
261 </request> | 261 </request> |
262 <request method="setContextBuilderOptions"> | |
263 <p> | |
264 Used to set the options used to build analysis contexts. This request will | |
265 be sent exactly once before any context roots have been specified. | |
266 </p> | |
267 <params> | |
268 <field name="options"> | |
269 <ref>ContextBuilderOptions</ref> | |
270 <p> | |
271 The options used to build the analysis contexts. | |
272 </p> | |
273 </field> | |
274 </params> | |
275 </request> | |
276 <request method="setContextRoots"> | 262 <request method="setContextRoots"> |
277 <p> | 263 <p> |
278 Set the list of context roots that should be analyzed. | 264 Set the list of context roots that should be analyzed. |
279 </p> | 265 </p> |
280 <params> | 266 <params> |
281 <field name="roots"> | 267 <field name="roots"> |
282 <list> | 268 <list> |
283 <ref>ContextRoot</ref> | 269 <ref>ContextRoot</ref> |
284 </list> | 270 </list> |
285 <p> | 271 <p> |
(...skipping 614 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
900 related to a specific list of files. | 886 related to a specific list of files. |
901 </p> | 887 </p> |
902 <enum> | 888 <enum> |
903 <value><code>FOLDING</code></value> | 889 <value><code>FOLDING</code></value> |
904 <value><code>HIGHLIGHTS</code></value> | 890 <value><code>HIGHLIGHTS</code></value> |
905 <value><code>NAVIGATION</code></value> | 891 <value><code>NAVIGATION</code></value> |
906 <value><code>OCCURRENCES</code></value> | 892 <value><code>OCCURRENCES</code></value> |
907 <value><code>OUTLINE</code></value> | 893 <value><code>OUTLINE</code></value> |
908 </enum> | 894 </enum> |
909 </type> | 895 </type> |
910 <type name="ContextBuilderOptions"> | |
911 <p> | |
912 The options used to build an analysis context. | |
913 </p> | |
914 <object> | |
915 <field name="dartSdkSummaryPath" optional="true"> | |
916 <ref>FilePath</ref> | |
917 <p> | |
918 The file path of the file containing the summary of the SDK that | |
919 should be used to "analyze" the SDK. The field will be omitted if the | |
920 summary should be found in the SDK. | |
921 </p> | |
922 </field> | |
923 <field name="defaultAnalysisOptionsFilePath" optional="true"> | |
924 <list> | |
925 <ref>FilePath</ref> | |
926 </list> | |
927 <p> | |
928 The file path of the analysis options file that should be used in | |
929 place of any file in the root directory or a parent of the root | |
930 directory. The field will be omitted if the normal lookup mechanism | |
931 should be used. | |
932 </p> | |
933 </field> | |
934 <field name="declaredVariables" optional="true"> | |
935 <map> | |
936 <key> | |
937 <ref>String</ref> | |
938 </key> | |
939 <value> | |
940 <ref>String</ref> | |
941 </value> | |
942 </map> | |
943 <p> | |
944 A table mapping variable names to values for the declared variables. | |
945 The field will be omitted if no additional variables need to be | |
946 declared. | |
947 </p> | |
948 </field> | |
949 <!-- | |
950 TODO(brianwilkerson) Figure out how to handle analysis options. | |
951 <field name="defaultOptions" optional="true"> | |
952 <ref>AnalysisOptions</ref> | |
953 <p> | |
954 The default analysis options that should be used unless some or all of | |
955 them are overridden in the analysis options file. The field will be | |
956 omitted if the default defaults should be used. | |
957 </p> | |
958 </field> | |
959 --> | |
960 <field name="defaultPackageFilePath" optional="true"> | |
961 <list> | |
962 <ref>FilePath</ref> | |
963 </list> | |
964 <p> | |
965 The file path of the .packages file that should be used in place of | |
966 any file found using the normal (Package Specification DEP) lookup | |
967 mechanism. The field will be omitted if the normal lookup mechanism | |
968 should be used. | |
969 </p> | |
970 </field> | |
971 <field name="defaultPackagesDirectoryPath" optional="true"> | |
972 <list> | |
973 <ref>FilePath</ref> | |
974 </list> | |
975 <p> | |
976 The file path of the packages directory that should be used in place | |
977 of any file found using the normal (Package Specification DEP) lookup | |
978 mechanism. The field will be omitted if the normal lookup mechanism | |
979 should be used. | |
980 </p> | |
981 </field> | |
982 </object> | |
983 </type> | |
984 <type name="ContextRoot"> | 896 <type name="ContextRoot"> |
985 <p> | 897 <p> |
986 A description of an analysis context. | 898 A description of an analysis context. |
987 </p> | 899 </p> |
988 <object> | 900 <object> |
989 <field name="root"> | 901 <field name="root"> |
990 <ref>FilePath</ref> | 902 <ref>FilePath</ref> |
991 <p> | 903 <p> |
992 The absolute path of the root directory containing the files to be | 904 The absolute path of the root directory containing the files to be |
993 analyzed. | 905 analyzed. |
(...skipping 656 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1650 The name that the element should have after the refactoring. | 1562 The name that the element should have after the refactoring. |
1651 </p> | 1563 </p> |
1652 </field> | 1564 </field> |
1653 </options> | 1565 </options> |
1654 </refactoring> | 1566 </refactoring> |
1655 </refactorings> | 1567 </refactorings> |
1656 <h2 class="domain"><a name="index">Index</a></h2> | 1568 <h2 class="domain"><a name="index">Index</a></h2> |
1657 <index></index> | 1569 <index></index> |
1658 </body> | 1570 </body> |
1659 </html> | 1571 </html> |
OLD | NEW |