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

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

Issue 541823004: Decode RefactoringFeedback automatically. (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Created 6 years, 3 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 1387 matching lines...) Expand 10 before | Expand all | Expand 10 after
1398 "<b>offset</b>": int 1398 "<b>offset</b>": int
1399 "<b>length</b>": int 1399 "<b>length</b>": int
1400 "<b>validateOnly</b>": bool 1400 "<b>validateOnly</b>": bool
1401 "<b>options</b>": <span style="color:#999999">optional</span> <a href="#type _RefactoringOptions">RefactoringOptions</a> 1401 "<b>options</b>": <span style="color:#999999">optional</span> <a href="#type _RefactoringOptions">RefactoringOptions</a>
1402 } 1402 }
1403 }</pre><br><pre>response: { 1403 }</pre><br><pre>response: {
1404 "id": String 1404 "id": String
1405 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 1405 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
1406 "result": { 1406 "result": {
1407 "<b>problems</b>": List&lt;<a href="#type_RefactoringProblem">RefactoringPro blem</a>&gt; 1407 "<b>problems</b>": List&lt;<a href="#type_RefactoringProblem">RefactoringPro blem</a>&gt;
1408 "<b>feedback</b>": <span style="color:#999999">optional</span> object 1408 "<b>feedback</b>": <span style="color:#999999">optional</span> <a href="#typ e_RefactoringFeedback">RefactoringFeedback</a>
1409 "<b>change</b>": <span style="color:#999999">optional</span> <a href="#type_ SourceChange">SourceChange</a> 1409 "<b>change</b>": <span style="color:#999999">optional</span> <a href="#type_ SourceChange">SourceChange</a>
1410 "<b>potentialEdits</b>": <span style="color:#999999">optional</span> List&lt ;String&gt; 1410 "<b>potentialEdits</b>": <span style="color:#999999">optional</span> List&lt ;String&gt;
1411 } 1411 }
1412 }</pre></div> 1412 }</pre></div>
1413 <p> 1413 <p>
1414 Get the changes required to perform a refactoring. 1414 Get the changes required to perform a refactoring.
1415 </p> 1415 </p>
1416 1416
1417 1417
1418 <h4>Parameters</h4><dl><dt class="field"><b><i>kind ( <a href="#type_Refac toringKind">RefactoringKind</a> )</i></b></dt><dd> 1418 <h4>Parameters</h4><dl><dt class="field"><b><i>kind ( <a href="#type_Refac toringKind">RefactoringKind</a> )</i></b></dt><dd>
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after
1452 “Options”. This field can be omitted if the refactoring 1452 “Options”. This field can be omitted if the refactoring
1453 does not require any options or if the values of those 1453 does not require any options or if the values of those
1454 options are not known. 1454 options are not known.
1455 </p> 1455 </p>
1456 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>problems ( List& lt;<a href="#type_RefactoringProblem">RefactoringProblem</a>&gt; )</i></b></dt>< dd> 1456 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>problems ( List& lt;<a href="#type_RefactoringProblem">RefactoringProblem</a>&gt; )</i></b></dt>< dd>
1457 1457
1458 <p> 1458 <p>
1459 The status of the refactoring. The array will be empty 1459 The status of the refactoring. The array will be empty
1460 if there are no known problems. 1460 if there are no known problems.
1461 </p> 1461 </p>
1462 </dd><dt class="field"><b><i>feedback ( <span style="color:#999999">op tional</span> object )</i></b></dt><dd> 1462 </dd><dt class="field"><b><i>feedback ( <span style="color:#999999">op tional</span> <a href="#type_RefactoringFeedback">RefactoringFeedback</a> )</i>< /b></dt><dd>
1463 1463
1464 <p> 1464 <p>
1465 Data used to provide feedback to the user. The structure 1465 Data used to provide feedback to the user. The structure
1466 of the data is dependent on the kind of refactoring 1466 of the data is dependent on the kind of refactoring
1467 being created. The data that is returned is documented 1467 being created. The data that is returned is documented
1468 in the section titled <a href="#refactorings">Refactorings</a>, la beled as 1468 in the section titled <a href="#refactorings">Refactorings</a>, la beled as
1469 “Feedback”. 1469 “Feedback”.
1470 </p> 1470 </p>
1471 </dd><dt class="field"><b><i>change ( <span style="color:#999999">opti onal</span> <a href="#type_SourceChange">SourceChange</a> )</i></b></dt><dd> 1471 </dd><dt class="field"><b><i>change ( <span style="color:#999999">opti onal</span> <a href="#type_SourceChange">SourceChange</a> )</i></b></dt><dd>
1472 1472
(...skipping 251 matching lines...) Expand 10 before | Expand all | Expand 10 after
1724 1724
1725 1725
1726 1726
1727 1727
1728 1728
1729 1729
1730 1730
1731 1731
1732 1732
1733 1733
1734
1734 <dl><dt class="typeDefinition"><a name="type_AddContentOverlay">AddContentOv erlay: object</a></dt><dd> 1735 <dl><dt class="typeDefinition"><a name="type_AddContentOverlay">AddContentOv erlay: object</a></dt><dd>
1735 <p> 1736 <p>
1736 A directive to begin overlaying the contents of a file. The 1737 A directive to begin overlaying the contents of a file. The
1737 supplied content will be used for analysis in place of the 1738 supplied content will be used for analysis in place of the
1738 file contents in the filesystem. 1739 file contents in the filesystem.
1739 </p> 1740 </p>
1740 <p> 1741 <p>
1741 If this directive is used on a file that already has a file 1742 If this directive is used on a file that already has a file
1742 content overlay, the old overlay is discarded and replaced 1743 content overlay, the old overlay is discarded and replaced
1743 with the new one. 1744 with the new one.
(...skipping 761 matching lines...) Expand 10 before | Expand all | Expand 10 after
2505 The name that should be given to the parameter. 2506 The name that should be given to the parameter.
2506 </p> 2507 </p>
2507 </dd><dt class="field"><b><i>parameters ( <span style="color:#999999"> optional</span> String )</i></b></dt><dd> 2508 </dd><dt class="field"><b><i>parameters ( <span style="color:#999999"> optional</span> String )</i></b></dt><dd>
2508 2509
2509 <p> 2510 <p>
2510 The parameter list of the parameter's function type. 2511 The parameter list of the parameter's function type.
2511 If the parameter is not of a function type, this field will 2512 If the parameter is not of a function type, this field will
2512 not be defined. If the function type has zero parameters, this 2513 not be defined. If the function type has zero parameters, this
2513 field will have a value of "()". 2514 field will have a value of "()".
2514 </p> 2515 </p>
2515 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringOpt ions">RefactoringOptions: object</a></dt><dd> 2516 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringFee dback">RefactoringFeedback: object</a></dt><dd>
2517 <p>
2518 An abstract superclass of all refactoring feedbacks.
2519 </p>
2520
2521 <dl></dl></dd><dt class="typeDefinition"><a name="type_RefactoringOptions" >RefactoringOptions: object</a></dt><dd>
2516 <p> 2522 <p>
2517 An abstract superclass of all refactoring options. 2523 An abstract superclass of all refactoring options.
2518 </p> 2524 </p>
2519 2525
2520 <dl></dl></dd><dt class="typeDefinition"><a name="type_RefactoringMethodPa rameterKind">RefactoringMethodParameterKind: String</a></dt><dd> 2526 <dl></dl></dd><dt class="typeDefinition"><a name="type_RefactoringMethodPa rameterKind">RefactoringMethodParameterKind: String</a></dt><dd>
2521 <p> 2527 <p>
2522 An enumeration of the kinds of parameters. 2528 An enumeration of the kinds of parameters.
2523 </p> 2529 </p>
2524 2530
2525 <dl><dt class="value">REQUIRED</dt><dt class="value">POSITIONAL</dt><dt cl ass="value">NAMED</dt></dl></dd><dt class="typeDefinition"><a name="type_Refacto ringProblem">RefactoringProblem: object</a></dt><dd> 2531 <dl><dt class="value">REQUIRED</dt><dt class="value">POSITIONAL</dt><dt cl ass="value">NAMED</dt></dl></dd><dt class="typeDefinition"><a name="type_Refacto ringProblem">RefactoringProblem: object</a></dt><dd>
(...skipping 597 matching lines...) Expand 10 before | Expand all | Expand 10 after
3123 <p> 3129 <p>
3124 This section contains a list of all of the errors that are 3130 This section contains a list of all of the errors that are
3125 produced by the server and the data that is returned with each. 3131 produced by the server and the data that is returned with each.
3126 </p> 3132 </p>
3127 <p> 3133 <p>
3128 TBD 3134 TBD
3129 </p> 3135 </p>
3130 3136
3131 3137
3132 </body></html> 3138 </body></html>
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698