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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 470723003: Proposal for RefactoringMethodParameter. (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Fixes for review comments. Created 6 years, 4 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
« no previous file with comments | « editor/tools/plugins/com.google.dart.server/src/com/google/dart/server/generated/types/RefactoringMethodParameter.java ('k') | pkg/analysis_server/test/integration/protocol_matchers.dart » ('j') | pkg/analysis_server/tool/spec/spec_input.html » ('J')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
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 1687 matching lines...) Expand 10 before | Expand all | Expand 10 after
1698 1698
1699 1699
1700 1700
1701 1701
1702 1702
1703 1703
1704 1704
1705 1705
1706 1706
1707 1707
1708
1708 <dl><dt class="typeDefinition"><a name="type_AddContentOverlay">AddContentOv erlay: object</a></dt><dd> 1709 <dl><dt class="typeDefinition"><a name="type_AddContentOverlay">AddContentOv erlay: object</a></dt><dd>
1709 <p> 1710 <p>
1710 A directive to begin overlaying the contents of a file. The 1711 A directive to begin overlaying the contents of a file. The
1711 supplied content will be used for analysis in place of the 1712 supplied content will be used for analysis in place of the
1712 file contents in the filesystem. 1713 file contents in the filesystem.
1713 </p> 1714 </p>
1714 <p> 1715 <p>
1715 If this directive is used on a file that already has a file 1716 If this directive is used on a file that already has a file
1716 content overlay, the old overlay is discarded and replaced 1717 content overlay, the old overlay is discarded and replaced
1717 with the new one. 1718 with the new one.
(...skipping 725 matching lines...) Expand 10 before | Expand all | Expand 10 after
2443 <dl><dt class="field"><b><i>element ( <a href="#type_Element">Element</a> )</i></b></dt><dd> 2444 <dl><dt class="field"><b><i>element ( <a href="#type_Element">Element</a> )</i></b></dt><dd>
2444 2445
2445 <p> 2446 <p>
2446 The element that is being overridden. 2447 The element that is being overridden.
2447 </p> 2448 </p>
2448 </dd><dt class="field"><b><i>className ( String )</i></b></dt><dd> 2449 </dd><dt class="field"><b><i>className ( String )</i></b></dt><dd>
2449 2450
2450 <p> 2451 <p>
2451 The name of the class in which the member is defined. 2452 The name of the class in which the member is defined.
2452 </p> 2453 </p>
2453 </dd></dl></dd><dt class="typeDefinition"><a name="type_Parameter">Par ameter: object</a></dt><dd>
2454 <p>
2455 A description of a parameter.
2456 </p>
2457
2458 <dl><dt class="field"><b><i>type ( String )</i></b></dt><dd>
2459
2460 <p>
2461 The type that should be given to the parameter.
2462 </p>
2463 </dd><dt class="field"><b><i>name ( String )</i></b></dt><dd>
2464
2465 <p>
2466 The name that should be given to the parameter.
2467 </p>
2468 </dd></dl></dd><dt class="typeDefinition"><a name="type_Position">Posi tion: object</a></dt><dd> 2454 </dd></dl></dd><dt class="typeDefinition"><a name="type_Position">Posi tion: object</a></dt><dd>
2469 <p> 2455 <p>
2470 A position within a file. 2456 A position within a file.
2471 </p> 2457 </p>
2472 2458
2473 <dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> ) </i></b></dt><dd> 2459 <dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> ) </i></b></dt><dd>
2474 2460
2475 <p> 2461 <p>
2476 The file containing the position. 2462 The file containing the position.
2477 </p> 2463 </p>
2478 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> 2464 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>
2479 2465
2480 <p> 2466 <p>
2481 The offset of the position. 2467 The offset of the position.
2482 </p> 2468 </p>
2483 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringKin d">RefactoringKind: String</a></dt><dd> 2469 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringKin d">RefactoringKind: String</a></dt><dd>
2484 <p> 2470 <p>
2485 An enumeration of the kinds of refactorings that can be 2471 An enumeration of the kinds of refactorings that can be
2486 created. 2472 created.
2487 </p> 2473 </p>
2488 2474
2489 <dl><dt class="value">CONVERT_GETTER_TO_METHOD</dt><dt class="value">CONVE RT_METHOD_TO_GETTER</dt><dt class="value">EXTRACT_LOCAL_VARIABLE</dt><dt class=" value">EXTRACT_METHOD</dt><dt class="value">INLINE_LOCAL_VARIABLE</dt><dt class= "value">INLINE_METHOD</dt><dt class="value">RENAME</dt></dl></dd><dt class="type Definition"><a name="type_RefactoringProblem">RefactoringProblem: object</a></dt ><dd> 2475 <dl><dt class="value">CONVERT_GETTER_TO_METHOD</dt><dt class="value">CONVE RT_METHOD_TO_GETTER</dt><dt class="value">EXTRACT_LOCAL_VARIABLE</dt><dt class=" value">EXTRACT_METHOD</dt><dt class="value">INLINE_LOCAL_VARIABLE</dt><dt class= "value">INLINE_METHOD</dt><dt class="value">RENAME</dt></dl></dd><dt class="type Definition"><a name="type_RefactoringMethodParameter">RefactoringMethodParameter : object</a></dt><dd>
2476 <p>
2477 A description of a parameter in a method refactoring.
2478 </p>
2479
2480 <dl><dt class="field"><b><i>id ( <span style="color:#999999">optional</spa n> String )</i></b></dt><dd>
2481
2482 <p>
2483 The unique identifier of the parameter.
2484 Clients may omit this field for the parameters they want to add.
2485 </p>
2486 </dd><dt class="field"><b><i>kind ( <a href="#type_RefactoringMethodPa rameterKind">RefactoringMethodParameterKind</a> )</i></b></dt><dd>
2487
2488 <p>
2489 The kind of the parameter.
2490 </p>
2491 </dd><dt class="field"><b><i>type ( String )</i></b></dt><dd>
2492
2493 <p>
2494 The type that should be given to the parameter, or the return type
2495 of the parameter's function type.
2496 </p>
2497 </dd><dt class="field"><b><i>name ( String )</i></b></dt><dd>
2498
2499 <p>
2500 The name that should be given to the parameter.
2501 </p>
2502 </dd><dt class="field"><b><i>parameters ( <span style="color:#999999"> optional</span> String )</i></b></dt><dd>
2503
2504 <p>
2505 The parameter list of the parameter's function type.
2506 If the parameter is not of a function type, this field will
2507 not be defined. If the function type has zero parameters, this
2508 field will have a value of "()".
2509 </p>
2510 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringMet hodParameterKind">RefactoringMethodParameterKind: String</a></dt><dd>
2511 <p>
2512 An enumeration of the kinds of parameters.
2513 </p>
2514
2515 <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>
2490 <p> 2516 <p>
2491 A description of a problem related to a refactoring. 2517 A description of a problem related to a refactoring.
2492 </p> 2518 </p>
2493 2519
2494 <dl><dt class="field"><b><i>severity ( <a href="#type_RefactoringProblemSe verity">RefactoringProblemSeverity</a> )</i></b></dt><dd> 2520 <dl><dt class="field"><b><i>severity ( <a href="#type_RefactoringProblemSe verity">RefactoringProblemSeverity</a> )</i></b></dt><dd>
2495 2521
2496 <p> 2522 <p>
2497 The severity of the problem being represented. 2523 The severity of the problem being represented.
2498 </p> 2524 </p>
2499 </dd><dt class="field"><b><i>message ( String )</i></b></dt><dd> 2525 </dd><dt class="field"><b><i>message ( String )</i></b></dt><dd>
(...skipping 341 matching lines...) Expand 10 before | Expand all | Expand 10 after
2841 </dd><dt class="field"><b><i>names ( List&lt;String&gt; )</i></b></dt> <dd> 2867 </dd><dt class="field"><b><i>names ( List&lt;String&gt; )</i></b></dt> <dd>
2842 2868
2843 <p> 2869 <p>
2844 The proposed names for the method. 2870 The proposed names for the method.
2845 </p> 2871 </p>
2846 </dd><dt class="field"><b><i>canCreateGetter ( bool )</i></b></dt><dd> 2872 </dd><dt class="field"><b><i>canCreateGetter ( bool )</i></b></dt><dd>
2847 2873
2848 <p> 2874 <p>
2849 True if a getter could be created rather than a method. 2875 True if a getter could be created rather than a method.
2850 </p> 2876 </p>
2851 </dd><dt class="field"><b><i>parameters ( List&lt;<a href="#type_Param eter">Parameter</a>&gt; )</i></b></dt><dd> 2877 </dd><dt class="field"><b><i>parameters ( List&lt;<a href="#type_Refac toringMethodParameter">RefactoringMethodParameter</a>&gt; )</i></b></dt><dd>
2852 2878
2853 <p> 2879 <p>
2854 The proposed parameters for the method. 2880 The proposed parameters for the method.
2855 </p> 2881 </p>
2856 </dd><dt class="field"><b><i>occurrences ( int )</i></b></dt><dd> 2882 </dd><dt class="field"><b><i>occurrences ( int )</i></b></dt><dd>
2857 2883
2858 <p> 2884 <p>
2859 The number of times the expression or statements occurs. 2885 The number of times the expression or statements occurs.
2860 </p> 2886 </p>
2861 </dd><dt class="field"><b><i>offsets ( List&lt;int&gt; )</i></b></dt>< dd> 2887 </dd><dt class="field"><b><i>offsets ( List&lt;int&gt; )</i></b></dt>< dd>
(...skipping 22 matching lines...) Expand all
2884 <p> 2910 <p>
2885 True if a getter should be created rather than a 2911 True if a getter should be created rather than a
2886 method. It is an error if this field is true and the 2912 method. It is an error if this field is true and the
2887 list of parameters is non-empty. 2913 list of parameters is non-empty.
2888 </p> 2914 </p>
2889 </dd><dt class="field"><b><i>name ( String )</i></b></dt><dd> 2915 </dd><dt class="field"><b><i>name ( String )</i></b></dt><dd>
2890 2916
2891 <p> 2917 <p>
2892 The name that the method should be given. 2918 The name that the method should be given.
2893 </p> 2919 </p>
2894 </dd><dt class="field"><b><i>parameters ( List&lt;<a href="#type_Param eter">Parameter</a>&gt; )</i></b></dt><dd> 2920 </dd><dt class="field"><b><i>parameters ( List&lt;<a href="#type_Refac toringMethodParameter">RefactoringMethodParameter</a>&gt; )</i></b></dt><dd>
2895 2921
2896 <p> 2922 <p>
2897 The parameters that should be defined for the method. 2923 The parameters that should be defined for the method.
2898 </p> 2924 </p><p>
2925 Only trailing parameters may be of POSITIONAL or NAMED kinds.
2926 All the trailing parameters must use the same kind.
2927 </p>
2928 <p>
2929 It is an error if any non-trailing parameter is of POSITIONAL or
2930 NAMED kind, or if trailing parameters are not all of POSITIONAL
2931 or NAMED kind.
2932 </p>
2933 <ul>
2934 <li>
2935 To change the order and/or update proposed paramerers, add
2936 parameters with the same identifiers as proposed.
2937 </li>
2938 <li>To add new parameters, omit their identifier.</li>
2939 <li>To remove some parameters, omit them in this list.</li>
2940 </ul>
2941 <p></p>
2899 </dd><dt class="field"><b><i>extractAll ( bool )</i></b></dt><dd> 2942 </dd><dt class="field"><b><i>extractAll ( bool )</i></b></dt><dd>
2900 2943
2901 <p> 2944 <p>
2902 True if all occurrences of the expression or statements 2945 True if all occurrences of the expression or statements
2903 should be replaced by an invocation of the method. The 2946 should be replaced by an invocation of the method. The
2904 expression or statements used to initiate the 2947 expression or statements used to initiate the
2905 refactoring will always be replaced. 2948 refactoring will always be replaced.
2906 </p> 2949 </p>
2907 </dd></dl></dd><dt class="refactoring">INLINE_LOCAL_VARIABLE</dt><dd> 2950 </dd></dl></dd><dt class="refactoring">INLINE_LOCAL_VARIABLE</dt><dd>
2908 <p> 2951 <p>
(...skipping 63 matching lines...) Expand 10 before | Expand all | Expand 10 after
2972 <p> 3015 <p>
2973 This section contains a list of all of the errors that are 3016 This section contains a list of all of the errors that are
2974 produced by the server and the data that is returned with each. 3017 produced by the server and the data that is returned with each.
2975 </p> 3018 </p>
2976 <p> 3019 <p>
2977 TBD 3020 TBD
2978 </p> 3021 </p>
2979 3022
2980 3023
2981 </body></html> 3024 </body></html>
OLDNEW
« no previous file with comments | « editor/tools/plugins/com.google.dart.server/src/com/google/dart/server/generated/types/RefactoringMethodParameter.java ('k') | pkg/analysis_server/test/integration/protocol_matchers.dart » ('j') | pkg/analysis_server/tool/spec/spec_input.html » ('J')

Powered by Google App Engine
This is Rietveld 408576698