Index: pkg/analysis_server/tool/spec/spec_input.html |
diff --git a/pkg/analysis_server/tool/spec/spec_input.html b/pkg/analysis_server/tool/spec/spec_input.html |
index 531bedeaa0490203247e96a63d09b1fff580c0ea..931005bac4fa72894fa2d9dc23e3274d79be8cb3 100644 |
--- a/pkg/analysis_server/tool/spec/spec_input.html |
+++ b/pkg/analysis_server/tool/spec/spec_input.html |
@@ -2528,6 +2528,41 @@ |
</params> |
</request> |
</domain> |
+<domain name="kythe" experimental="true"> |
+ <p> |
+ The kythe domain contains APIs related to generating Dart content in the |
+ <a href="http://kythe.io/">Kythe</a> format. |
+ </p> |
+ <request method="getKytheEntries"> |
+ <p>Return the list of <tt>KytheEntry</tt> objects for some file, given the current state of the |
+ file system populated by "analysis.updateContent".</p> |
+ <params> |
+ <field name="file"> |
+ <ref>FilePath</ref> |
+ <p> |
+ The file containing the code for which the Kythe Entry objects are being requested. |
+ </p> |
+ </field> |
+ </params> |
+ <result> |
+ <field name="entries"> |
+ <list> |
+ <ref>KytheEntry</ref> |
+ </list> |
+ <p>The list of <tt>KytheEntry</tt> objects for the queried file.</p> |
+ </field> |
+ <field name="files"> |
+ <list> |
+ <ref>FilePath</ref> |
+ </list> |
+ <p>The set of files paths that were required, but not in the file system, to give a complete |
+ and accurate Kythe graph for the file. This could be due to a referenced file that does |
+ not exist or generated files not being generated or passed before the call to |
+ "getKytheEntries".</p> |
+ </field> |
+ </result> |
+ </request> |
+</domain> |
<types> |
<h2 class="domain"><a name="types">Types</a></h2> |
<p> |
@@ -2981,6 +3016,87 @@ |
</field> |
</object> |
</type> |
+ <type name="KytheEntry"> |
+ <p> |
+ This object matches the format and documentation of the Entry object documented in the |
+ <a href="https://kythe.io/docs/kythe-storage.html#_entry">Kythe Storage Model</a>. |
+ </p> |
+ <object> |
+ <field name="source"> |
+ <ref>KytheVName</ref> |
+ <p> |
+ The ticket of the source node (must not be empty). |
+ </p> |
+ </field> |
+ <field name="kind"> |
+ <ref>String</ref> |
+ <p> |
+ An edge label (may be empty). The schema defines which labels are meaningful. |
+ </p> |
+ </field> |
+ <field name="target"> |
+ <ref>KytheVName</ref> |
+ <p> |
+ The ticket of the target node (may be empty). |
+ </p> |
+ </field> |
+ <field name="fact"> |
+ <ref>String</ref> |
+ <p> |
+ A fact label (must not be empty). The schema defines which fact labels are meaningful. |
+ </p> |
+ </field> |
+ <field name="value"> |
+ <list> |
+ <ref>int</ref> |
+ </list> |
+ <p> |
+ The <tt>String</tt> value of the fact (may be empty). |
+ </p> |
+ </field> |
+ </object> |
+ </type> |
+ <type name="KytheVName"> |
+ <p> |
+ This object matches the format and documentation of the Vector-Name object documented in the |
+ <a href="https://kythe.io/docs/kythe-storage.html#_a_id_termvname_a_vector_name_strong_vname_strong">Kythe Storage Model</a>. |
+ </p> |
+ <object> |
+ <field name="signature"> |
+ <ref>String</ref> |
+ <p> |
+ An opaque signature generated by the analyzer. |
+ </p> |
+ </field> |
+ <field name="corpus"> |
+ <ref>String</ref> |
+ <p> |
+ The corpus of source code this <tt>KytheVName</tt> belongs to. Loosely, a corpus is a |
+ collection of related files, such as the contents of a given source repository. |
+ </p> |
+ </field> |
+ <field name="root"> |
+ <ref>String</ref> |
+ <p> |
+ A corpus-specific root label, typically a directory path or project identifier, denoting a |
+ distinct subset of the corpus. This may also be used to designate virtual collections like generated files. |
+ </p> |
+ </field> |
+ <field name="path"> |
+ <ref>String</ref> |
+ <p> |
+ A path-structured label describing the “location” of the named object relative to the corpus |
+ and the root. |
+ </p> |
+ </field> |
+ <field name="language"> |
+ <ref>String</ref> |
+ <p> |
+ The language this name belongs to. |
+ </p> |
+ </field> |
+ </object> |
+ </type> |
<type name="Override"> |
<p> |
A description of a member that overrides an inherited member. |