Chromium Code Reviews Chromium Code Reviews
Issue 482573004:
Change analysis server protocol to omit empty lists when optional. (Closed)
Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart| 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">WORKING DRAFT - Version <version>0.3</version></h1 > | 8 <h1 style="color:#999999">WORKING DRAFT - Version <version>0.3</version></h1 > |
| 9 <p> | 9 <p> |
| 10 This document contains a specification of the API provided by | 10 This document contains a specification of the API provided by |
| (...skipping 17 matching lines...) Expand all Loading... | |
| 28 When character streams are used as the transport, messages are | 28 When character streams are used as the transport, messages are |
| 29 delineated by newlines. This means, in particular, that the JSON | 29 delineated by newlines. This means, in particular, that the JSON |
| 30 encoding process must not introduce newlines within a | 30 encoding process must not introduce newlines within a |
| 31 message. Note however that newlines are used in this document | 31 message. Note however that newlines are used in this document |
| 32 for readability. | 32 for readability. |
| 33 </p> | 33 </p> |
| 34 <p> | 34 <p> |
| 35 To ease interoperability with Lisp-based clients (which may not | 35 To ease interoperability with Lisp-based clients (which may not |
| 36 be able to easily distinguish between empty lists, empty maps, | 36 be able to easily distinguish between empty lists, empty maps, |
| 37 and null), client-to-server communication is allowed to replace | 37 and null), client-to-server communication is allowed to replace |
| 38 any instance of “<tt>{}</tt>” or “<tt>[]</tt>” with null. The | 38 any instance of “<tt>{}</tt>” or “<tt>[]</tt>” with null. |
| 39 server will always properly represent empty lists as | 39 </p> |
| 40 “<tt>[]</tt>” and empty maps as “<tt>{}</tt>”. | 40 <p> |
| 41 In addition, to conserve bytes, all object fields of type "List" | |
| 42 are optional; omitting such a field carries the same meaning as | |
| 43 sending an empty list. | |
| 44 </p> | |
| 45 <p> | |
| 46 Server-to-client communication will always omit empty lists, and | |
| 47 will always represent empty maps as <tt>{}</tt>. | |
|
Brian Wilkerson
2014/08/22 15:12:45
Do we want to have the same convention for maps?
| |
| 41 </p> | 48 </p> |
| 42 <h3>Communication Structure</h3> | 49 <h3>Communication Structure</h3> |
| 43 <p> | 50 <p> |
| 44 Clients can make a request of the server and the server will | 51 Clients can make a request of the server and the server will |
| 45 provide a response for each request that it receives. While many | 52 provide a response for each request that it receives. While many |
| 46 of the requests that can be made by a client are informational | 53 of the requests that can be made by a client are informational |
| 47 in nature, we have chosen to always return a response so that | 54 in nature, we have chosen to always return a response so that |
| 48 clients can know whether the request was received and was | 55 clients can know whether the request was received and was |
| 49 correct. | 56 correct. |
| 50 </p> | 57 </p> |
| (...skipping 112 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 163 <p> | 170 <p> |
| 164 Subscribe for services. All previous subscriptions are | 171 Subscribe for services. All previous subscriptions are |
| 165 replaced by the given set of services. | 172 replaced by the given set of services. |
| 166 </p> | 173 </p> |
| 167 <p> | 174 <p> |
| 168 It is an error if any of the elements in the list are not | 175 It is an error if any of the elements in the list are not |
| 169 valid services. If there is an error, then the current | 176 valid services. If there is an error, then the current |
| 170 subscriptions will remain unchanged. | 177 subscriptions will remain unchanged. |
| 171 </p> | 178 </p> |
| 172 <params> | 179 <params> |
| 173 <field name="subscriptions"> | 180 <field name="subscriptions" optional="true"> |
| 174 <list><ref>ServerService</ref></list> | 181 <list><ref>ServerService</ref></list> |
| 175 <p>A list of the services being subscribed to.</p> | 182 <p>A list of the services being subscribed to.</p> |
| 176 </field> | 183 </field> |
| 177 </params> | 184 </params> |
| 178 </request> | 185 </request> |
| 179 <notification event="connected"> | 186 <notification event="connected"> |
| 180 <p> | 187 <p> |
| 181 Reports that the server is running. This notification is | 188 Reports that the server is running. This notification is |
| 182 issued once after the server has started running but before | 189 issued once after the server has started running but before |
| 183 any requests are processed to let the client know that it | 190 any requests are processed to let the client know that it |
| (...skipping 92 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 276 </p> | 283 </p> |
| 277 <params> | 284 <params> |
| 278 <field name="file"> | 285 <field name="file"> |
| 279 <ref>FilePath</ref> | 286 <ref>FilePath</ref> |
| 280 <p> | 287 <p> |
| 281 The file for which errors are being requested. | 288 The file for which errors are being requested. |
| 282 </p> | 289 </p> |
| 283 </field> | 290 </field> |
| 284 </params> | 291 </params> |
| 285 <result> | 292 <result> |
| 286 <field name="errors"> | 293 <field name="errors" optional="true"> |
| 287 <list><ref>AnalysisError</ref></list> | 294 <list><ref>AnalysisError</ref></list> |
| 288 <p> | 295 <p> |
| 289 The errors associated with the file. | 296 The errors associated with the file. |
| 290 </p> | 297 </p> |
| 291 </field> | 298 </field> |
| 292 </result> | 299 </result> |
| 293 </request> | 300 </request> |
| 294 <request method="getHover"> | 301 <request method="getHover"> |
| 295 <p> | 302 <p> |
| 296 Return the hover information associate with the given | 303 Return the hover information associate with the given |
| (...skipping 11 matching lines...) Expand all Loading... | |
| 308 </field> | 315 </field> |
| 309 <field name="offset"> | 316 <field name="offset"> |
| 310 <ref>int</ref> | 317 <ref>int</ref> |
| 311 <p> | 318 <p> |
| 312 The offset for which hover information is being | 319 The offset for which hover information is being |
| 313 requested. | 320 requested. |
| 314 </p> | 321 </p> |
| 315 </field> | 322 </field> |
| 316 </params> | 323 </params> |
| 317 <result> | 324 <result> |
| 318 <field name="hovers"> | 325 <field name="hovers" optional="true"> |
| 319 <list><ref>HoverInformation</ref></list> | 326 <list><ref>HoverInformation</ref></list> |
| 320 <p> | 327 <p> |
| 321 The hover information associated with the | 328 The hover information associated with the |
| 322 location. The list will be empty if no information | 329 location. The list will be omitted if no information |
| 323 could be determined for the location. The list can | 330 could be determined for the location. The list can |
| 324 contain multiple items if the file is being analyzed | 331 contain multiple items if the file is being analyzed |
| 325 in multiple contexts in conflicting ways (such as a | 332 in multiple contexts in conflicting ways (such as a |
| 326 part that is included in multiple libraries). | 333 part that is included in multiple libraries). |
| 327 </p> | 334 </p> |
| 328 </field> | 335 </field> |
| 329 </result> | 336 </result> |
| 330 </request> | 337 </request> |
| 331 <request method="reanalyze"> | 338 <request method="reanalyze"> |
| 332 <p> | 339 <p> |
| (...skipping 27 matching lines...) Expand all Loading... | |
| 360 </p> | 367 </p> |
| 361 <p> | 368 <p> |
| 362 If an included path represents a file, then server will look | 369 If an included path represents a file, then server will look |
| 363 in the directory containing the file for a pubspec.yaml | 370 in the directory containing the file for a pubspec.yaml |
| 364 file. If none is found, then the parents of the directory | 371 file. If none is found, then the parents of the directory |
| 365 will be searched until such a file is found or the root of | 372 will be searched until such a file is found or the root of |
| 366 the file system is reached. If such a file is found, it will | 373 the file system is reached. If such a file is found, it will |
| 367 be used to resolve package: URI’s within the file. | 374 be used to resolve package: URI’s within the file. |
| 368 </p> | 375 </p> |
| 369 <params> | 376 <params> |
| 370 <field name="included"> | 377 <field name="included" optional="true"> |
| 371 <list><ref>FilePath</ref></list> | 378 <list><ref>FilePath</ref></list> |
| 372 <p> | 379 <p> |
| 373 A list of the files and directories that should be | 380 A list of the files and directories that should be |
| 374 analyzed. | 381 analyzed. |
| 375 </p> | 382 </p> |
| 376 </field> | 383 </field> |
| 377 <field name="excluded"> | 384 <field name="excluded" optional="true"> |
| 378 <list><ref>FilePath</ref></list> | 385 <list><ref>FilePath</ref></list> |
| 379 <p> | 386 <p> |
| 380 A list of the files and directories within the | 387 A list of the files and directories within the |
| 381 included directories that should not be analyzed. | 388 included directories that should not be analyzed. |
| 382 </p> | 389 </p> |
| 383 </field> | 390 </field> |
| 384 </params> | 391 </params> |
| 385 </request> | 392 </request> |
| 386 <request method="setPriorityFiles"> | 393 <request method="setPriorityFiles"> |
| 387 <p> | 394 <p> |
| (...skipping 15 matching lines...) Expand all Loading... | |
| 403 analysis.setSubscriptions for a description of files that | 410 analysis.setSubscriptions for a description of files that |
| 404 are subject to analysis.) | 411 are subject to analysis.) |
| 405 </p> | 412 </p> |
| 406 <p> | 413 <p> |
| 407 If a requested priority file is a directory it is ignored, | 414 If a requested priority file is a directory it is ignored, |
| 408 but remains in the set of requested priority files so that | 415 but remains in the set of requested priority files so that |
| 409 if it later becomes a file it can be included in the set of | 416 if it later becomes a file it can be included in the set of |
| 410 actual priority files. | 417 actual priority files. |
| 411 </p> | 418 </p> |
| 412 <params> | 419 <params> |
| 413 <field name="files"> | 420 <field name="files" optional="true"> |
| 414 <list><ref>FilePath</ref></list> | 421 <list><ref>FilePath</ref></list> |
| 415 <p> | 422 <p> |
| 416 The files that are to be a priority for analysis. | 423 The files that are to be a priority for analysis. |
| 417 </p> | 424 </p> |
| 418 </field> | 425 </field> |
| 419 </params> | 426 </params> |
| 420 </request> | 427 </request> |
| 421 <request method="setSubscriptions"> | 428 <request method="setSubscriptions"> |
| 422 <p> | 429 <p> |
| 423 Subscribe for services. All previous subscriptions are | 430 Subscribe for services. All previous subscriptions are |
| (...skipping 100 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 524 It is only possible to unsubscribe from this notification by | 531 It is only possible to unsubscribe from this notification by |
| 525 using the command-line flag --no-error-notification. | 532 using the command-line flag --no-error-notification. |
| 526 </p> | 533 </p> |
| 527 <params> | 534 <params> |
| 528 <field name="file"> | 535 <field name="file"> |
| 529 <ref>FilePath</ref> | 536 <ref>FilePath</ref> |
| 530 <p> | 537 <p> |
| 531 The file containing the errors. | 538 The file containing the errors. |
| 532 </p> | 539 </p> |
| 533 </field> | 540 </field> |
| 534 <field name="errors"> | 541 <field name="errors" optional="true"> |
| 535 <list><ref>AnalysisError</ref></list> | 542 <list><ref>AnalysisError</ref></list> |
| 536 <p> | 543 <p> |
| 537 The errors contained in the file. | 544 The errors contained in the file. |
| 538 </p> | 545 </p> |
| 539 </field> | 546 </field> |
| 540 </params> | 547 </params> |
| 541 </notification> | 548 </notification> |
| 542 <notification event="flushResults"> | 549 <notification event="flushResults"> |
| 543 <p> | 550 <p> |
| 544 Reports that any analysis results that were previously | 551 Reports that any analysis results that were previously |
| 545 associated with the given files should be considered to be | 552 associated with the given files should be considered to be |
| 546 invalid because those files are no longer being analyzed, | 553 invalid because those files are no longer being analyzed, |
| 547 either because the analysis root that contained it is no | 554 either because the analysis root that contained it is no |
| 548 longer being analyzed or because the file no longer exists. | 555 longer being analyzed or because the file no longer exists. |
| 549 </p> | 556 </p> |
| 550 <p> | 557 <p> |
| 551 If a file is included in this notification and at some later | 558 If a file is included in this notification and at some later |
| 552 time a notification with results for the file is received, | 559 time a notification with results for the file is received, |
| 553 clients should assume that the file is once again being | 560 clients should assume that the file is once again being |
| 554 analyzed and the information should be processed. | 561 analyzed and the information should be processed. |
| 555 </p> | 562 </p> |
| 556 <p> | 563 <p> |
| 557 It is not possible to subscribe to or unsubscribe from this | 564 It is not possible to subscribe to or unsubscribe from this |
| 558 notification. | 565 notification. |
| 559 </p> | 566 </p> |
| 560 <params> | 567 <params> |
| 561 <field name="files"> | 568 <field name="files" optional="true"> |
| 562 <list><ref>FilePath</ref></list> | 569 <list><ref>FilePath</ref></list> |
| 563 <p> | 570 <p> |
| 564 The files that are no longer being analyzed. | 571 The files that are no longer being analyzed. |
| 565 </p> | 572 </p> |
| 566 </field> | 573 </field> |
| 567 </params> | 574 </params> |
| 568 </notification> | 575 </notification> |
| 569 <notification event="folding"> | 576 <notification event="folding"> |
| 570 <p> | 577 <p> |
| 571 Reports the folding regions associated with a given | 578 Reports the folding regions associated with a given |
| 572 file. Folding regions can be nested, but will not be | 579 file. Folding regions can be nested, but will not be |
| 573 overlapping. Nesting occurs when a foldable element, such as | 580 overlapping. Nesting occurs when a foldable element, such as |
| 574 a method, is nested inside another foldable element such as | 581 a method, is nested inside another foldable element such as |
| 575 a class. | 582 a class. |
| 576 </p> | 583 </p> |
| 577 <p> | 584 <p> |
| 578 This notification is not subscribed to by default. Clients | 585 This notification is not subscribed to by default. Clients |
| 579 can subscribe by including the value <tt>"FOLDING"</tt> in | 586 can subscribe by including the value <tt>"FOLDING"</tt> in |
| 580 the list of services passed in an analysis.setSubscriptions | 587 the list of services passed in an analysis.setSubscriptions |
| 581 request. | 588 request. |
| 582 </p> | 589 </p> |
| 583 <params> | 590 <params> |
| 584 <field name="file"> | 591 <field name="file"> |
| 585 <ref>FilePath</ref> | 592 <ref>FilePath</ref> |
| 586 <p> | 593 <p> |
| 587 The file containing the folding regions. | 594 The file containing the folding regions. |
| 588 </p> | 595 </p> |
| 589 </field> | 596 </field> |
| 590 <field name="regions"> | 597 <field name="regions" optional="true"> |
| 591 <list><ref>FoldingRegion</ref></list> | 598 <list><ref>FoldingRegion</ref></list> |
| 592 <p> | 599 <p> |
| 593 The folding regions contained in the file. | 600 The folding regions contained in the file. |
| 594 </p> | 601 </p> |
| 595 </field> | 602 </field> |
| 596 </params> | 603 </params> |
| 597 </notification> | 604 </notification> |
| 598 <notification event="highlights"> | 605 <notification event="highlights"> |
| 599 <p> | 606 <p> |
| 600 Reports the highlight regions associated with a given file. | 607 Reports the highlight regions associated with a given file. |
| 601 </p> | 608 </p> |
| 602 <p> | 609 <p> |
| 603 This notification is not subscribed to by default. Clients | 610 This notification is not subscribed to by default. Clients |
| 604 can subscribe by including the value <tt>"HIGHLIGHTS"</tt> | 611 can subscribe by including the value <tt>"HIGHLIGHTS"</tt> |
| 605 in the list of services passed in an | 612 in the list of services passed in an |
| 606 analysis.setSubscriptions request. | 613 analysis.setSubscriptions request. |
| 607 </p> | 614 </p> |
| 608 <params> | 615 <params> |
| 609 <field name="file"> | 616 <field name="file"> |
| 610 <ref>FilePath</ref> | 617 <ref>FilePath</ref> |
| 611 <p> | 618 <p> |
| 612 The file containing the highlight regions. | 619 The file containing the highlight regions. |
| 613 </p> | 620 </p> |
| 614 </field> | 621 </field> |
| 615 <field name="regions"> | 622 <field name="regions" optional="true"> |
| 616 <list><ref>HighlightRegion</ref></list> | 623 <list><ref>HighlightRegion</ref></list> |
| 617 <p> | 624 <p> |
| 618 The highlight regions contained in the file. Each | 625 The highlight regions contained in the file. Each |
| 619 highlight region represents a particular syntactic or | 626 highlight region represents a particular syntactic or |
| 620 semantic meaning associated with some range. Note that | 627 semantic meaning associated with some range. Note that |
| 621 the highlight regions that are returned can overlap | 628 the highlight regions that are returned can overlap |
| 622 other highlight regions if there is more than one | 629 other highlight regions if there is more than one |
| 623 meaning associated with a particular region. | 630 meaning associated with a particular region. |
| 624 </p> | 631 </p> |
| 625 </field> | 632 </field> |
| 626 </params> | 633 </params> |
| 627 </notification> | 634 </notification> |
| 628 <notification event="navigation"> | 635 <notification event="navigation"> |
| 629 <p> | 636 <p> |
| 630 Reports the navigation targets associated with a given file. | 637 Reports the navigation targets associated with a given file. |
| 631 </p> | 638 </p> |
| 632 <p> | 639 <p> |
| 633 This notification is not subscribed to by default. Clients | 640 This notification is not subscribed to by default. Clients |
| 634 can subscribe by including the value <tt>"NAVIGATION"</tt> | 641 can subscribe by including the value <tt>"NAVIGATION"</tt> |
| 635 in the list of services passed in an | 642 in the list of services passed in an |
| 636 analysis.setSubscriptions request. | 643 analysis.setSubscriptions request. |
| 637 </p> | 644 </p> |
| 638 <params> | 645 <params> |
| 639 <field name="file"> | 646 <field name="file"> |
| 640 <ref>FilePath</ref> | 647 <ref>FilePath</ref> |
| 641 <p> | 648 <p> |
| 642 The file containing the navigation regions. | 649 The file containing the navigation regions. |
| 643 </p> | 650 </p> |
| 644 </field> | 651 </field> |
| 645 <field name="regions"> | 652 <field name="regions" optional="true"> |
| 646 <list><ref>NavigationRegion</ref></list> | 653 <list><ref>NavigationRegion</ref></list> |
| 647 <p> | 654 <p> |
| 648 The navigation regions contained in the file. Each | 655 The navigation regions contained in the file. Each |
| 649 navigation region represents a list of targets | 656 navigation region represents a list of targets |
| 650 associated with some range. The lists will usually | 657 associated with some range. The lists will usually |
| 651 contain a single target, but can contain more in the | 658 contain a single target, but can contain more in the |
| 652 case of a part that is included in multiple libraries | 659 case of a part that is included in multiple libraries |
| 653 or in Dart code that is compiled against multiple | 660 or in Dart code that is compiled against multiple |
| 654 versions of a package. Note that the navigation | 661 versions of a package. Note that the navigation |
| 655 regions that are returned do not overlap other | 662 regions that are returned do not overlap other |
| (...skipping 13 matching lines...) Expand all Loading... | |
| 669 in the list of services passed in an | 676 in the list of services passed in an |
| 670 analysis.setSubscriptions request. | 677 analysis.setSubscriptions request. |
| 671 </p> | 678 </p> |
| 672 <params> | 679 <params> |
| 673 <field name="file"> | 680 <field name="file"> |
| 674 <ref>FilePath</ref> | 681 <ref>FilePath</ref> |
| 675 <p> | 682 <p> |
| 676 The file in which the references occur. | 683 The file in which the references occur. |
| 677 </p> | 684 </p> |
| 678 </field> | 685 </field> |
| 679 <field name="occurrences"> | 686 <field name="occurrences" optional="true"> |
| 680 <list><ref>Occurrences</ref></list> | 687 <list><ref>Occurrences</ref></list> |
| 681 <p> | 688 <p> |
| 682 The occurrences of references to elements within the | 689 The occurrences of references to elements within the |
| 683 file. | 690 file. |
| 684 </p> | 691 </p> |
| 685 </field> | 692 </field> |
| 686 </params> | 693 </params> |
| 687 </notification> | 694 </notification> |
| 688 <notification event="outline"> | 695 <notification event="outline"> |
| 689 <p> | 696 <p> |
| (...skipping 30 matching lines...) Expand all Loading... | |
| 720 the list of services passed in an analysis.setSubscriptions | 727 the list of services passed in an analysis.setSubscriptions |
| 721 request. | 728 request. |
| 722 </p> | 729 </p> |
| 723 <params> | 730 <params> |
| 724 <field name="file"> | 731 <field name="file"> |
| 725 <ref>FilePath</ref> | 732 <ref>FilePath</ref> |
| 726 <p> | 733 <p> |
| 727 The file with which the overrides are associated. | 734 The file with which the overrides are associated. |
| 728 </p> | 735 </p> |
| 729 </field> | 736 </field> |
| 730 <field name="overrides"> | 737 <field name="overrides" optional="true"> |
| 731 <list><ref>Override</ref></list> | 738 <list><ref>Override</ref></list> |
| 732 <p> | 739 <p> |
| 733 The overrides associated with the file. | 740 The overrides associated with the file. |
| 734 </p> | 741 </p> |
| 735 </field> | 742 </field> |
| 736 </params> | 743 </params> |
| 737 </notification> | 744 </notification> |
| 738 </domain> | 745 </domain> |
| 739 <domain name="completion"> | 746 <domain name="completion"> |
| 740 <p> | 747 <p> |
| (...skipping 58 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 799 </field> | 806 </field> |
| 800 <field name="replacementLength"> | 807 <field name="replacementLength"> |
| 801 <ref>int</ref> | 808 <ref>int</ref> |
| 802 <p> | 809 <p> |
| 803 The length of the text to be replaced if the remainder | 810 The length of the text to be replaced if the remainder |
| 804 of the identifier containing the cursor is to be | 811 of the identifier containing the cursor is to be |
| 805 replaced when the suggestion is applied (that is, the | 812 replaced when the suggestion is applied (that is, the |
| 806 number of characters in the existing identifier). | 813 number of characters in the existing identifier). |
| 807 </p> | 814 </p> |
| 808 </field> | 815 </field> |
| 809 <field name="results"> | 816 <field name="results" optional="true"> |
| 810 <list><ref>CompletionSuggestion</ref></list> | 817 <list><ref>CompletionSuggestion</ref></list> |
| 811 <p> | 818 <p> |
| 812 The completion suggestions being reported. The | 819 The completion suggestions being reported. The |
| 813 notification contains all possible completions at the | 820 notification contains all possible completions at the |
| 814 requested cursor position, even those that do not match | 821 requested cursor position, even those that do not match |
| 815 the characters the user has already typed. This allows | 822 the characters the user has already typed. This allows |
| 816 the client to respond to further keystrokes from the | 823 the client to respond to further keystrokes from the |
| 817 user without having to make additional requests. | 824 user without having to make additional requests. |
| 818 </p> | 825 </p> |
| 819 </field> | 826 </field> |
| (...skipping 203 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 1023 previously received search results associated with the same | 1030 previously received search results associated with the same |
| 1024 search id. | 1031 search id. |
| 1025 </p> | 1032 </p> |
| 1026 <params> | 1033 <params> |
| 1027 <field name="id"> | 1034 <field name="id"> |
| 1028 <ref>SearchId</ref> | 1035 <ref>SearchId</ref> |
| 1029 <p> | 1036 <p> |
| 1030 The id associated with the search. | 1037 The id associated with the search. |
| 1031 </p> | 1038 </p> |
| 1032 </field> | 1039 </field> |
| 1033 <field name="results"> | 1040 <field name="results" optional="true"> |
| 1034 <list><ref>SearchResult</ref></list> | 1041 <list><ref>SearchResult</ref></list> |
| 1035 <p> | 1042 <p> |
| 1036 The search results being reported. | 1043 The search results being reported. |
| 1037 </p> | 1044 </p> |
| 1038 </field> | 1045 </field> |
| 1039 <field name="last"> | 1046 <field name="last"> |
| 1040 <ref>bool</ref> | 1047 <ref>bool</ref> |
| 1041 <p> | 1048 <p> |
| 1042 True if this is that last set of results that will be | 1049 True if this is that last set of results that will be |
| 1043 returned for the indicated search. | 1050 returned for the indicated search. |
| (...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 1075 </field> | 1082 </field> |
| 1076 <field name="length"> | 1083 <field name="length"> |
| 1077 <ref>int</ref> | 1084 <ref>int</ref> |
| 1078 <p> | 1085 <p> |
| 1079 The length of the code for which assists are being | 1086 The length of the code for which assists are being |
| 1080 requested. | 1087 requested. |
| 1081 </p> | 1088 </p> |
| 1082 </field> | 1089 </field> |
| 1083 </params> | 1090 </params> |
| 1084 <result> | 1091 <result> |
| 1085 <field name="assists"> | 1092 <field name="assists" optional="true"> |
| 1086 <list><ref>SourceChange</ref></list> | 1093 <list><ref>SourceChange</ref></list> |
| 1087 <p> | 1094 <p> |
| 1088 The assists that are available at the given location. | 1095 The assists that are available at the given location. |
| 1089 </p> | 1096 </p> |
| 1090 </field> | 1097 </field> |
| 1091 </result> | 1098 </result> |
| 1092 </request> | 1099 </request> |
| 1093 <request method="getAvailableRefactorings"> | 1100 <request method="getAvailableRefactorings"> |
| 1094 <p> | 1101 <p> |
| 1095 Get a list of the kinds of refactorings that are valid for | 1102 Get a list of the kinds of refactorings that are valid for |
| (...skipping 16 matching lines...) Expand all Loading... | |
| 1112 </field> | 1119 </field> |
| 1113 <field name="length"> | 1120 <field name="length"> |
| 1114 <ref>int</ref> | 1121 <ref>int</ref> |
| 1115 <p> | 1122 <p> |
| 1116 The length of the code on which the refactoring would be | 1123 The length of the code on which the refactoring would be |
| 1117 based. | 1124 based. |
| 1118 </p> | 1125 </p> |
| 1119 </field> | 1126 </field> |
| 1120 </params> | 1127 </params> |
| 1121 <result> | 1128 <result> |
| 1122 <field name="kinds"> | 1129 <field name="kinds" optional="true"> |
| 1123 <list><ref>RefactoringKind</ref></list> | 1130 <list><ref>RefactoringKind</ref></list> |
| 1124 <p> | 1131 <p> |
| 1125 The kinds of refactorings that are valid for the given | 1132 The kinds of refactorings that are valid for the given |
| 1126 selection. | 1133 selection. |
| 1127 </p> | 1134 </p> |
| 1128 </field> | 1135 </field> |
| 1129 </result> | 1136 </result> |
| 1130 </request> | 1137 </request> |
| 1131 <request method="getFixes"> | 1138 <request method="getFixes"> |
| 1132 <p> | 1139 <p> |
| (...skipping 10 matching lines...) Expand all Loading... | |
| 1143 </field> | 1150 </field> |
| 1144 <field name="offset"> | 1151 <field name="offset"> |
| 1145 <ref>int</ref> | 1152 <ref>int</ref> |
| 1146 <p> | 1153 <p> |
| 1147 The offset used to select the errors for which fixes | 1154 The offset used to select the errors for which fixes |
| 1148 will be returned. | 1155 will be returned. |
| 1149 </p> | 1156 </p> |
| 1150 </field> | 1157 </field> |
| 1151 </params> | 1158 </params> |
| 1152 <result> | 1159 <result> |
| 1153 <field name="fixes"> | 1160 <field name="fixes" optional="true"> |
| 1154 <list><ref>ErrorFixes</ref></list> | 1161 <list><ref>ErrorFixes</ref></list> |
| 1155 <p> | 1162 <p> |
| 1156 The fixes that are available for each of the analysis | 1163 The fixes that are available for each of the analysis |
| 1157 errors. There is a one-to-one correspondence between the | 1164 errors. There is a one-to-one correspondence between the |
| 1158 analysis errors in the request and the lists of changes | 1165 analysis errors in the request and the lists of changes |
| 1159 in the response. In particular, it is always the case | 1166 in the response. In particular, it is always the case |
| 1160 that errors.length == fixes.length and that fixes[i] is | 1167 that errors.length == fixes.length and that fixes[i] is |
| 1161 the list of fixes for the error in errors[i]. The list | 1168 the list of fixes for the error in errors[i]. The list |
| 1162 of changes corresponding to an error can be empty if | 1169 of changes corresponding to an error can be empty if |
| 1163 there are no fixes available for that error. | 1170 there are no fixes available for that error. |
| (...skipping 46 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 1210 refactoring being performed. The data that is expected is | 1217 refactoring being performed. The data that is expected is |
| 1211 documented in the section titled <a | 1218 documented in the section titled <a |
| 1212 href="#refactorings">Refactorings</a>, labeled as | 1219 href="#refactorings">Refactorings</a>, labeled as |
| 1213 “Options”. This field can be omitted if the refactoring | 1220 “Options”. This field can be omitted if the refactoring |
| 1214 does not require any options or if the values of those | 1221 does not require any options or if the values of those |
| 1215 options are not known. | 1222 options are not known. |
| 1216 </p> | 1223 </p> |
| 1217 </field> | 1224 </field> |
| 1218 </params> | 1225 </params> |
| 1219 <result> | 1226 <result> |
| 1220 <field name="status"> | 1227 <field name="status" optional="true"> |
| 1221 <list><ref>RefactoringProblem</ref></list> | 1228 <list><ref>RefactoringProblem</ref></list> |
| 1222 <p> | 1229 <p> |
| 1223 The status of the refactoring. The array will be empty | 1230 The status of the refactoring. The array will be empty |
|
Brian Wilkerson
2014/08/22 15:12:45
"empty" --> "omitted"
| |
| 1224 if there are no known problems. | 1231 if there are no known problems. |
| 1225 </p> | 1232 </p> |
| 1226 </field> | 1233 </field> |
| 1227 <field name="feedback" optional="true"> | 1234 <field name="feedback" optional="true"> |
| 1228 <ref>object</ref> | 1235 <ref>object</ref> |
| 1229 <p> | 1236 <p> |
| 1230 Data used to provide feedback to the user. The structure | 1237 Data used to provide feedback to the user. The structure |
| 1231 of the data is dependent on the kind of refactoring | 1238 of the data is dependent on the kind of refactoring |
| 1232 being created. The data that is returned is documented | 1239 being created. The data that is returned is documented |
| 1233 in the section titled <a | 1240 in the section titled <a |
| (...skipping 125 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 1359 <p> | 1366 <p> |
| 1360 Subscribe for services. All previous subscriptions are | 1367 Subscribe for services. All previous subscriptions are |
| 1361 replaced by the given set of services. | 1368 replaced by the given set of services. |
| 1362 </p> | 1369 </p> |
| 1363 <p> | 1370 <p> |
| 1364 It is an error if any of the elements in the list are not | 1371 It is an error if any of the elements in the list are not |
| 1365 valid services. If there is an error, then the current | 1372 valid services. If there is an error, then the current |
| 1366 subscriptions will remain unchanged. | 1373 subscriptions will remain unchanged. |
| 1367 </p> | 1374 </p> |
| 1368 <params> | 1375 <params> |
| 1369 <field name="subscriptions"> | 1376 <field name="subscriptions" optional="true"> |
| 1370 <list><ref>DebugService</ref></list> | 1377 <list><ref>DebugService</ref></list> |
| 1371 <p> | 1378 <p> |
| 1372 A list of the services being subscribed to. | 1379 A list of the services being subscribed to. |
| 1373 </p> | 1380 </p> |
| 1374 </field> | 1381 </field> |
| 1375 </params> | 1382 </params> |
| 1376 </request> | 1383 </request> |
| 1377 <notification event="launchData"> | 1384 <notification event="launchData"> |
| 1378 <p> | 1385 <p> |
| 1379 Reports information needed to allow applications within the | 1386 Reports information needed to allow applications within the |
| 1380 given context to be launched. | 1387 given context to be launched. |
| 1381 </p> | 1388 </p> |
| 1382 <p> | 1389 <p> |
| 1383 This notification is not subscribed to by default. Clients | 1390 This notification is not subscribed to by default. Clients |
| 1384 can subscribe by including the value "LAUNCH_DATA" in the | 1391 can subscribe by including the value "LAUNCH_DATA" in the |
| 1385 list of services passed in a debug.setSubscriptions request. | 1392 list of services passed in a debug.setSubscriptions request. |
| 1386 </p> | 1393 </p> |
| 1387 <params> | 1394 <params> |
| 1388 <field name="executables"> | 1395 <field name="executables" optional="true"> |
| 1389 <list><ref>ExecutableFile</ref></list> | 1396 <list><ref>ExecutableFile</ref></list> |
| 1390 <p> | 1397 <p> |
| 1391 A list of the files that are executable in the given | 1398 A list of the files that are executable in the given |
| 1392 context. This list replaces any previous list provided | 1399 context. This list replaces any previous list provided |
| 1393 for the given context. | 1400 for the given context. |
| 1394 </p> | 1401 </p> |
| 1395 </field> | 1402 </field> |
| 1396 <field name="dartToHtml"> | 1403 <field name="dartToHtml"> |
| 1397 <map> | 1404 <map> |
| 1398 <key><ref>FilePath</ref></key> | 1405 <key><ref>FilePath</ref></key> |
| (...skipping 179 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 1578 This means that the offset of each edit must be correct under the | 1585 This means that the offset of each edit must be correct under the |
| 1579 assumption that all previous edits have been applied. | 1586 assumption that all previous edits have been applied. |
| 1580 </p> | 1587 </p> |
| 1581 <p> | 1588 <p> |
| 1582 It is an error to use this overlay on a file that does not yet have | 1589 It is an error to use this overlay on a file that does not yet have |
| 1583 a file content overlay or that has had its overlay removed via | 1590 a file content overlay or that has had its overlay removed via |
| 1584 <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a>. | 1591 <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a>. |
| 1585 </p> | 1592 </p> |
| 1586 <object> | 1593 <object> |
| 1587 <field name="type" value="change"><ref>String</ref></field> | 1594 <field name="type" value="change"><ref>String</ref></field> |
| 1588 <field name="edits"> | 1595 <field name="edits" optional="true"> |
| 1589 <list><ref>SourceEdit</ref></list> | 1596 <list><ref>SourceEdit</ref></list> |
| 1590 <p> | 1597 <p> |
| 1591 The edits to be applied to the file. | 1598 The edits to be applied to the file. |
| 1592 </p> | 1599 </p> |
| 1593 </field> | 1600 </field> |
| 1594 </object> | 1601 </object> |
| 1595 </type> | 1602 </type> |
| 1596 <type name="CompletionId"> | 1603 <type name="CompletionId"> |
| 1597 <ref>String</ref> | 1604 <ref>String</ref> |
| 1598 <p> | 1605 <p> |
| (...skipping 309 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 1908 <p> | 1915 <p> |
| 1909 A list of fixes associated with a specific error | 1916 A list of fixes associated with a specific error |
| 1910 </p> | 1917 </p> |
| 1911 <object> | 1918 <object> |
| 1912 <field name="error"> | 1919 <field name="error"> |
| 1913 <ref>AnalysisError</ref> | 1920 <ref>AnalysisError</ref> |
| 1914 <p> | 1921 <p> |
| 1915 The error with which the fixes are associated. | 1922 The error with which the fixes are associated. |
| 1916 </p> | 1923 </p> |
| 1917 </field> | 1924 </field> |
| 1918 <field name="fixes"> | 1925 <field name="fixes" optional="true"> |
| 1919 <list><ref>SourceChange</ref></list> | 1926 <list><ref>SourceChange</ref></list> |
| 1920 <p> | 1927 <p> |
| 1921 The fixes associated with the error. | 1928 The fixes associated with the error. |
| 1922 </p> | 1929 </p> |
| 1923 </field> | 1930 </field> |
| 1924 </object> | 1931 </object> |
| 1925 </type> | 1932 </type> |
| 1926 <type name="ErrorSeverity"> | 1933 <type name="ErrorSeverity"> |
| 1927 <p> | 1934 <p> |
| 1928 An enumeration of the possible severities of analysis | 1935 An enumeration of the possible severities of analysis |
| (...skipping 254 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 2183 <p> | 2190 <p> |
| 2184 A collection of positions that should be linked (edited | 2191 A collection of positions that should be linked (edited |
| 2185 simultaneously) for the purposes of updating code after a | 2192 simultaneously) for the purposes of updating code after a |
| 2186 source change. For example, if a set of edits introduced a | 2193 source change. For example, if a set of edits introduced a |
| 2187 new variable name, the group would contain all of the | 2194 new variable name, the group would contain all of the |
| 2188 positions of the variable name so that if the client wanted | 2195 positions of the variable name so that if the client wanted |
| 2189 to let the user edit the variable name after the operation, | 2196 to let the user edit the variable name after the operation, |
| 2190 all occurrences of the name could be edited simultaneously. | 2197 all occurrences of the name could be edited simultaneously. |
| 2191 </p> | 2198 </p> |
| 2192 <object> | 2199 <object> |
| 2193 <field name="positions"> | 2200 <field name="positions" optional="true"> |
| 2194 <list><ref>Position</ref></list> | 2201 <list><ref>Position</ref></list> |
| 2195 <p> | 2202 <p> |
| 2196 The positions of the regions that should be edited | 2203 The positions of the regions that should be edited |
| 2197 simultaneously. | 2204 simultaneously. |
| 2198 </p> | 2205 </p> |
| 2199 </field> | 2206 </field> |
| 2200 <field name="length"> | 2207 <field name="length"> |
| 2201 <ref>int</ref> | 2208 <ref>int</ref> |
| 2202 <p> | 2209 <p> |
| 2203 The length of the regions that should be edited | 2210 The length of the regions that should be edited |
| 2204 simultaneously. | 2211 simultaneously. |
| 2205 </p> | 2212 </p> |
| 2206 </field> | 2213 </field> |
| 2207 <field name="suggestions"> | 2214 <field name="suggestions" optional="true"> |
| 2208 <list><ref>LinkedEditSuggestion</ref></list> | 2215 <list><ref>LinkedEditSuggestion</ref></list> |
| 2209 <p> | 2216 <p> |
| 2210 Pre-computed suggestions for what every region might | 2217 Pre-computed suggestions for what every region might |
| 2211 want to be changed to. | 2218 want to be changed to. |
| 2212 </p> | 2219 </p> |
| 2213 </field> | 2220 </field> |
| 2214 </object> | 2221 </object> |
| 2215 </type> | 2222 </type> |
| 2216 <type name="LinkedEditSuggestion"> | 2223 <type name="LinkedEditSuggestion"> |
| 2217 <p> | 2224 <p> |
| (...skipping 78 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 2296 <p> | 2303 <p> |
| 2297 The offset of the region from which the user can navigate. | 2304 The offset of the region from which the user can navigate. |
| 2298 </p> | 2305 </p> |
| 2299 </field> | 2306 </field> |
| 2300 <field name="length"> | 2307 <field name="length"> |
| 2301 <ref>int</ref> | 2308 <ref>int</ref> |
| 2302 <p> | 2309 <p> |
| 2303 The length of the region from which the user can navigate. | 2310 The length of the region from which the user can navigate. |
| 2304 </p> | 2311 </p> |
| 2305 </field> | 2312 </field> |
| 2306 <field name="targets"> | 2313 <field name="targets" optional="true"> |
| 2307 <list><ref>Element</ref></list> | 2314 <list><ref>Element</ref></list> |
| 2308 <p> | 2315 <p> |
| 2309 The elements to which the given region is bound. By | 2316 The elements to which the given region is bound. By |
| 2310 opening the declaration of the elements, clients can | 2317 opening the declaration of the elements, clients can |
| 2311 implement one form of navigation. | 2318 implement one form of navigation. |
| 2312 </p> | 2319 </p> |
| 2313 </field> | 2320 </field> |
| 2314 </object> | 2321 </object> |
| 2315 </type> | 2322 </type> |
| 2316 <type name="Occurrences"> | 2323 <type name="Occurrences"> |
| 2317 <p> | 2324 <p> |
| 2318 A description of the references to a single element within a | 2325 A description of the references to a single element within a |
| 2319 single file. | 2326 single file. |
| 2320 </p> | 2327 </p> |
| 2321 <object> | 2328 <object> |
| 2322 <field name="element"> | 2329 <field name="element"> |
| 2323 <ref>Element</ref> | 2330 <ref>Element</ref> |
| 2324 <p> | 2331 <p> |
| 2325 The element that was referenced. | 2332 The element that was referenced. |
| 2326 </p> | 2333 </p> |
| 2327 </field> | 2334 </field> |
| 2328 <field name="offsets"> | 2335 <field name="offsets" optional="true"> |
| 2329 <list><ref>int</ref></list> | 2336 <list><ref>int</ref></list> |
| 2330 <p> | 2337 <p> |
| 2331 The offsets of the name of the referenced element within | 2338 The offsets of the name of the referenced element within |
| 2332 the file. | 2339 the file. |
| 2333 </p> | 2340 </p> |
| 2334 </field> | 2341 </field> |
| 2335 <field name="length"> | 2342 <field name="length"> |
| 2336 <ref>int</ref> | 2343 <ref>int</ref> |
| 2337 <p> | 2344 <p> |
| 2338 The length of the name of the referenced element. | 2345 The length of the name of the referenced element. |
| (...skipping 261 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 2600 <field name="isPotential"> | 2607 <field name="isPotential"> |
| 2601 <ref>bool</ref> | 2608 <ref>bool</ref> |
| 2602 <p> | 2609 <p> |
| 2603 True if the result is a potential match but cannot be | 2610 True if the result is a potential match but cannot be |
| 2604 confirmed to be a match. For example, if all references to | 2611 confirmed to be a match. For example, if all references to |
| 2605 a method m defined in some class were requested, and a | 2612 a method m defined in some class were requested, and a |
| 2606 reference to a method m from an unknown class were found, | 2613 reference to a method m from an unknown class were found, |
| 2607 it would be marked as being a potential match. | 2614 it would be marked as being a potential match. |
| 2608 </p> | 2615 </p> |
| 2609 </field> | 2616 </field> |
| 2610 <field name="path"> | 2617 <field name="path" optional="true"> |
| 2611 <list><ref>Element</ref></list> | 2618 <list><ref>Element</ref></list> |
| 2612 <p> | 2619 <p> |
| 2613 The elements that contain the result, starting with the | 2620 The elements that contain the result, starting with the |
| 2614 most immediately enclosing ancestor and ending with the | 2621 most immediately enclosing ancestor and ending with the |
| 2615 library. | 2622 library. |
| 2616 </p> | 2623 </p> |
| 2617 </field> | 2624 </field> |
| 2618 </object> | 2625 </object> |
| 2619 </type> | 2626 </type> |
| 2620 <type name="SearchResultKind"> | 2627 <type name="SearchResultKind"> |
| (...skipping 59 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 2680 A description of a set of edits that implement a single | 2687 A description of a set of edits that implement a single |
| 2681 conceptual change. | 2688 conceptual change. |
| 2682 </p> | 2689 </p> |
| 2683 <object> | 2690 <object> |
| 2684 <field name="message"> | 2691 <field name="message"> |
| 2685 <ref>String</ref> | 2692 <ref>String</ref> |
| 2686 <p> | 2693 <p> |
| 2687 A human-readable description of the change to be applied. | 2694 A human-readable description of the change to be applied. |
| 2688 </p> | 2695 </p> |
| 2689 </field> | 2696 </field> |
| 2690 <field name="edits"> | 2697 <field name="edits" optional="true"> |
| 2691 <list><ref>SourceFileEdit</ref></list> | 2698 <list><ref>SourceFileEdit</ref></list> |
| 2692 <p> | 2699 <p> |
| 2693 A list of the edits used to effect the change, grouped by | 2700 A list of the edits used to effect the change, grouped by |
| 2694 file. | 2701 file. |
| 2695 </p> | 2702 </p> |
| 2696 </field> | 2703 </field> |
| 2697 <field name="linkedEditGroups"> | 2704 <field name="linkedEditGroups" optional="true"> |
| 2698 <list><ref>LinkedEditGroup</ref></list> | 2705 <list><ref>LinkedEditGroup</ref></list> |
| 2699 <p> | 2706 <p> |
| 2700 A list of the linked editing groups used to customize | 2707 A list of the linked editing groups used to customize |
| 2701 the changes that were made. | 2708 the changes that were made. |
| 2702 </p> | 2709 </p> |
| 2703 </field> | 2710 </field> |
| 2704 <field name="selection" optional="true"> | 2711 <field name="selection" optional="true"> |
| 2705 <ref>Position</ref> | 2712 <ref>Position</ref> |
| 2706 <p> | 2713 <p> |
| 2707 The position that should be selected after the edits | 2714 The position that should be selected after the edits |
| (...skipping 48 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 2756 <p> | 2763 <p> |
| 2757 A description of a set of changes to a single file. | 2764 A description of a set of changes to a single file. |
| 2758 </p> | 2765 </p> |
| 2759 <object> | 2766 <object> |
| 2760 <field name="file"> | 2767 <field name="file"> |
| 2761 <ref>FilePath</ref> | 2768 <ref>FilePath</ref> |
| 2762 <p> | 2769 <p> |
| 2763 The file containing the code to be modified. | 2770 The file containing the code to be modified. |
| 2764 </p> | 2771 </p> |
| 2765 </field> | 2772 </field> |
| 2766 <field name="edits"> | 2773 <field name="edits" optional="true"> |
| 2767 <list><ref>SourceEdit</ref></list> | 2774 <list><ref>SourceEdit</ref></list> |
| 2768 <p> | 2775 <p> |
| 2769 A list of the edits used to effect the change. | 2776 A list of the edits used to effect the change. |
| 2770 </p> | 2777 </p> |
| 2771 </field> | 2778 </field> |
| 2772 </object> | 2779 </object> |
| 2773 </type> | 2780 </type> |
| 2774 <type name="TypeHierarchyItem"> | 2781 <type name="TypeHierarchyItem"> |
| 2775 <p> | 2782 <p> |
| 2776 A representation of a class in a type hierarchy. | 2783 A representation of a class in a type hierarchy. |
| (...skipping 25 matching lines...) Expand all Loading... | |
| 2802 </p> | 2809 </p> |
| 2803 </field> | 2810 </field> |
| 2804 <field name="superclass" optional="true"> | 2811 <field name="superclass" optional="true"> |
| 2805 <ref>int</ref> | 2812 <ref>int</ref> |
| 2806 <p> | 2813 <p> |
| 2807 The index of the item representing the superclass of | 2814 The index of the item representing the superclass of |
| 2808 this class. This field will be omitted if this item | 2815 this class. This field will be omitted if this item |
| 2809 represents the class Object. | 2816 represents the class Object. |
| 2810 </p> | 2817 </p> |
| 2811 </field> | 2818 </field> |
| 2812 <field name="interfaces"> | 2819 <field name="interfaces" optional="true"> |
| 2813 <list><ref>int</ref></list> | 2820 <list><ref>int</ref></list> |
| 2814 <p> | 2821 <p> |
| 2815 The indexes of the items representing the interfaces | 2822 The indexes of the items representing the interfaces |
| 2816 implemented by this class. The list will be empty if | 2823 implemented by this class. The list will be empty if |
|
Brian Wilkerson
2014/08/22 15:12:45
"empty" --> "omitted"
| |
| 2817 there are no implemented interfaces. | 2824 there are no implemented interfaces. |
| 2818 </p> | 2825 </p> |
| 2819 </field> | 2826 </field> |
| 2820 <field name="mixins"> | 2827 <field name="mixins" optional="true"> |
| 2821 <list><ref>int</ref></list> | 2828 <list><ref>int</ref></list> |
| 2822 <p> | 2829 <p> |
| 2823 The indexes of the items representing the mixins | 2830 The indexes of the items representing the mixins |
| 2824 referenced by this class. The list will be empty if | 2831 referenced by this class. The list will be empty if |
|
Brian Wilkerson
2014/08/22 15:12:45
"empty" --> "omitted"
| |
| 2825 there are no classes mixed in to this class. | 2832 there are no classes mixed in to this class. |
| 2826 </p> | 2833 </p> |
| 2827 </field> | 2834 </field> |
| 2828 <field name="subclasses"> | 2835 <field name="subclasses" optional="true"> |
| 2829 <list><ref>int</ref></list> | 2836 <list><ref>int</ref></list> |
| 2830 <p> | 2837 <p> |
| 2831 The indexes of the items representing the subtypes of | 2838 The indexes of the items representing the subtypes of |
| 2832 this class. The list will be empty if there are no | 2839 this class. The list will be empty if there are no |
|
Brian Wilkerson
2014/08/22 15:12:45
"empty" --> "omitted"
| |
| 2833 subtypes or if this item represents a supertype of the | 2840 subtypes or if this item represents a supertype of the |
| 2834 pivot type. | 2841 pivot type. |
| 2835 </p> | 2842 </p> |
| 2836 </field> | 2843 </field> |
| 2837 </object> | 2844 </object> |
| 2838 </type> | 2845 </type> |
| 2839 </types> | 2846 </types> |
| 2840 <refactorings> | 2847 <refactorings> |
| 2841 <h2><a name="refactorings">Refactorings</a></h2> | 2848 <h2><a name="refactorings">Refactorings</a></h2> |
| 2842 <p> | 2849 <p> |
| (...skipping 30 matching lines...) Expand all Loading... | |
| 2873 <refactoring kind="EXTRACT_LOCAL_VARIABLE"> | 2880 <refactoring kind="EXTRACT_LOCAL_VARIABLE"> |
| 2874 <p> | 2881 <p> |
| 2875 Create a local variable initialized by a specified | 2882 Create a local variable initialized by a specified |
| 2876 expression. | 2883 expression. |
| 2877 </p> | 2884 </p> |
| 2878 <p> | 2885 <p> |
| 2879 It is an error if the range contains anything other than a | 2886 It is an error if the range contains anything other than a |
| 2880 complete expression (no partial expressions are allowed). | 2887 complete expression (no partial expressions are allowed). |
| 2881 </p> | 2888 </p> |
| 2882 <feedback> | 2889 <feedback> |
| 2883 <field name="names"> | 2890 <field name="names" optional="true"> |
| 2884 <list><ref>String</ref></list> | 2891 <list><ref>String</ref></list> |
| 2885 <p> | 2892 <p> |
| 2886 The proposed names for the local variable. | 2893 The proposed names for the local variable. |
| 2887 </p> | 2894 </p> |
| 2888 </field> | 2895 </field> |
| 2889 <field name="offsets"> | 2896 <field name="offsets" optional="true"> |
| 2890 <list><ref>int</ref></list> | 2897 <list><ref>int</ref></list> |
| 2891 <p> | 2898 <p> |
| 2892 The offsets of the expressions that would be replaced by | 2899 The offsets of the expressions that would be replaced by |
| 2893 a reference to the variable. | 2900 a reference to the variable. |
| 2894 </p> | 2901 </p> |
| 2895 </field> | 2902 </field> |
| 2896 <field name="lengths"> | 2903 <field name="lengths" optional="true"> |
| 2897 <list><ref>int</ref></list> | 2904 <list><ref>int</ref></list> |
| 2898 <p> | 2905 <p> |
| 2899 The lengths of the expressions that would be replaced by | 2906 The lengths of the expressions that would be replaced by |
| 2900 a reference to the variable. The lengths correspond to | 2907 a reference to the variable. The lengths correspond to |
| 2901 the offsets. In other words, for a given expression, if | 2908 the offsets. In other words, for a given expression, if |
| 2902 the offset of that expression is offsets[i], then the | 2909 the offset of that expression is offsets[i], then the |
| 2903 length of that expression is lengths[i]. | 2910 length of that expression is lengths[i]. |
| 2904 </p> | 2911 </p> |
| 2905 </field> | 2912 </field> |
| 2906 </feedback> | 2913 </feedback> |
| (...skipping 41 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 2948 The length of the expression or statements that will be | 2955 The length of the expression or statements that will be |
| 2949 extracted. | 2956 extracted. |
| 2950 </p> | 2957 </p> |
| 2951 </field> | 2958 </field> |
| 2952 <field name="returnType"> | 2959 <field name="returnType"> |
| 2953 <ref>String</ref> | 2960 <ref>String</ref> |
| 2954 <p> | 2961 <p> |
| 2955 The proposed return type for the method. | 2962 The proposed return type for the method. |
| 2956 </p> | 2963 </p> |
| 2957 </field> | 2964 </field> |
| 2958 <field name="names"> | 2965 <field name="names" optional="true"> |
| 2959 <list><ref>String</ref></list> | 2966 <list><ref>String</ref></list> |
| 2960 <p> | 2967 <p> |
| 2961 The proposed names for the method. | 2968 The proposed names for the method. |
| 2962 </p> | 2969 </p> |
| 2963 </field> | 2970 </field> |
| 2964 <field name="canCreateGetter"> | 2971 <field name="canCreateGetter"> |
| 2965 <ref>bool</ref> | 2972 <ref>bool</ref> |
| 2966 <p> | 2973 <p> |
| 2967 True if a getter could be created rather than a method. | 2974 True if a getter could be created rather than a method. |
| 2968 </p> | 2975 </p> |
| 2969 </field> | 2976 </field> |
| 2970 <field name="parameters"> | 2977 <field name="parameters" optional="true"> |
| 2971 <list><ref>RefactoringMethodParameter</ref></list> | 2978 <list><ref>RefactoringMethodParameter</ref></list> |
| 2972 <p> | 2979 <p> |
| 2973 The proposed parameters for the method. | 2980 The proposed parameters for the method. |
| 2974 </p> | 2981 </p> |
| 2975 </field> | 2982 </field> |
| 2976 <field name="occurrences"> | 2983 <field name="occurrences"> |
| 2977 <ref>int</ref> | 2984 <ref>int</ref> |
| 2978 <p> | 2985 <p> |
| 2979 The number of times the expression or statements occurs. | 2986 The number of times the expression or statements occurs. |
| 2980 </p> | 2987 </p> |
| 2981 </field> | 2988 </field> |
| 2982 <field name="offsets"> | 2989 <field name="offsets" optional="true"> |
| 2983 <list><ref>int</ref></list> | 2990 <list><ref>int</ref></list> |
| 2984 <p> | 2991 <p> |
| 2985 The offsets of the expressions or statements that would | 2992 The offsets of the expressions or statements that would |
| 2986 be replaced by an invocation of the method. | 2993 be replaced by an invocation of the method. |
| 2987 </p> | 2994 </p> |
| 2988 </field> | 2995 </field> |
| 2989 <field name="lengths"> | 2996 <field name="lengths" optional="true"> |
| 2990 <list><ref>int</ref></list> | 2997 <list><ref>int</ref></list> |
| 2991 <p> | 2998 <p> |
| 2992 The lengths of the expressions or statements that would | 2999 The lengths of the expressions or statements that would |
| 2993 be replaced by an invocation of the method. The lengths | 3000 be replaced by an invocation of the method. The lengths |
| 2994 correspond to the offsets. In other words, for a given | 3001 correspond to the offsets. In other words, for a given |
| 2995 expression (or block of statements), if the offset of | 3002 expression (or block of statements), if the offset of |
| 2996 that expression is offsets[i], then the length of that | 3003 that expression is offsets[i], then the length of that |
| 2997 expression is lengths[i]. | 3004 expression is lengths[i]. |
| 2998 </p> | 3005 </p> |
| 2999 </field> | 3006 </field> |
| (...skipping 12 matching lines...) Expand all Loading... | |
| 3012 method. It is an error if this field is true and the | 3019 method. It is an error if this field is true and the |
| 3013 list of parameters is non-empty. | 3020 list of parameters is non-empty. |
| 3014 </p> | 3021 </p> |
| 3015 </field> | 3022 </field> |
| 3016 <field name="name"> | 3023 <field name="name"> |
| 3017 <ref>String</ref> | 3024 <ref>String</ref> |
| 3018 <p> | 3025 <p> |
| 3019 The name that the method should be given. | 3026 The name that the method should be given. |
| 3020 </p> | 3027 </p> |
| 3021 </field> | 3028 </field> |
| 3022 <field name="parameters"> | 3029 <field name="parameters" optional="true"> |
| 3023 <list><ref>RefactoringMethodParameter</ref></list> | 3030 <list><ref>RefactoringMethodParameter</ref></list> |
| 3024 <p> | 3031 <p> |
| 3025 The parameters that should be defined for the method. | 3032 The parameters that should be defined for the method. |
| 3026 <p> | 3033 <p> |
| 3027 It is an error if a REQUIRED or NAMED parameter follows a | 3034 It is an error if a REQUIRED or NAMED parameter follows a |
| 3028 POSITIONAL parameter. | 3035 POSITIONAL parameter. |
| 3029 It is an error if a REQUIRED or POSITIONAL parameter follows a | 3036 It is an error if a REQUIRED or POSITIONAL parameter follows a |
| 3030 NAMED parameter. | 3037 NAMED parameter. |
| 3031 </p> | 3038 </p> |
| 3032 <ul> | 3039 <ul> |
| (...skipping 95 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 3128 <h2>Errors</h2> | 3135 <h2>Errors</h2> |
| 3129 <p> | 3136 <p> |
| 3130 This section contains a list of all of the errors that are | 3137 This section contains a list of all of the errors that are |
| 3131 produced by the server and the data that is returned with each. | 3138 produced by the server and the data that is returned with each. |
| 3132 </p> | 3139 </p> |
| 3133 <p> | 3140 <p> |
| 3134 TBD | 3141 TBD |
| 3135 </p> | 3142 </p> |
| 3136 </body> | 3143 </body> |
| 3137 </html> | 3144 </html> |
| OLD | NEW |
