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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: pkg/analysis_server/tool/spec/spec_input.html

Issue 2994103002: Add kythe support to plugins and format the spec files (Closed)
Patch Set: Created 3 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
« no previous file with comments | « pkg/analysis_server/lib/protocol/protocol_generated.dart ('k') | pkg/analyzer_plugin/doc/api.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <!doctype html> 1 <!doctype html>
2 <html> 2 <html>
3 <head> 3 <head>
4 <meta charset="UTF-8"/> 4 <meta charset="UTF-8"/>
5 <title>Analysis Server API Specification</title> 5 <title>Analysis Server API Specification</title>
6 </head> 6 </head>
7 <body> 7 <body>
8 <h1>Analysis Server API Specification</h1> 8 <h1>Analysis Server API Specification</h1>
9 <h1 style="color:#999999">Version 9 <h1 style="color:#999999">Version
10 <version>1.18.3</version> 10 <version>1.18.3</version>
(...skipping 1856 matching lines...) Expand 10 before | Expand all | Expand 10 after
1867 </field> 1867 </field>
1868 <field name="key"> 1868 <field name="key">
1869 <ref>String</ref> 1869 <ref>String</ref>
1870 <p> 1870 <p>
1871 The unique name that identifies the template in use. 1871 The unique name that identifies the template in use.
1872 </p> 1872 </p>
1873 </field> 1873 </field>
1874 <field name="offset"> 1874 <field name="offset">
1875 <ref>int</ref> 1875 <ref>int</ref>
1876 <p> 1876 <p>
1877 The offset used to identify the code to which the template will be app lied. 1877 The offset used to identify the code to which the template will be
1878 applied.
1878 </p> 1879 </p>
1879 </field> 1880 </field>
1880 </params> 1881 </params>
1881 <result> 1882 <result>
1882 <field name="change"> 1883 <field name="change">
1883 <ref>SourceChange</ref> 1884 <ref>SourceChange</ref>
1884 <p> 1885 <p>
1885 The change to be applied in order to complete the statement. 1886 The change to be applied in order to complete the statement.
1886 </p> 1887 </p>
1887 </field> 1888 </field>
(...skipping 180 matching lines...) Expand 10 before | Expand all | Expand 10 after
2068 </field> 2069 </field>
2069 <field name="key"> 2070 <field name="key">
2070 <ref>String</ref> 2071 <ref>String</ref>
2071 <p> 2072 <p>
2072 The unique name that identifies the template in use. 2073 The unique name that identifies the template in use.
2073 </p> 2074 </p>
2074 </field> 2075 </field>
2075 <field name="offset"> 2076 <field name="offset">
2076 <ref>int</ref> 2077 <ref>int</ref>
2077 <p> 2078 <p>
2078 The offset used to identify the code to which the template will be app lied. 2079 The offset used to identify the code to which the template will be
2080 applied.
2079 </p> 2081 </p>
2080 </field> 2082 </field>
2081 </params> 2083 </params>
2082 <result> 2084 <result>
2083 <field name="value"> 2085 <field name="value">
2084 <ref>bool</ref> 2086 <ref>bool</ref>
2085 <p> 2087 <p>
2086 True if the template can be expanded at the given location. 2088 True if the template can be expanded at the given location.
2087 </p> 2089 </p>
2088 </field> 2090 </field>
(...skipping 339 matching lines...) Expand 10 before | Expand all | Expand 10 after
2428 to send in additional analytics (see <tt>sendEvent</tt> and 2430 to send in additional analytics (see <tt>sendEvent</tt> and
2429 <tt>sendTiming</tt>) if they so choose. Dart command-line tools provide a 2431 <tt>sendTiming</tt>) if they so choose. Dart command-line tools provide a
2430 disclaimer similar to: 2432 disclaimer similar to:
2431 <tt> 2433 <tt>
2432 Dart SDK tools anonymously report feature usage statistics and basic crash 2434 Dart SDK tools anonymously report feature usage statistics and basic crash
2433 reports to help improve Dart tools over time. See Google's privacy policy: 2435 reports to help improve Dart tools over time. See Google's privacy policy:
2434 https://www.google.com/intl/en/policies/privacy/. 2436 https://www.google.com/intl/en/policies/privacy/.
2435 </tt> 2437 </tt>
2436 </p> 2438 </p>
2437 <p> 2439 <p>
2438 The analysis server will send it's own analytics data (for example, operatio ns 2440 The analysis server will send it's own analytics data (for example,
2439 performed, operating system type, SDK version). No data (from the analysis 2441 operations performed, operating system type, SDK version). No data (from the
2440 server or from clients) will be sent if analytics is disabled. 2442 analysis server or from clients) will be sent if analytics is disabled.
2441 </p> 2443 </p>
2442 <request method="isEnabled"> 2444 <request method="isEnabled">
2443 <p>Query whether analytics is enabled.</p> 2445 <p>Query whether analytics is enabled.</p>
2444 <p> 2446 <p>
2445 This flag controls whether the analysis server sends any analytics data to 2447 This flag controls whether the analysis server sends any analytics data to
2446 the cloud. If disabled, the analysis server does not send any analytics 2448 the cloud. If disabled, the analysis server does not send any analytics
2447 data, and any data sent to it by clients (from <tt>sendEvent</tt> and 2449 data, and any data sent to it by clients (from <tt>sendEvent</tt> and
2448 <tt>sendTiming</tt>) will be ignored. 2450 <tt>sendTiming</tt>) will be ignored.
2449 </p> 2451 </p>
2450 <p> 2452 <p>
2451 The value of this flag can be changed by other tools outside of the 2453 The value of this flag can be changed by other tools outside of the
2452 analysis server's process. When you query the flag, you get the value of 2454 analysis server's process. When you query the flag, you get the value of
2453 the flag at a given moment. Clients should not use the value returned to 2455 the flag at a given moment. Clients should not use the value returned to
2454 decide whether or not to send the <tt>sendEvent</tt> and <tt>sendTiming</t t> 2456 decide whether or not to send the <tt>sendEvent</tt> and
2455 requests. Those requests should be used unconditionally and server will 2457 <tt>sendTiming</tt> requests. Those requests should be used
2456 determine whether or not it is appropriate to forward the information to 2458 unconditionally and server will determine whether or not it is appropriate
2457 the cloud at the time each request is received. 2459 to forward the information to the cloud at the time each request is
2460 received.
2458 </p> 2461 </p>
2459 <result> 2462 <result>
2460 <field name="enabled"> 2463 <field name="enabled">
2461 <ref>bool</ref> 2464 <ref>bool</ref>
2462 <p>Whether sending analytics is enabled or not.</p> 2465 <p>Whether sending analytics is enabled or not.</p>
2463 </field> 2466 </field>
2464 </result> 2467 </result>
2465 </request> 2468 </request>
2466 <request method="enable"> 2469 <request method="enable">
2467 <p> 2470 <p>
(...skipping 59 matching lines...) Expand 10 before | Expand all | Expand 10 after
2527 </field> 2530 </field>
2528 </params> 2531 </params>
2529 </request> 2532 </request>
2530 </domain> 2533 </domain>
2531 <domain name="kythe" experimental="true"> 2534 <domain name="kythe" experimental="true">
2532 <p> 2535 <p>
2533 The kythe domain contains APIs related to generating Dart content in the 2536 The kythe domain contains APIs related to generating Dart content in the
2534 <a href="http://kythe.io/">Kythe</a> format. 2537 <a href="http://kythe.io/">Kythe</a> format.
2535 </p> 2538 </p>
2536 <request method="getKytheEntries"> 2539 <request method="getKytheEntries">
2537 <p>Return the list of <tt>KytheEntry</tt> objects for some file, given the c urrent state of the 2540 <p>
2538 file system populated by "analysis.updateContent".</p> 2541 Return the list of <tt>KytheEntry</tt> objects for some file, given the
2542 current state of the file system populated by "analysis.updateContent".
2543 </p>
2539 <params> 2544 <params>
2540 <field name="file"> 2545 <field name="file">
2541 <ref>FilePath</ref> 2546 <ref>FilePath</ref>
2542 <p> 2547 <p>
2543 The file containing the code for which the Kythe Entry objects are bei ng requested. 2548 The file containing the code for which the Kythe Entry objects are
2549 being requested.
2544 </p> 2550 </p>
2545 </field> 2551 </field>
2546 </params> 2552 </params>
2547 <result> 2553 <result>
2548 <field name="entries"> 2554 <field name="entries">
2549 <list> 2555 <list>
2550 <ref>KytheEntry</ref> 2556 <ref>KytheEntry</ref>
2551 </list> 2557 </list>
2552 <p>The list of <tt>KytheEntry</tt> objects for the queried file.</p> 2558 <p>
2559 The list of <tt>KytheEntry</tt> objects for the queried file.
2560 </p>
2553 </field> 2561 </field>
2554 <field name="files"> 2562 <field name="files">
2555 <list> 2563 <list>
2556 <ref>FilePath</ref> 2564 <ref>FilePath</ref>
2557 </list> 2565 </list>
2558 <p>The set of files paths that were required, but not in the file system , to give a complete 2566 <p>
2559 and accurate Kythe graph for the file. This could be due to a referenc ed file that does 2567 The set of files paths that were required, but not in the file system,
2560 not exist or generated files not being generated or passed before the call to 2568 to give a complete and accurate Kythe graph for the file. This could
2561 "getKytheEntries".</p> 2569 be due to a referenced file that does not exist or generated files not
2570 being generated or passed before the call to "getKytheEntries".
2571 </p>
2562 </field> 2572 </field>
2563 </result> 2573 </result>
2564 </request> 2574 </request>
2565 </domain> 2575 </domain>
2566 <types> 2576 <types>
2567 <h2 class="domain"><a name="types">Types</a></h2> 2577 <h2 class="domain"><a name="types">Types</a></h2>
2568 <p> 2578 <p>
2569 This section contains descriptions of the data types referenced 2579 This section contains descriptions of the data types referenced
2570 in the API’s of the various domains. 2580 in the API’s of the various domains.
2571 </p> 2581 </p>
(...skipping 127 matching lines...) Expand 10 before | Expand all | Expand 10 after
2699 <ref>String</ref> 2709 <ref>String</ref>
2700 <p> 2710 <p>
2701 The name of the current target of analysis. This field is 2711 The name of the current target of analysis. This field is
2702 omitted if analyzing is false. 2712 omitted if analyzing is false.
2703 </p> 2713 </p>
2704 </field> 2714 </field>
2705 </object> 2715 </object>
2706 </type> 2716 </type>
2707 <type name="ClosingLabel"> 2717 <type name="ClosingLabel">
2708 <p> 2718 <p>
2709 A label that is associated with a range of code that may be useful to rend er at the end 2719 A label that is associated with a range of code that may be useful to
2710 of the range to aid code readability. For example, a constructor call that spans multiple 2720 render at the end of the range to aid code readability. For example, a
2711 lines may result in a closing label to allow the constructor type/name to be rendered 2721 constructor call that spans multiple lines may result in a closing label
2712 alongside the closing parenthesis. 2722 to allow the constructor type/name to be rendered alongside the closing
2723 parenthesis.
2713 </p> 2724 </p>
2714 <object> 2725 <object>
2715 <field name="offset"> 2726 <field name="offset">
2716 <ref>int</ref> 2727 <ref>int</ref>
2717 <p> 2728 <p>
2718 The offset of the construct being labelled. 2729 The offset of the construct being labelled.
2719 </p> 2730 </p>
2720 </field> 2731 </field>
2721 <field name="length"> 2732 <field name="length">
2722 <ref>int</ref> 2733 <ref>int</ref>
2723 <p> 2734 <p>
2724 The length of the whole construct to be labelled. 2735 The length of the whole construct to be labelled.
2725 </p> 2736 </p>
2726 </field> 2737 </field>
2727 <field name="label"> 2738 <field name="label">
2728 <ref>String</ref> 2739 <ref>String</ref>
2729 <p> 2740 <p>
2730 The label associated with this range that should be displayed to the u ser. 2741 The label associated with this range that should be displayed to the
2742 user.
2731 </p> 2743 </p>
2732 </field> 2744 </field>
2733 </object> 2745 </object>
2734 </type> 2746 </type>
2735 <type name="CompletionId"> 2747 <type name="CompletionId">
2736 <ref>String</ref> 2748 <ref>String</ref>
2737 <p> 2749 <p>
2738 An identifier used to associate completion results with a 2750 An identifier used to associate completion results with a
2739 completion request. 2751 completion request.
2740 </p> 2752 </p>
(...skipping 268 matching lines...) Expand 10 before | Expand all | Expand 10 after
3009 <field name="elements"> 3021 <field name="elements">
3010 <list> 3022 <list>
3011 <ref>String</ref> 3023 <ref>String</ref>
3012 </list> 3024 </list>
3013 <p> 3025 <p>
3014 The names of the elements imported from the library. 3026 The names of the elements imported from the library.
3015 </p> 3027 </p>
3016 </field> 3028 </field>
3017 </object> 3029 </object>
3018 </type> 3030 </type>
3019 <type name="KytheEntry">
3020 <p>
3021 This object matches the format and documentation of the Entry object docum ented in the
3022 <a href="https://kythe.io/docs/kythe-storage.html#_entry">Kythe Storage Mo del</a>.
3023 </p>
3024 <object>
3025 <field name="source">
3026 <ref>KytheVName</ref>
3027 <p>
3028 The ticket of the source node (must not be empty).
3029 </p>
3030 </field>
3031 <field name="kind">
3032 <ref>String</ref>
3033 <p>
3034 An edge label (may be empty). The schema defines which labels are meanin gful.
3035 </p>
3036 </field>
3037 <field name="target">
3038 <ref>KytheVName</ref>
3039 <p>
3040 The ticket of the target node (may be empty).
3041 </p>
3042 </field>
3043 <field name="fact">
3044 <ref>String</ref>
3045 <p>
3046 A fact label (must not be empty). The schema defines which fact labels a re meaningful.
3047 </p>
3048 </field>
3049 <field name="value">
3050 <list>
3051 <ref>int</ref>
3052 </list>
3053 <p>
3054 The <tt>String</tt> value of the fact (may be empty).
3055 </p>
3056 </field>
3057 </object>
3058 </type>
3059 <type name="KytheVName">
3060 <p>
3061 This object matches the format and documentation of the Vector-Name object documented in the
3062 <a href="https://kythe.io/docs/kythe-storage.html#_a_id_termvname_a_vector _name_strong_vname_strong">Kythe Storage Model</a>.
3063 </p>
3064 <object>
3065 <field name="signature">
3066 <ref>String</ref>
3067 <p>
3068 An opaque signature generated by the analyzer.
3069 </p>
3070 </field>
3071 <field name="corpus">
3072 <ref>String</ref>
3073 <p>
3074 The corpus of source code this <tt>KytheVName</tt> belongs to. Loosely, a corpus is a
3075 collection of related files, such as the contents of a given source repo sitory.
3076 </p>
3077 </field>
3078 <field name="root">
3079 <ref>String</ref>
3080 <p>
3081 A corpus-specific root label, typically a directory path or project iden tifier, denoting a
3082 distinct subset of the corpus. This may also be used to designate virtua l collections like generated files.
3083 </p>
3084 </field>
3085 <field name="path">
3086 <ref>String</ref>
3087 <p>
3088 A path-structured label describing the “location” of the named object re lative to the corpus
3089 and the root.
3090 </p>
3091 </field>
3092 <field name="language">
3093 <ref>String</ref>
3094 <p>
3095 The language this name belongs to.
3096 </p>
3097 </field>
3098 </object>
3099 </type>
3100 <type name="Override"> 3031 <type name="Override">
3101 <p> 3032 <p>
3102 A description of a member that overrides an inherited member. 3033 A description of a member that overrides an inherited member.
3103 </p> 3034 </p>
3104 <object> 3035 <object>
3105 <field name="offset"> 3036 <field name="offset">
3106 <ref>int</ref> 3037 <ref>int</ref>
3107 <p> 3038 <p>
3108 The offset of the name of the overriding member. 3039 The offset of the name of the overriding member.
3109 </p> 3040 </p>
(...skipping 58 matching lines...) Expand 10 before | Expand all | Expand 10 after
3168 </field> 3099 </field>
3169 <field name="key"> 3100 <field name="key">
3170 <ref>String</ref> 3101 <ref>String</ref>
3171 <p> 3102 <p>
3172 The unique template key, not shown in the UI. 3103 The unique template key, not shown in the UI.
3173 </p> 3104 </p>
3174 </field> 3105 </field>
3175 <field name="example"> 3106 <field name="example">
3176 <ref>String</ref> 3107 <ref>String</ref>
3177 <p> 3108 <p>
3178 A short example of the transformation performed when the template is a pplied. 3109 A short example of the transformation performed when the template is
3110 applied.
3179 </p> 3111 </p>
3180 </field> 3112 </field>
3181 </object> 3113 </object>
3182 </type> 3114 </type>
3183 <type name="PubStatus"> 3115 <type name="PubStatus">
3184 <p> 3116 <p>
3185 An indication of the current state of pub execution. 3117 An indication of the current state of pub execution.
3186 </p> 3118 </p>
3187 <object> 3119 <object>
3188 <field name="isListingPackageDirs"> 3120 <field name="isListingPackageDirs">
(...skipping 831 matching lines...) Expand 10 before | Expand all | Expand 10 after
4020 This section contains a list of all of the errors that are 3952 This section contains a list of all of the errors that are
4021 produced by the server and the data that is returned with each. 3953 produced by the server and the data that is returned with each.
4022 </p> 3954 </p>
4023 <p> 3955 <p>
4024 TODO: TBD 3956 TODO: TBD
4025 </p> 3957 </p>
4026 <h2 class="domain"><a name="index">Index</a></h2> 3958 <h2 class="domain"><a name="index">Index</a></h2>
4027 <index></index> 3959 <index></index>
4028 </body> 3960 </body>
4029 </html> 3961 </html>
OLDNEW
« no previous file with comments | « pkg/analysis_server/lib/protocol/protocol_generated.dart ('k') | pkg/analyzer_plugin/doc/api.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698