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.9.0</version></h1> | 9 <h1 style="color:#999999">Version <version>1.10.0</version></h1> |
10 <p> | 10 <p> |
11 This document contains a specification of the API provided by the | 11 This document contains a specification of the API provided by the |
12 analysis server. The API in this document is currently under | 12 analysis server. The API in this document is currently under |
13 development. Changes to the API will be accompanied by an update to the | 13 development. Changes to the API will be accompanied by an update to the |
14 protocol version number according to the principles of semantic | 14 protocol version number according to the principles of semantic |
15 versioning <a href="http://semver.org/">http://semver.org/</a>. | 15 versioning <a href="http://semver.org/">http://semver.org/</a>. |
16 </p> | 16 </p> |
17 <h2>Overview</h2> | 17 <h2>Overview</h2> |
18 <p> | 18 <p> |
19 The analysis server API is a bi-directional client-server | 19 The analysis server API is a bi-directional client-server |
(...skipping 1017 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1037 the list of services passed in an analysis.setSubscriptions | 1037 the list of services passed in an analysis.setSubscriptions |
1038 request. | 1038 request. |
1039 </p> | 1039 </p> |
1040 <params> | 1040 <params> |
1041 <field name="file"> | 1041 <field name="file"> |
1042 <ref>FilePath</ref> | 1042 <ref>FilePath</ref> |
1043 <p> | 1043 <p> |
1044 The file with which the outline is associated. | 1044 The file with which the outline is associated. |
1045 </p> | 1045 </p> |
1046 </field> | 1046 </field> |
| 1047 <field name="kind"> |
| 1048 <ref>FileKind</ref> |
| 1049 <p> |
| 1050 The kind of the file. |
| 1051 </p> |
| 1052 </field> |
| 1053 <field name="libraryName" optional="true"> |
| 1054 <ref>String</ref> |
| 1055 <p> |
| 1056 The name of the library defined by the file using a "library" |
| 1057 directive, or referenced by a "part of" directive. If both |
| 1058 "library" and "part of" directives are present, then the |
| 1059 "library" directive takes precedence. |
| 1060 This field will be omitted if the file has neither "library" |
| 1061 nor "part of" directives. |
| 1062 </p> |
| 1063 </field> |
1047 <field name="outline"> | 1064 <field name="outline"> |
1048 <ref>Outline</ref> | 1065 <ref>Outline</ref> |
1049 <p> | 1066 <p> |
1050 The outline associated with the file. | 1067 The outline associated with the file. |
1051 </p> | 1068 </p> |
1052 </field> | 1069 </field> |
1053 </params> | 1070 </params> |
1054 </notification> | 1071 </notification> |
1055 <notification event="overrides"> | 1072 <notification event="overrides"> |
1056 <p> | 1073 <p> |
(...skipping 1487 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2544 </type> | 2561 </type> |
2545 <type name="ExecutionService"> | 2562 <type name="ExecutionService"> |
2546 <p> | 2563 <p> |
2547 An enumeration of the services provided by the execution | 2564 An enumeration of the services provided by the execution |
2548 domain. | 2565 domain. |
2549 </p> | 2566 </p> |
2550 <enum> | 2567 <enum> |
2551 <value><code>LAUNCH_DATA</code></value> | 2568 <value><code>LAUNCH_DATA</code></value> |
2552 </enum> | 2569 </enum> |
2553 </type> | 2570 </type> |
| 2571 <type name="FileKind"> |
| 2572 <p> |
| 2573 An enumeration of the kinds of files. |
| 2574 </p> |
| 2575 <enum> |
| 2576 <value><code>LIBRARY</code></value> |
| 2577 <value><code>PART</code></value> |
| 2578 </enum> |
| 2579 </type> |
2554 <type name="FilePath"> | 2580 <type name="FilePath"> |
2555 <ref>String</ref> | 2581 <ref>String</ref> |
2556 <p> | 2582 <p> |
2557 The absolute path of a file. | 2583 The absolute path of a file. |
2558 </p> | 2584 </p> |
2559 </type> | 2585 </type> |
2560 <type name="FoldingKind"> | 2586 <type name="FoldingKind"> |
2561 <p> | 2587 <p> |
2562 An enumeration of the kinds of folding regions. | 2588 An enumeration of the kinds of folding regions. |
2563 </p> | 2589 </p> |
(...skipping 1748 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4312 This section contains a list of all of the errors that are | 4338 This section contains a list of all of the errors that are |
4313 produced by the server and the data that is returned with each. | 4339 produced by the server and the data that is returned with each. |
4314 </p> | 4340 </p> |
4315 <p> | 4341 <p> |
4316 TBD | 4342 TBD |
4317 </p> | 4343 </p> |
4318 <h2 class="domain"><a name="index">Index</a></h2> | 4344 <h2 class="domain"><a name="index">Index</a></h2> |
4319 <index></index> | 4345 <index></index> |
4320 </body> | 4346 </body> |
4321 </html> | 4347 </html> |
OLD | NEW |