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 775 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
786 </field> | 786 </field> |
787 </result> | 787 </result> |
788 </request> | 788 </request> |
789 </domain> | 789 </domain> |
790 <types> | 790 <types> |
791 <h2 class="domain"><a name="types">Types</a></h2> | 791 <h2 class="domain"><a name="types">Types</a></h2> |
792 <p> | 792 <p> |
793 This section contains descriptions of the data types referenced in the API’s | 793 This section contains descriptions of the data types referenced in the API’s |
794 of the various domains. | 794 of the various domains. |
795 </p> | 795 </p> |
796 <include path="common_types_spec.html"></include> | 796 <include path="common_types_spec.html" |
| 797 import="package:analyzer_plugin/protocol/protocol_common.dart"></incl
ude> |
797 <type name="AnalysisErrorFixes"> | 798 <type name="AnalysisErrorFixes"> |
798 <p> | 799 <p> |
799 A list of fixes associated with a specific error | 800 A list of fixes associated with a specific error |
800 </p> | 801 </p> |
801 <object> | 802 <object> |
802 <field name="error"> | 803 <field name="error"> |
803 <ref>AnalysisError</ref> | 804 <ref>AnalysisError</ref> |
804 <p> | 805 <p> |
805 The error with which the fixes are associated. | 806 The error with which the fixes are associated. |
806 </p> | 807 </p> |
(...skipping 402 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1209 <p> | 1210 <p> |
1210 Create a local variable initialized by the expression that covers the | 1211 Create a local variable initialized by the expression that covers the |
1211 specified selection. | 1212 specified selection. |
1212 </p> | 1213 </p> |
1213 <p> | 1214 <p> |
1214 It is an error if the selection range is not covered by a complete | 1215 It is an error if the selection range is not covered by a complete |
1215 expression. | 1216 expression. |
1216 </p> | 1217 </p> |
1217 <feedback> | 1218 <feedback> |
1218 <field name="coveringExpressionOffsets" optional="true"> | 1219 <field name="coveringExpressionOffsets" optional="true"> |
1219 <list><ref>int</ref></list> | 1220 <list> |
| 1221 <ref>int</ref> |
| 1222 </list> |
1220 <p> | 1223 <p> |
1221 The offsets of the expressions that cover the specified selection, | 1224 The offsets of the expressions that cover the specified selection, |
1222 from the down most to the up most. | 1225 from the down most to the up most. |
1223 </p> | 1226 </p> |
1224 </field> | 1227 </field> |
1225 <field name="coveringExpressionLengths" optional="true"> | 1228 <field name="coveringExpressionLengths" optional="true"> |
1226 <list><ref>int</ref></list> | 1229 <list> |
| 1230 <ref>int</ref> |
| 1231 </list> |
1227 <p> | 1232 <p> |
1228 The lengths of the expressions that cover the specified selection, | 1233 The lengths of the expressions that cover the specified selection, |
1229 from the down most to the up most. | 1234 from the down most to the up most. |
1230 </p> | 1235 </p> |
1231 </field> | 1236 </field> |
1232 <field name="names"> | 1237 <field name="names"> |
1233 <list><ref>String</ref></list> | 1238 <list> |
| 1239 <ref>String</ref> |
| 1240 </list> |
1234 <p> | 1241 <p> |
1235 The proposed names for the local variable. | 1242 The proposed names for the local variable. |
1236 </p> | 1243 </p> |
1237 </field> | 1244 </field> |
1238 <field name="offsets"> | 1245 <field name="offsets"> |
1239 <list><ref>int</ref></list> | 1246 <list> |
| 1247 <ref>int</ref> |
| 1248 </list> |
1240 <p> | 1249 <p> |
1241 The offsets of the expressions that would be replaced by a reference | 1250 The offsets of the expressions that would be replaced by a reference |
1242 to the variable. | 1251 to the variable. |
1243 </p> | 1252 </p> |
1244 </field> | 1253 </field> |
1245 <field name="lengths"> | 1254 <field name="lengths"> |
1246 <list><ref>int</ref></list> | 1255 <list> |
| 1256 <ref>int</ref> |
| 1257 </list> |
1247 <p> | 1258 <p> |
1248 The lengths of the expressions that would be replaced by a reference | 1259 The lengths of the expressions that would be replaced by a reference |
1249 to the variable. The lengths correspond to the offsets. In other | 1260 to the variable. The lengths correspond to the offsets. In other |
1250 words, for a given expression, if the offset of that expression is | 1261 words, for a given expression, if the offset of that expression is |
1251 offsets[i], then the length of that expression is lengths[i]. | 1262 offsets[i], then the length of that expression is lengths[i]. |
1252 </p> | 1263 </p> |
1253 </field> | 1264 </field> |
1254 </feedback> | 1265 </feedback> |
1255 <options> | 1266 <options> |
1256 <field name="name"> | 1267 <field name="name"> |
(...skipping 39 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1296 </field> | 1307 </field> |
1297 <field name="returnType"> | 1308 <field name="returnType"> |
1298 <ref>String</ref> | 1309 <ref>String</ref> |
1299 <p> | 1310 <p> |
1300 The proposed return type for the method. If the returned element does | 1311 The proposed return type for the method. If the returned element does |
1301 not have a declared return type, this field will contain an empty | 1312 not have a declared return type, this field will contain an empty |
1302 string. | 1313 string. |
1303 </p> | 1314 </p> |
1304 </field> | 1315 </field> |
1305 <field name="names"> | 1316 <field name="names"> |
1306 <list><ref>String</ref></list> | 1317 <list> |
| 1318 <ref>String</ref> |
| 1319 </list> |
1307 <p> | 1320 <p> |
1308 The proposed names for the method. | 1321 The proposed names for the method. |
1309 </p> | 1322 </p> |
1310 </field> | 1323 </field> |
1311 <field name="canCreateGetter"> | 1324 <field name="canCreateGetter"> |
1312 <ref>bool</ref> | 1325 <ref>bool</ref> |
1313 <p> | 1326 <p> |
1314 True if a getter could be created rather than a method. | 1327 True if a getter could be created rather than a method. |
1315 </p> | 1328 </p> |
1316 </field> | 1329 </field> |
1317 <field name="parameters"> | 1330 <field name="parameters"> |
1318 <list><ref>RefactoringMethodParameter</ref></list> | 1331 <list> |
| 1332 <ref>RefactoringMethodParameter</ref> |
| 1333 </list> |
1319 <p> | 1334 <p> |
1320 The proposed parameters for the method. | 1335 The proposed parameters for the method. |
1321 </p> | 1336 </p> |
1322 </field> | 1337 </field> |
1323 <field name="offsets"> | 1338 <field name="offsets"> |
1324 <list><ref>int</ref></list> | 1339 <list> |
| 1340 <ref>int</ref> |
| 1341 </list> |
1325 <p> | 1342 <p> |
1326 The offsets of the expressions or statements that would be replaced by | 1343 The offsets of the expressions or statements that would be replaced by |
1327 an invocation of the method. | 1344 an invocation of the method. |
1328 </p> | 1345 </p> |
1329 </field> | 1346 </field> |
1330 <field name="lengths"> | 1347 <field name="lengths"> |
1331 <list><ref>int</ref></list> | 1348 <list> |
| 1349 <ref>int</ref> |
| 1350 </list> |
1332 <p> | 1351 <p> |
1333 The lengths of the expressions or statements that would be replaced by | 1352 The lengths of the expressions or statements that would be replaced by |
1334 an invocation of the method. The lengths correspond to the offsets. In | 1353 an invocation of the method. The lengths correspond to the offsets. In |
1335 other words, for a given expression (or block of statements), if the | 1354 other words, for a given expression (or block of statements), if the |
1336 offset of that expression is offsets[i], then the length of that | 1355 offset of that expression is offsets[i], then the length of that |
1337 expression is lengths[i]. | 1356 expression is lengths[i]. |
1338 </p> | 1357 </p> |
1339 </field> | 1358 </field> |
1340 </feedback> | 1359 </feedback> |
1341 <options> | 1360 <options> |
(...skipping 10 matching lines...) Expand all Loading... |
1352 error if this field is true and the list of parameters is non-empty. | 1371 error if this field is true and the list of parameters is non-empty. |
1353 </p> | 1372 </p> |
1354 </field> | 1373 </field> |
1355 <field name="name"> | 1374 <field name="name"> |
1356 <ref>String</ref> | 1375 <ref>String</ref> |
1357 <p> | 1376 <p> |
1358 The name that the method should be given. | 1377 The name that the method should be given. |
1359 </p> | 1378 </p> |
1360 </field> | 1379 </field> |
1361 <field name="parameters"> | 1380 <field name="parameters"> |
1362 <list><ref>RefactoringMethodParameter</ref></list> | 1381 <list> |
| 1382 <ref>RefactoringMethodParameter</ref> |
| 1383 </list> |
1363 <p> | 1384 <p> |
1364 The parameters that should be defined for the method. | 1385 The parameters that should be defined for the method. |
1365 </p> | 1386 </p> |
1366 <p> | 1387 <p> |
1367 It is an error if a REQUIRED or NAMED parameter follows a POSITIONAL | 1388 It is an error if a REQUIRED or NAMED parameter follows a POSITIONAL |
1368 parameter. It is an error if a REQUIRED or POSITIONAL parameter | 1389 parameter. It is an error if a REQUIRED or POSITIONAL parameter |
1369 follows a NAMED parameter. | 1390 follows a NAMED parameter. |
1370 </p> | 1391 </p> |
1371 <ul> | 1392 <ul> |
1372 <li> | 1393 <li> |
(...skipping 157 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1530 The name that the element should have after the refactoring. | 1551 The name that the element should have after the refactoring. |
1531 </p> | 1552 </p> |
1532 </field> | 1553 </field> |
1533 </options> | 1554 </options> |
1534 </refactoring> | 1555 </refactoring> |
1535 </refactorings> | 1556 </refactorings> |
1536 <h2 class="domain"><a name="index">Index</a></h2> | 1557 <h2 class="domain"><a name="index">Index</a></h2> |
1537 <index></index> | 1558 <index></index> |
1538 </body> | 1559 </body> |
1539 </html> | 1560 </html> |
OLD | NEW |