Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(73)

Side by Side Diff: pkg/analysis_server/doc/api.html

Issue 1099633004: Fix error handling for formatting and update the spec (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Created 5 years, 8 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
OLDNEW
1 <html><head> 1 <html><head>
2 <meta charset="UTF-8"> 2 <meta charset="UTF-8">
3 <title>Analysis Server API Specification</title> 3 <title>Analysis Server API Specification</title>
4 <style>body { 4 <style>body {
5 font-family: sans-serif, serif; 5 font-family: sans-serif, serif;
6 padding-left: 5%; 6 padding-left: 5%;
7 padding-right: 5%; 7 padding-right: 5%;
8 } 8 }
9 h1 { 9 h1 {
10 text-align: center; 10 text-align: center;
(...skipping 1527 matching lines...) Expand 10 before | Expand all | Expand 10 after
1538 <p> 1538 <p>
1539 Format the contents of a single file. The currently selected region of 1539 Format the contents of a single file. The currently selected region of
1540 text is passed in so that the selection can be preserved across the 1540 text is passed in so that the selection can be preserved across the
1541 formatting operation. The updated selection will be as close to 1541 formatting operation. The updated selection will be as close to
1542 matching the original as possible, but whitespace at the beginning or 1542 matching the original as possible, but whitespace at the beginning or
1543 end of the selected region will be ignored. If preserving selection 1543 end of the selected region will be ignored. If preserving selection
1544 information is not required, zero (0) can be specified for both the 1544 information is not required, zero (0) can be specified for both the
1545 selection offset and selection length. 1545 selection offset and selection length.
1546 </p> 1546 </p>
1547 <p> 1547 <p>
1548 If a request is made for a file which does not exist, or 1548 If a request is made for a file which does not exist, or which is not
1549 which is not currently subject to analysis (e.g. because it 1549 currently subject to analysis (e.g. because it is not associated with
1550 is not associated with any analysis root specified to 1550 any analysis root specified to analysis.setAnalysisRoots), an error of
1551 analysis.setAnalysisRoots), an error of type 1551 type <tt>FORMAT_INVALID_FILE</tt> will be generated. If the source
1552 <tt>FORMAT_INVALID_FILE</tt> will be generated. 1552 contains syntax errors, an error of type <tt>FORMAT_WITH_ERRORS</tt>
1553 will be generated.
1553 </p> 1554 </p>
1554 1555
1555 1556
1556 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd> 1557 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>
1557 1558
1558 <p> 1559 <p>
1559 The file containing the code to be formatted. 1560 The file containing the code to be formatted.
1560 </p> 1561 </p>
1561 </dd><dt class="field"><b><i>selectionOffset ( int )</i></b></dt><dd> 1562 </dd><dt class="field"><b><i>selectionOffset ( int )</i></b></dt><dd>
1562 1563
(...skipping 1571 matching lines...) Expand 10 before | Expand all | Expand 10 after
3134 An "analysis.getErrors" or "analysis.getNavigation" request could 3135 An "analysis.getErrors" or "analysis.getNavigation" request could
3135 not be satisfied because the content of the file changed before 3136 not be satisfied because the content of the file changed before
3136 the requested results could be computed. 3137 the requested results could be computed.
3137 </p> 3138 </p>
3138 </dd><dt class="value">FORMAT_INVALID_FILE</dt><dd> 3139 </dd><dt class="value">FORMAT_INVALID_FILE</dt><dd>
3139 3140
3140 <p> 3141 <p>
3141 An "edit.format" request specified a FilePath 3142 An "edit.format" request specified a FilePath
3142 which does not match a Dart file in an analysis root. 3143 which does not match a Dart file in an analysis root.
3143 </p> 3144 </p>
3145 </dd><dt class="value">FORMAT_WITH_ERRORS</dt><dd>
3146
3147 <p>
3148 An "edit.format" request specified a file that contains syntax
3149 errors.
3150 </p>
3144 </dd><dt class="value">GET_ERRORS_INVALID_FILE</dt><dd> 3151 </dd><dt class="value">GET_ERRORS_INVALID_FILE</dt><dd>
3145 3152
3146 <p> 3153 <p>
3147 An "analysis.getErrors" request specified a FilePath 3154 An "analysis.getErrors" request specified a FilePath
3148 which does not match a file currently subject to 3155 which does not match a file currently subject to
3149 analysis. 3156 analysis.
3150 </p> 3157 </p>
3151 </dd><dt class="value">INVALID_ANALYSIS_ROOT</dt><dd> 3158 </dd><dt class="value">INVALID_ANALYSIS_ROOT</dt><dd>
3152 3159
3153 <p> 3160 <p>
(...skipping 648 matching lines...) Expand 10 before | Expand all | Expand 10 after
3802 <p> 3809 <p>
3803 This section contains a list of all of the errors that are 3810 This section contains a list of all of the errors that are
3804 produced by the server and the data that is returned with each. 3811 produced by the server and the data that is returned with each.
3805 </p> 3812 </p>
3806 <p> 3813 <p>
3807 TBD 3814 TBD
3808 </p> 3815 </p>
3809 3816
3810 3817
3811 </body></html> 3818 </body></html>
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698