pkg/analysis_server/tool/spec/spec_input.html - Issue 2800283002: updates to the analysis server generated spec doc

Unified Diff: pkg/analysis_server/tool/spec/spec_input.html

Issue 2800283002: updates to the analysis server generated spec doc (Closed)

Patch Set: Created 3 years, 8 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 side-by-side diff with in-line comments

« pkg/analysis_server/test/integration/integration_test_methods.dart ('K') | « pkg/analysis_server/tool/spec/generated/java/types/ElementKind.java ('k') | pkg/analysis_server/tool/spec/to_html.dart » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

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 3ff2874d470a17d3087de8834e63779cb5ef9e13..047720d97387f046b7184e37c538abea2f4272d5 100644

--- a/pkg/analysis_server/tool/spec/spec_input.html

+++ b/pkg/analysis_server/tool/spec/spec_input.html

@@ -116,24 +116,14 @@

should also use the server.getVersion request to test that the version of

the server supports an API before using it.

- <h3>Eventual Consistency</h3>

-

- TODO: TBD

-

Brian Wilkerson 2017/04/09 16:30:53 This really *does* need to be documented, so I'd p

devoncarew 2017/04/09 19:43:21 Probably better to track in an issue than in our p

Brian Wilkerson 2017/04/10 13:45:17 Probably not, because of the huge number of issues

<h3>Domains</h3>

- For convenience, the API is divided into domains. Each domain is

- specified in a separate section below:

-

- <toc></toc>

-

- The specifications of the API’s refer to data structures beyond

- the standard JSON primitives. These data structures are

+ For convenience, the API is divided into domains. Each domain is specified

+ in a separate section below. The specifications of the API’s refer to data

+ structures beyond the standard JSON primitives. These data structures are

documented in the section titled <a href="#types">Types</a>.

-

- To get an overview of the API, you can consult the <a href="#index">index</a>.

-

+ <toc></toc>

<h3>Command-line Arguments</h3>

The command-line arguments that can be passed to the server.

@@ -169,9 +159,9 @@

</dd>

</dl>

<dl>

- <dt>--no-error-notification</dt>

+ <dt class="deprecated">--no-error-notification</dt>

<dd>

- Deprecated

+ @deprecated: clients should no longer pass this option in

Disable notifications about errors (see analysis.error). If this

flag is not specified then notifications will be sent for all

errors produced for all files in the actual analysis roots.

@@ -188,9 +178,9 @@

</dd>

</dl>

<dl>

- <dt>--file-read-mode</dt>

+ <dt class="deprecated">--file-read-mode</dt>

<dd>

- Deprecated

+ @deprecated: clients should no longer pass this option in

An enumeration of the ways files can be read from disk. Some clients

normalize end of line characters which would make the file offset and

range information incorrect. The default option is <tt>as-is</tt>, but

@@ -205,6 +195,7 @@

</dd>

</dl>

</blockquote>

+ <domains></domains>

The server domain contains API’s related to the execution of

@@ -811,8 +802,8 @@

</result>

</request>

- <request method="updateOptions">

- Deprecated: all of the options can be set by users in

+ <request method="updateOptions" deprecated="true">

+ @deprecated: all of the options can be set by users in

an analysis options file.

Update the options controlling analysis based on the given

@@ -2022,9 +2013,9 @@

</field>

</result>

</request>

- <request method="setSubscriptions">

+ <request method="setSubscriptions" deprecated="true">

- Deprecated: the analysis server no longer fires

+ @deprecated: the analysis server no longer fires

<tt>LAUNCH_DATA</tt> events.

@@ -2242,8 +2233,8 @@

</enum>

</type>

- <type name="AnalysisOptions">

- Deprecated: the only reference to this type has been

+ <type name="AnalysisOptions" deprecated="true">

+ @deprecated: the only reference to this type has been

deprecated.

A set of options controlling what kind of analysis is to be

@@ -2251,33 +2242,33 @@

option will not be changed.

- <field name="enableAsync" optional="true">

+ <field name="enableAsync" optional="true" deprecated="true">

- Deprecated: this feature is always enabled.

+ @deprecated: this feature is always enabled.

True if the client wants to enable support for the

proposed async feature.

</field>

- <field name="enableDeferredLoading" optional="true">

+ <field name="enableDeferredLoading" optional="true" deprecated="true">

- Deprecated: this feature is always enabled.

+ @deprecated: this feature is always enabled.

True if the client wants to enable support for the

proposed deferred loading feature.

</field>

- <field name="enableEnums" optional="true">

+ <field name="enableEnums" optional="true" deprecated="true">

- Deprecated: this feature is always enabled.

+ @deprecated: this feature is always enabled.

True if the client wants to enable support for the

proposed enum feature.

</field>

- <field name="enableNullAwareOperators" optional="true">

+ <field name="enableNullAwareOperators" optional="true" deprecated="true">

- Deprecated: this feature is always enabled.

+ @deprecated: this feature is always enabled.

True if the client wants to enable support for the

proposed "null aware operators" feature.

@@ -2745,13 +2736,13 @@

<value><code>SETTER</code></value>

<value><code>TOP_LEVEL_VARIABLE</code></value>

<value><code>TYPE_PARAMETER</code></value>

- <value>

+ <value deprecated="true">

<code>UNIT_TEST_GROUP</code>

- Deprecated: support for tests was removed.

+ @deprecated: support for tests was removed.

</value>

- <value>

+ <value deprecated="true">

- Deprecated: support for tests was removed.

+ @deprecated: support for tests was removed.

</value>

<value><code>UNKNOWN</code></value>

</enum>