Chromium Code Reviews| 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 2400 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 2411 </p> | 2411 </p> |
| 2412 </field> | 2412 </field> |
| 2413 <field name="className"> | 2413 <field name="className"> |
| 2414 <ref>String</ref> | 2414 <ref>String</ref> |
| 2415 <p> | 2415 <p> |
| 2416 The name of the class in which the member is defined. | 2416 The name of the class in which the member is defined. |
| 2417 </p> | 2417 </p> |
| 2418 </field> | 2418 </field> |
| 2419 </object> | 2419 </object> |
| 2420 </type> | 2420 </type> |
| 2421 <type name="Parameter"> | |
| 2422 <p> | |
| 2423 A description of a parameter. | |
| 2424 </p> | |
| 2425 <object> | |
| 2426 <field name="type"> | |
| 2427 <ref>String</ref> | |
| 2428 <p> | |
| 2429 The type that should be given to the parameter. | |
| 2430 </p> | |
| 2431 </field> | |
| 2432 <field name="name"> | |
| 2433 <ref>String</ref> | |
| 2434 <p> | |
| 2435 The name that should be given to the parameter. | |
| 2436 </p> | |
| 2437 </field> | |
| 2438 </object> | |
| 2439 </type> | |
| 2440 <type name="Position"> | 2421 <type name="Position"> |
| 2441 <p> | 2422 <p> |
| 2442 A position within a file. | 2423 A position within a file. |
| 2443 </p> | 2424 </p> |
| 2444 <object> | 2425 <object> |
| 2445 <field name="file"> | 2426 <field name="file"> |
| 2446 <ref>FilePath</ref> | 2427 <ref>FilePath</ref> |
| 2447 <p> | 2428 <p> |
| 2448 The file containing the position. | 2429 The file containing the position. |
| 2449 </p> | 2430 </p> |
| (...skipping 14 matching lines...) Expand all Loading... | |
| 2464 <enum> | 2445 <enum> |
| 2465 <value><code>CONVERT_GETTER_TO_METHOD</code></value> | 2446 <value><code>CONVERT_GETTER_TO_METHOD</code></value> |
| 2466 <value><code>CONVERT_METHOD_TO_GETTER</code></value> | 2447 <value><code>CONVERT_METHOD_TO_GETTER</code></value> |
| 2467 <value><code>EXTRACT_LOCAL_VARIABLE</code></value> | 2448 <value><code>EXTRACT_LOCAL_VARIABLE</code></value> |
| 2468 <value><code>EXTRACT_METHOD</code></value> | 2449 <value><code>EXTRACT_METHOD</code></value> |
| 2469 <value><code>INLINE_LOCAL_VARIABLE</code></value> | 2450 <value><code>INLINE_LOCAL_VARIABLE</code></value> |
| 2470 <value><code>INLINE_METHOD</code></value> | 2451 <value><code>INLINE_METHOD</code></value> |
| 2471 <value><code>RENAME</code></value> | 2452 <value><code>RENAME</code></value> |
| 2472 </enum> | 2453 </enum> |
| 2473 </type> | 2454 </type> |
| 2455 <type name="RefactoringMethodParameter"> | |
|
Brian Wilkerson
2014/08/13 23:14:29
Do we need to allow parameters to be marked as 'op
scheglov
2014/08/14 02:35:28
Acknowledged.
I will add the "kind" field.
| |
| 2456 <p> | |
| 2457 A description of a parameter in a method refactoring. | |
| 2458 </p> | |
| 2459 <object> | |
| 2460 <field name="id" optional="true"> | |
| 2461 <ref>String</ref> | |
| 2462 <p> | |
| 2463 The unique identifier of the parameter. | |
|
Brian Wilkerson
2014/08/13 23:14:29
Probably need to specify that the id must match th
scheglov
2014/08/14 02:35:28
I will document it at the place where client provi
| |
| 2464 Clients may omit this field for the parameters they want to add. | |
| 2465 </p> | |
| 2466 </field> | |
| 2467 <field name="type"> | |
|
Paul Berry
2014/08/13 23:59:08
I think we need something more than just a String
scheglov
2014/08/14 02:35:28
I will add the "parameters" field as in Element.
| |
| 2468 <ref>String</ref> | |
| 2469 <p> | |
| 2470 The type that should be given to the parameter. | |
| 2471 </p> | |
| 2472 </field> | |
| 2473 <field name="name"> | |
| 2474 <ref>String</ref> | |
| 2475 <p> | |
| 2476 The name that should be given to the parameter. | |
| 2477 </p> | |
| 2478 </field> | |
| 2479 </object> | |
| 2480 </type> | |
| 2474 <type name="RefactoringProblem"> | 2481 <type name="RefactoringProblem"> |
| 2475 <p> | 2482 <p> |
| 2476 A description of a problem related to a refactoring. | 2483 A description of a problem related to a refactoring. |
| 2477 </p> | 2484 </p> |
| 2478 <object> | 2485 <object> |
| 2479 <field name="severity"> | 2486 <field name="severity"> |
| 2480 <ref>RefactoringProblemSeverity</ref> | 2487 <ref>RefactoringProblemSeverity</ref> |
| 2481 <p> | 2488 <p> |
| 2482 The severity of the problem being represented. | 2489 The severity of the problem being represented. |
| 2483 </p> | 2490 </p> |
| (...skipping 406 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 2890 The proposed names for the method. | 2897 The proposed names for the method. |
| 2891 </p> | 2898 </p> |
| 2892 </field> | 2899 </field> |
| 2893 <field name="canCreateGetter"> | 2900 <field name="canCreateGetter"> |
| 2894 <ref>bool</ref> | 2901 <ref>bool</ref> |
| 2895 <p> | 2902 <p> |
| 2896 True if a getter could be created rather than a method. | 2903 True if a getter could be created rather than a method. |
| 2897 </p> | 2904 </p> |
| 2898 </field> | 2905 </field> |
| 2899 <field name="parameters"> | 2906 <field name="parameters"> |
| 2900 <list><ref>Parameter</ref></list> | 2907 <list><ref>RefactoringMethodParameter</ref></list> |
| 2901 <p> | 2908 <p> |
| 2902 The proposed parameters for the method. | 2909 The proposed parameters for the method. |
| 2903 </p> | 2910 </p> |
| 2904 </field> | 2911 </field> |
| 2905 <field name="occurrences"> | 2912 <field name="occurrences"> |
| 2906 <ref>int</ref> | 2913 <ref>int</ref> |
| 2907 <p> | 2914 <p> |
| 2908 The number of times the expression or statements occurs. | 2915 The number of times the expression or statements occurs. |
| 2909 </p> | 2916 </p> |
| 2910 </field> | 2917 </field> |
| (...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 2942 list of parameters is non-empty. | 2949 list of parameters is non-empty. |
| 2943 </p> | 2950 </p> |
| 2944 </field> | 2951 </field> |
| 2945 <field name="name"> | 2952 <field name="name"> |
| 2946 <ref>String</ref> | 2953 <ref>String</ref> |
| 2947 <p> | 2954 <p> |
| 2948 The name that the method should be given. | 2955 The name that the method should be given. |
| 2949 </p> | 2956 </p> |
| 2950 </field> | 2957 </field> |
| 2951 <field name="parameters"> | 2958 <field name="parameters"> |
| 2952 <list><ref>Parameter</ref></list> | 2959 <list><ref>RefactoringMethodParameter</ref></list> |
| 2953 <p> | 2960 <p> |
| 2954 The parameters that should be defined for the method. | 2961 The parameters that should be defined for the method. |
| 2962 Clients may change order of proposed parameters, add new ones | |
|
Brian Wilkerson
2014/08/13 23:14:29
"order" --> "the order"
scheglov
2014/08/14 02:35:28
Done.
| |
| 2963 or omit some parameters (corresponding parameters will not be | |
| 2964 generated). | |
| 2955 </p> | 2965 </p> |
| 2956 </field> | 2966 </field> |
| 2957 <field name="extractAll"> | 2967 <field name="extractAll"> |
| 2958 <ref>bool</ref> | 2968 <ref>bool</ref> |
| 2959 <p> | 2969 <p> |
| 2960 True if all occurrences of the expression or statements | 2970 True if all occurrences of the expression or statements |
| 2961 should be replaced by an invocation of the method. The | 2971 should be replaced by an invocation of the method. The |
| 2962 expression or statements used to initiate the | 2972 expression or statements used to initiate the |
| 2963 refactoring will always be replaced. | 2973 refactoring will always be replaced. |
| 2964 </p> | 2974 </p> |
| (...skipping 78 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 3043 <h2>Errors</h2> | 3053 <h2>Errors</h2> |
| 3044 <p> | 3054 <p> |
| 3045 This section contains a list of all of the errors that are | 3055 This section contains a list of all of the errors that are |
| 3046 produced by the server and the data that is returned with each. | 3056 produced by the server and the data that is returned with each. |
| 3047 </p> | 3057 </p> |
| 3048 <p> | 3058 <p> |
| 3049 TBD | 3059 TBD |
| 3050 </p> | 3060 </p> |
| 3051 </body> | 3061 </body> |
| 3052 </html> | 3062 </html> |
| OLD | NEW |