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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 2995683002: Initial experimental Kythe Dart Analysis Server protocol (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/tool/spec/generated/java/types/KytheVName.java ('k') | no next file » | 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 2510 matching lines...) Expand 10 before | Expand all | Expand 10 after
2521 <ref>String</ref> 2521 <ref>String</ref>
2522 <p>The name of the event.</p> 2522 <p>The name of the event.</p>
2523 </field> 2523 </field>
2524 <field name="millis"> 2524 <field name="millis">
2525 <ref>int</ref> 2525 <ref>int</ref>
2526 <p>The duration of the event in milliseconds.</p> 2526 <p>The duration of the event in milliseconds.</p>
2527 </field> 2527 </field>
2528 </params> 2528 </params>
2529 </request> 2529 </request>
2530 </domain> 2530 </domain>
2531 <domain name="kythe" experimental="true">
2532 <p>
2533 The kythe domain contains APIs related to generating Dart content in the
2534 <a href="http://kythe.io/">Kythe</a> format.
2535 </p>
2536 <request method="getKytheEntries">
2537 <p>Return the list of <tt>KytheEntry</tt> objects for some file, given the c urrent state of the
2538 file system populated by "analysis.updateContent".</p>
2539 <params>
2540 <field name="file">
2541 <ref>FilePath</ref>
2542 <p>
2543 The file containing the code for which the Kythe Entry objects are bei ng requested.
2544 </p>
2545 </field>
2546 </params>
2547 <result>
2548 <field name="entries">
2549 <list>
2550 <ref>KytheEntry</ref>
2551 </list>
2552 <p>The list of <tt>KytheEntry</tt> objects for the queried file.</p>
2553 </field>
2554 <field name="files">
2555 <list>
2556 <ref>FilePath</ref>
2557 </list>
2558 <p>The set of files paths that were required, but not in the file system , to give a complete
2559 and accurate Kythe graph for the file. This could be due to a referenc ed file that does
2560 not exist or generated files not being generated or passed before the call to
2561 "getKytheEntries".</p>
2562 </field>
2563 </result>
2564 </request>
2565 </domain>
2531 <types> 2566 <types>
2532 <h2 class="domain"><a name="types">Types</a></h2> 2567 <h2 class="domain"><a name="types">Types</a></h2>
2533 <p> 2568 <p>
2534 This section contains descriptions of the data types referenced 2569 This section contains descriptions of the data types referenced
2535 in the API’s of the various domains. 2570 in the API’s of the various domains.
2536 </p> 2571 </p>
2537 <include path="../../../analyzer_plugin/tool/spec/common_types_spec.html" 2572 <include path="../../../analyzer_plugin/tool/spec/common_types_spec.html"
2538 import="package:analyzer_plugin/protocol/protocol_common.dart"></incl ude> 2573 import="package:analyzer_plugin/protocol/protocol_common.dart"></incl ude>
2539 <type name="AnalysisErrorFixes"> 2574 <type name="AnalysisErrorFixes">
2540 <p> 2575 <p>
(...skipping 433 matching lines...) Expand 10 before | Expand all | Expand 10 after
2974 <field name="elements"> 3009 <field name="elements">
2975 <list> 3010 <list>
2976 <ref>String</ref> 3011 <ref>String</ref>
2977 </list> 3012 </list>
2978 <p> 3013 <p>
2979 The names of the elements imported from the library. 3014 The names of the elements imported from the library.
2980 </p> 3015 </p>
2981 </field> 3016 </field>
2982 </object> 3017 </object>
2983 </type> 3018 </type>
3019 <type name="KytheEntry">
3020 <p>
3021 This object has matches the format and documentation of the Entry object d ocumented in the
Brian Wilkerson 2017/08/09 17:44:11 "has matches" --> "matches"
jwren 2017/08/09 19:34:47 Done.
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 has matches the format and documentation of the Vector-Name ob ject documented in
Brian Wilkerson 2017/08/09 17:44:11 "has matches" --> "matches"
jwren 2017/08/09 19:34:47 Done.
3062 the
3063 <a href="https://kythe.io/docs/kythe-storage.html#_a_id_termvname_a_vector _name_strong_vname_strong">Kythe Storage Model</a>.
3064 </p>
3065 <object>
3066 <field name="signature">
3067 <ref>String</ref>
3068 <p>
3069 An opaque signature generated by the analyzer.
3070 </p>
3071 </field>
3072 <field name="corpus">
3073 <ref>String</ref>
3074 <p>
3075 The corpus of source code this VName belongs to. Loosely, a corpus is a collection of
Brian Wilkerson 2017/08/09 17:44:11 "VName" --> "KytheVName" to match the name of the
jwren 2017/08/09 19:34:47 Done.
3076 related files, such as the contents of a given source repository.
3077 </p>
3078 </field>
3079 <field name="root">
3080 <ref>String</ref>
3081 <p>
3082 A corpus-specific root label, typically a directory path or project iden tifier, denoting a
3083 distinct subset of the corpus. This may also be used to designate virtua l collections like generated files.
3084 </p>
3085 </field>
3086 <field name="path">
3087 <ref>String</ref>
3088 <p>
3089 A path-structured label describing the “location” of the named object re lative to the corpus
3090 and the root.
3091 </p>
3092 </field>
3093 <field name="language">
Brian Wilkerson 2017/08/09 17:44:11 Do we need this, or should it always be set to "da
jwren 2017/08/09 19:34:47 With future work, such as for angular source, we w
3094 <ref>String</ref>
3095 <p>
3096 The language this name belongs to.
3097 </p>
3098 </field>
3099 </object>
3100 </type>
2984 <type name="Override"> 3101 <type name="Override">
2985 <p> 3102 <p>
2986 A description of a member that overrides an inherited member. 3103 A description of a member that overrides an inherited member.
2987 </p> 3104 </p>
2988 <object> 3105 <object>
2989 <field name="offset"> 3106 <field name="offset">
2990 <ref>int</ref> 3107 <ref>int</ref>
2991 <p> 3108 <p>
2992 The offset of the name of the overriding member. 3109 The offset of the name of the overriding member.
2993 </p> 3110 </p>
(...skipping 910 matching lines...) Expand 10 before | Expand all | Expand 10 after
3904 This section contains a list of all of the errors that are 4021 This section contains a list of all of the errors that are
3905 produced by the server and the data that is returned with each. 4022 produced by the server and the data that is returned with each.
3906 </p> 4023 </p>
3907 <p> 4024 <p>
3908 TODO: TBD 4025 TODO: TBD
3909 </p> 4026 </p>
3910 <h2 class="domain"><a name="index">Index</a></h2> 4027 <h2 class="domain"><a name="index">Index</a></h2>
3911 <index></index> 4028 <index></index>
3912 </body> 4029 </body>
3913 </html> 4030 </html>
OLDNEW
« no previous file with comments | « pkg/analysis_server/tool/spec/generated/java/types/KytheVName.java ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698