| 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 1198 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1209 </p> | 1209 </p> |
| 1210 </field> | 1210 </field> |
| 1211 </params> | 1211 </params> |
| 1212 </notification> | 1212 </notification> |
| 1213 </domain> | 1213 </domain> |
| 1214 <domain name="edit"> | 1214 <domain name="edit"> |
| 1215 <p> | 1215 <p> |
| 1216 The edit domain contains commands related to edits that can be | 1216 The edit domain contains commands related to edits that can be |
| 1217 applied to the code. | 1217 applied to the code. |
| 1218 </p> | 1218 </p> |
| 1219 <request method="format"> |
| 1220 <p> |
| 1221 Format the contents of a single file. The currently selected region of |
| 1222 text is passed in so that the selection can be preserved across the |
| 1223 formatting operation. The updated selection will be as close to |
| 1224 matching the original as possible, but whitespace at the beginning or |
| 1225 end of the selected region will be ignored. |
| 1226 </p> |
| 1227 <params> |
| 1228 <field name="file"> |
| 1229 <ref>FilePath</ref> |
| 1230 <p> |
| 1231 The file containing the code to be formatted. |
| 1232 </p> |
| 1233 </field> |
| 1234 <field name="selectionOffset"> |
| 1235 <ref>int</ref> |
| 1236 <p> |
| 1237 The offset of the current selection in the file. |
| 1238 </p> |
| 1239 </field> |
| 1240 <field name="selectionLength"> |
| 1241 <ref>int</ref> |
| 1242 <p> |
| 1243 The length of the current selection in the file. |
| 1244 </p> |
| 1245 </field> |
| 1246 <!-- |
| 1247 <field name="selectionOnly" optional="true"> |
| 1248 <ref>bool</ref> |
| 1249 <p> |
| 1250 True if the code to be formatted should be limited to the selected |
| 1251 text (or the smallest portion of text that encloses the selected |
| 1252 text that can be formatted). |
| 1253 </p> |
| 1254 </field> |
| 1255 --> |
| 1256 </params> |
| 1257 <result> |
| 1258 <field name="edits"> |
| 1259 <list><ref>SourceEdit</ref></list> |
| 1260 <p> |
| 1261 The edit(s) to be applied in order to format the code. The list |
| 1262 will be empty if the code was already formatted (there are no |
| 1263 changes). |
| 1264 </p> |
| 1265 </field> |
| 1266 <field name="selectionOffset"> |
| 1267 <ref>int</ref> |
| 1268 <p> |
| 1269 The offset of the selection after formatting the code. |
| 1270 </p> |
| 1271 </field> |
| 1272 <field name="selectionLength"> |
| 1273 <ref>int</ref> |
| 1274 <p> |
| 1275 The length of the selection after formatting the code. |
| 1276 </p> |
| 1277 </field> |
| 1278 </result> |
| 1279 </request> |
| 1219 <request method="getAssists"> | 1280 <request method="getAssists"> |
| 1220 <p> | 1281 <p> |
| 1221 Return the set of assists that are available at the given | 1282 Return the set of assists that are available at the given |
| 1222 location. An assist is distinguished from a refactoring | 1283 location. An assist is distinguished from a refactoring |
| 1223 primarily by the fact that it affects a single file and does | 1284 primarily by the fact that it affects a single file and does |
| 1224 not require user input in order to be performed. | 1285 not require user input in order to be performed. |
| 1225 </p> | 1286 </p> |
| 1226 <params> | 1287 <params> |
| 1227 <field name="file"> | 1288 <field name="file"> |
| 1228 <ref>FilePath</ref> | 1289 <ref>FilePath</ref> |
| (...skipping 2398 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 3627 <h2>Errors</h2> | 3688 <h2>Errors</h2> |
| 3628 <p> | 3689 <p> |
| 3629 This section contains a list of all of the errors that are | 3690 This section contains a list of all of the errors that are |
| 3630 produced by the server and the data that is returned with each. | 3691 produced by the server and the data that is returned with each. |
| 3631 </p> | 3692 </p> |
| 3632 <p> | 3693 <p> |
| 3633 TBD | 3694 TBD |
| 3634 </p> | 3695 </p> |
| 3635 </body> | 3696 </body> |
| 3636 </html> | 3697 </html> |
| OLD | NEW |