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.18.0</version></h1> | 9 <h1 style="color:#999999">Version <version>1.18.0</version></h1> |
10 <p> | 10 <p> |
(...skipping 153 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
164 <p> | 164 <p> |
165 Clients are strongly encouraged to provide this information in | 165 Clients are strongly encouraged to provide this information in |
166 order to improve the quality of information that can be provided | 166 order to improve the quality of information that can be provided |
167 to them. | 167 to them. |
168 </p> | 168 </p> |
169 </dd> | 169 </dd> |
170 </dl> | 170 </dl> |
171 <dl> | 171 <dl> |
172 <dt>--no-error-notification</dt> | 172 <dt>--no-error-notification</dt> |
173 <dd> | 173 <dd> |
174 Disable notifications about errors (see analysis.error). If this | 174 <p><b>Deprecated</b></p> |
175 flag is not specified then notifications will be sent for all | 175 Disable notifications about errors (see analysis.error). If this |
176 errors produced for all files in the actual analysis roots. | 176 flag is not specified then notifications will be sent for all |
| 177 errors produced for all files in the actual analysis roots. |
177 </dd> | 178 </dd> |
178 </dl> | 179 </dl> |
179 <dl> | 180 <dl> |
180 <dt>--no-index</dt> | 181 <dt>--no-index</dt> |
181 <dd> | 182 <dd> |
182 Disable the server from generating an index. If this flag is passed and an | 183 Disable the server from generating an index. If this flag is passed and an |
183 API is used that requires an index, then an error, <tt>NO_INDEX_GENERATED<
/tt>, | 184 API is used that requires an index, then an error, <tt>NO_INDEX_GENERATED<
/tt>, |
184 will be thrown. The set of API calls that require an index include: | 185 will be thrown. The set of API calls that require an index include: |
185 refactoring calls, code completions and searching. | 186 refactoring calls, code completions and searching. |
186 <!-- TODO(jwren/scheglov): make sure that this list of APIs that is comple
te. --> | 187 <!-- TODO(jwren/scheglov): make sure that this list of APIs that is comple
te. --> |
(...skipping 657 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
844 </p> | 845 </p> |
845 </field> | 846 </field> |
846 </params> | 847 </params> |
847 </notification> | 848 </notification> |
848 <notification event="errors"> | 849 <notification event="errors"> |
849 <p> | 850 <p> |
850 Reports the errors associated with a given file. The set of | 851 Reports the errors associated with a given file. The set of |
851 errors included in the notification is always a complete | 852 errors included in the notification is always a complete |
852 list that supersedes any previously reported errors. | 853 list that supersedes any previously reported errors. |
853 </p> | 854 </p> |
854 <p> | |
855 It is only possible to unsubscribe from this notification by | |
856 using the command-line flag --no-error-notification. | |
857 </p> | |
858 <params> | 855 <params> |
859 <field name="file"> | 856 <field name="file"> |
860 <ref>FilePath</ref> | 857 <ref>FilePath</ref> |
861 <p> | 858 <p> |
862 The file containing the errors. | 859 The file containing the errors. |
863 </p> | 860 </p> |
864 </field> | 861 </field> |
865 <field name="errors"> | 862 <field name="errors"> |
866 <list><ref>AnalysisError</ref></list> | 863 <list><ref>AnalysisError</ref></list> |
867 <p> | 864 <p> |
(...skipping 3715 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4583 This section contains a list of all of the errors that are | 4580 This section contains a list of all of the errors that are |
4584 produced by the server and the data that is returned with each. | 4581 produced by the server and the data that is returned with each. |
4585 </p> | 4582 </p> |
4586 <p> | 4583 <p> |
4587 TODO: TBD | 4584 TODO: TBD |
4588 </p> | 4585 </p> |
4589 <h2 class="domain"><a name="index">Index</a></h2> | 4586 <h2 class="domain"><a name="index">Index</a></h2> |
4590 <index></index> | 4587 <index></index> |
4591 </body> | 4588 </body> |
4592 </html> | 4589 </html> |
OLD | NEW |