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 <version>1.12.0</version></h1> | 9 <h1 style="color:#999999">Version <version>1.12.0</version></h1> |
10 <p> | 10 <p> |
(...skipping 1053 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1064 <field name="outline"> | 1064 <field name="outline"> |
1065 <ref>Outline</ref> | 1065 <ref>Outline</ref> |
1066 <p> | 1066 <p> |
1067 The outline associated with the file. | 1067 The outline associated with the file. |
1068 </p> | 1068 </p> |
1069 </field> | 1069 </field> |
1070 </params> | 1070 </params> |
1071 </notification> | 1071 </notification> |
1072 <notification event="overrides"> | 1072 <notification event="overrides"> |
1073 <p> | 1073 <p> |
1074 Reports the overridding members in a file. | 1074 Reports the overriding members in a file. |
1075 </p> | 1075 </p> |
1076 <p> | 1076 <p> |
1077 This notification is not subscribed to by default. Clients | 1077 This notification is not subscribed to by default. Clients |
1078 can subscribe by including the value <tt>"OVERRIDES"</tt> in | 1078 can subscribe by including the value <tt>"OVERRIDES"</tt> in |
1079 the list of services passed in an analysis.setSubscriptions | 1079 the list of services passed in an analysis.setSubscriptions |
1080 request. | 1080 request. |
1081 </p> | 1081 </p> |
1082 <params> | 1082 <params> |
1083 <field name="file"> | 1083 <field name="file"> |
1084 <ref>FilePath</ref> | 1084 <ref>FilePath</ref> |
(...skipping 680 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1765 </p> | 1765 </p> |
1766 <p> | 1766 <p> |
1767 If a request is made for a file that does not exist, does not belong | 1767 If a request is made for a file that does not exist, does not belong |
1768 to an analysis root or is not a Dart file, | 1768 to an analysis root or is not a Dart file, |
1769 <tt>FILE_NOT_ANALYZED</tt> will be generated. | 1769 <tt>FILE_NOT_ANALYZED</tt> will be generated. |
1770 </p> | 1770 </p> |
1771 <p> | 1771 <p> |
1772 If directives of the Dart file cannot be organized, for example | 1772 If directives of the Dart file cannot be organized, for example |
1773 because it has scan or parse errors, or by other reasons, | 1773 because it has scan or parse errors, or by other reasons, |
1774 <tt>ORGANIZE_DIRECTIVES_ERROR</tt> will be generated. The message | 1774 <tt>ORGANIZE_DIRECTIVES_ERROR</tt> will be generated. The message |
1775 will provide datails about the reason. | 1775 will provide details about the reason. |
1776 </p> | 1776 </p> |
1777 <params> | 1777 <params> |
1778 <field name="file"> | 1778 <field name="file"> |
1779 <ref>FilePath</ref> | 1779 <ref>FilePath</ref> |
1780 <p> | 1780 <p> |
1781 The Dart file to organize directives in. | 1781 The Dart file to organize directives in. |
1782 </p> | 1782 </p> |
1783 </field> | 1783 </field> |
1784 </params> | 1784 </params> |
1785 <result> | 1785 <result> |
(...skipping 338 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2124 <ref>bool</ref> | 2124 <ref>bool</ref> |
2125 <p><b><i>Deprecated</i></b>: this feature is always enabled.</p> | 2125 <p><b><i>Deprecated</i></b>: this feature is always enabled.</p> |
2126 <p> | 2126 <p> |
2127 True if the client wants to enable support for the | 2127 True if the client wants to enable support for the |
2128 proposed "null aware operators" feature. | 2128 proposed "null aware operators" feature. |
2129 </p> | 2129 </p> |
2130 </field> | 2130 </field> |
2131 <field name="enableSuperMixins" optional="true"> | 2131 <field name="enableSuperMixins" optional="true"> |
2132 <ref>bool</ref> | 2132 <ref>bool</ref> |
2133 <p> | 2133 <p> |
2134 True if the client wants to enable spport for the | 2134 True if the client wants to enable support for the |
2135 proposed "less restricted mixins" proposal (DEP 34). | 2135 proposed "less restricted mixins" proposal (DEP 34). |
2136 </p> | 2136 </p> |
2137 </field> | 2137 </field> |
2138 <field name="generateDart2jsHints" optional="true"> | 2138 <field name="generateDart2jsHints" optional="true"> |
2139 <ref>bool</ref> | 2139 <ref>bool</ref> |
2140 <p> | 2140 <p> |
2141 True if hints that are specific to dart2js should be | 2141 True if hints that are specific to dart2js should be |
2142 generated. This option is ignored if generateHints is false. | 2142 generated. This option is ignored if generateHints is false. |
2143 </p> | 2143 </p> |
2144 </field> | 2144 </field> |
(...skipping 369 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2514 An enumeration of the kinds of elements. | 2514 An enumeration of the kinds of elements. |
2515 </p> | 2515 </p> |
2516 <enum> | 2516 <enum> |
2517 <value><code>CLASS</code></value> | 2517 <value><code>CLASS</code></value> |
2518 <value><code>CLASS_TYPE_ALIAS</code></value> | 2518 <value><code>CLASS_TYPE_ALIAS</code></value> |
2519 <value><code>COMPILATION_UNIT</code></value> | 2519 <value><code>COMPILATION_UNIT</code></value> |
2520 <value><code>CONSTRUCTOR</code></value> | 2520 <value><code>CONSTRUCTOR</code></value> |
2521 <value><code>ENUM</code></value> | 2521 <value><code>ENUM</code></value> |
2522 <value><code>ENUM_CONSTANT</code></value> | 2522 <value><code>ENUM_CONSTANT</code></value> |
2523 <value><code>FIELD</code></value> | 2523 <value><code>FIELD</code></value> |
| 2524 <value><code>FILE</code></value> |
2524 <value><code>FUNCTION</code></value> | 2525 <value><code>FUNCTION</code></value> |
2525 <value><code>FUNCTION_TYPE_ALIAS</code></value> | 2526 <value><code>FUNCTION_TYPE_ALIAS</code></value> |
2526 <value><code>GETTER</code></value> | 2527 <value><code>GETTER</code></value> |
2527 <value><code>LABEL</code></value> | 2528 <value><code>LABEL</code></value> |
2528 <value><code>LIBRARY</code></value> | 2529 <value><code>LIBRARY</code></value> |
2529 <value><code>LOCAL_VARIABLE</code></value> | 2530 <value><code>LOCAL_VARIABLE</code></value> |
2530 <value><code>METHOD</code></value> | 2531 <value><code>METHOD</code></value> |
2531 <value><code>PARAMETER</code></value> | 2532 <value><code>PARAMETER</code></value> |
2532 <value><code>PREFIX</code></value> | 2533 <value><code>PREFIX</code></value> |
2533 <value><code>SETTER</code></value> | 2534 <value><code>SETTER</code></value> |
(...skipping 365 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2899 </enum> | 2900 </enum> |
2900 </type> | 2901 </type> |
2901 <type name="HoverInformation"> | 2902 <type name="HoverInformation"> |
2902 <p> | 2903 <p> |
2903 The hover information associated with a specific location. | 2904 The hover information associated with a specific location. |
2904 </p> | 2905 </p> |
2905 <object> | 2906 <object> |
2906 <field name="offset"> | 2907 <field name="offset"> |
2907 <ref>int</ref> | 2908 <ref>int</ref> |
2908 <p> | 2909 <p> |
2909 The offset of the range of characters that encompases the | 2910 The offset of the range of characters that encompasses the |
2910 cursor position and has the same hover information as the | 2911 cursor position and has the same hover information as the |
2911 cursor position. | 2912 cursor position. |
2912 </p> | 2913 </p> |
2913 </field> | 2914 </field> |
2914 <field name="length"> | 2915 <field name="length"> |
2915 <ref>int</ref> | 2916 <ref>int</ref> |
2916 <p> | 2917 <p> |
2917 The length of the range of characters that encompases the | 2918 The length of the range of characters that encompasses the |
2918 cursor position and has the same hover information as the | 2919 cursor position and has the same hover information as the |
2919 cursor position. | 2920 cursor position. |
2920 </p> | 2921 </p> |
2921 </field> | 2922 </field> |
2922 <field name="containingLibraryPath" optional="true"> | 2923 <field name="containingLibraryPath" optional="true"> |
2923 <ref>String</ref> | 2924 <ref>String</ref> |
2924 <p> | 2925 <p> |
2925 The path to the defining compilation unit of the library | 2926 The path to the defining compilation unit of the library |
2926 in which the referenced element is declared. This data is | 2927 in which the referenced element is declared. This data is |
2927 omitted if there is no referenced element, or if the | 2928 omitted if there is no referenced element, or if the |
(...skipping 758 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3686 API reaches version 1.0. | 3687 API reaches version 1.0. |
3687 </p> | 3688 </p> |
3688 <!-- TODO(paulberry): remove this error and the code that | 3689 <!-- TODO(paulberry): remove this error and the code that |
3689 generates it. --> | 3690 generates it. --> |
3690 </value> | 3691 </value> |
3691 <value> | 3692 <value> |
3692 <code>UNKNOWN_REQUEST</code> | 3693 <code>UNKNOWN_REQUEST</code> |
3693 <p> | 3694 <p> |
3694 A request was received which the analysis server does | 3695 A request was received which the analysis server does |
3695 not recognize, or cannot handle in its current | 3696 not recognize, or cannot handle in its current |
3696 configuation. | 3697 configuration. |
3697 </p> | 3698 </p> |
3698 </value> | 3699 </value> |
3699 <value> | 3700 <value> |
3700 <code>UNKNOWN_SOURCE</code> | 3701 <code>UNKNOWN_SOURCE</code> |
3701 <p> | 3702 <p> |
3702 The analysis server was requested to perform an action | 3703 The analysis server was requested to perform an action |
3703 on a source that does not exist. | 3704 on a source that does not exist. |
3704 </p> | 3705 </p> |
3705 </value> | 3706 </value> |
3706 <value> | 3707 <value> |
(...skipping 660 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4367 This section contains a list of all of the errors that are | 4368 This section contains a list of all of the errors that are |
4368 produced by the server and the data that is returned with each. | 4369 produced by the server and the data that is returned with each. |
4369 </p> | 4370 </p> |
4370 <p> | 4371 <p> |
4371 TBD | 4372 TBD |
4372 </p> | 4373 </p> |
4373 <h2 class="domain"><a name="index">Index</a></h2> | 4374 <h2 class="domain"><a name="index">Index</a></h2> |
4374 <index></index> | 4375 <index></index> |
4375 </body> | 4376 </body> |
4376 </html> | 4377 </html> |
OLD | NEW |