pkg/analysis_server/doc/api.html - Issue 531153002: Clarify type names in analysis server API.

Unified Diff: pkg/analysis_server/doc/api.html

Issue 531153002: Clarify type names in analysis server API. (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart

Patch Set: Created 6 years, 3 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

Download patch

« no previous file with comments | « editor/tools/plugins/com.google.dart.tools.ui/src/com/google/dart/tools/ui/internal/text/correction/QuickFixProcessor_OLD.java ('k') | pkg/analysis_server/lib/src/edit/edit_domain.dart » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: pkg/analysis_server/doc/api.html

diff --git a/pkg/analysis_server/doc/api.html b/pkg/analysis_server/doc/api.html

index 330806b8d2d74caf17d1a6e603f50484200ab143..26285ad2bb0dde2a52351a6ffbf539bd1a0bce64 100644

--- a/pkg/analysis_server/doc/api.html

+++ b/pkg/analysis_server/doc/api.html

@@ -1344,7 +1344,7 @@ dt.typeDefinition {

"id": String

"error": optional <a href="#type_RequestError">RequestError</a>

"result": {

- "fixes": List<<a href="#type_ErrorFixes">ErrorFixes</a>>

+ "fixes": List<<a href="#type_AnalysisErrorFixes">AnalysisErrorFixes</a>>

}

}</pre></div>

@@ -1365,7 +1365,7 @@ dt.typeDefinition {

The offset used to select the errors for which fixes

will be returned.

- </dd></dl><h4>Returns</h4><dl><dt class="field">fixes ( List<<a href="#type_ErrorFixes">ErrorFixes</a>> )</dt><dd>

+ </dd></dl><h4>Returns</h4><dl><dt class="field">fixes ( List<<a href="#type_AnalysisErrorFixes">AnalysisErrorFixes</a>> )</dt><dd>

The fixes that are available for each of the analysis

@@ -1741,12 +1741,12 @@ dt.typeDefinition {

by the analysis.

- <dl><dt class="field">severity ( <a href="#type_ErrorSeverity">ErrorSeverity</a> )</dt><dd>

+ <dl><dt class="field">severity ( <a href="#type_AnalysisErrorSeverity">AnalysisErrorSeverity</a> )</dt><dd>

The severity of the error.

- </dd><dt class="field">type ( <a href="#type_ErrorType">ErrorType</a> )</dt><dd>

+ </dd><dt class="field">type ( <a href="#type_AnalysisErrorType">AnalysisErrorType</a> )</dt><dd>

The type of the error.

@@ -1771,7 +1771,33 @@ dt.typeDefinition {

the error. The field is omitted if there is no correction

message associated with the error code.

- </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisOptions">AnalysisOptions: object</a></dt><dd>

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorFixes">AnalysisErrorFixes: object</a></dt><dd>

+

+ A list of fixes associated with a specific error

+

+ <dl><dt class="field">error ( <a href="#type_AnalysisError">AnalysisError</a> )</dt><dd>

+

+ The error with which the fixes are associated.

+

+ </dd><dt class="field">fixes ( List<<a href="#type_SourceChange">SourceChange</a>> )</dt><dd>

+

+ The fixes associated with the error.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorSeverity">AnalysisErrorSeverity: String</a></dt><dd>

+

+ An enumeration of the possible severities of analysis

+ errors.

+

+ <dl><dt class="value">INFO</dt><dt class="value">WARNING</dt><dt class="value">ERROR</dt></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorType">AnalysisErrorType: String</a></dt><dd>

+

+ An enumeration of the possible types of analysis errors.

+

+ <dl><dt class="value">COMPILE_TIME_ERROR</dt><dt class="value">HINT</dt><dt class="value">STATIC_TYPE_WARNING</dt><dt class="value">STATIC_WARNING</dt><dt class="value">SYNTACTIC_ERROR</dt><dt class="value">TODO</dt></dl></dd><dt class="typeDefinition"><a name="type_AnalysisOptions">AnalysisOptions: object</a></dt><dd>

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

performed. If the value of a field is omitted the value of the

@@ -2054,33 +2080,7 @@ dt.typeDefinition {

An enumeration of the kinds of elements.

- <dl><dt class="value">CLASS</dt><dt class="value">CLASS_TYPE_ALIAS</dt><dt class="value">COMPILATION_UNIT</dt><dt class="value">CONSTRUCTOR</dt><dt class="value">FIELD</dt><dt class="value">FUNCTION</dt><dt class="value">FUNCTION_TYPE_ALIAS</dt><dt class="value">GETTER</dt><dt class="value">LIBRARY</dt><dt class="value">LOCAL_VARIABLE</dt><dt class="value">METHOD</dt><dt class="value">PARAMETER</dt><dt class="value">SETTER</dt><dt class="value">TOP_LEVEL_VARIABLE</dt><dt class="value">TYPE_PARAMETER</dt><dt class="value">UNIT_TEST_GROUP</dt><dt class="value">UNIT_TEST_TEST</dt><dt class="value">UNKNOWN</dt></dl></dd><dt class="typeDefinition"><a name="type_ErrorFixes">ErrorFixes: object</a></dt><dd>

-

- A list of fixes associated with a specific error

-

- <dl><dt class="field">error ( <a href="#type_AnalysisError">AnalysisError</a> )</dt><dd>

-

- The error with which the fixes are associated.

-

- </dd><dt class="field">fixes ( List<<a href="#type_SourceChange">SourceChange</a>> )</dt><dd>

-

- The fixes associated with the error.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_ErrorSeverity">ErrorSeverity: String</a></dt><dd>

-

- An enumeration of the possible severities of analysis

- errors.

-

- <dl><dt class="value">INFO</dt><dt class="value">WARNING</dt><dt class="value">ERROR</dt></dl></dd><dt class="typeDefinition"><a name="type_ErrorType">ErrorType: String</a></dt><dd>

-

- An enumeration of the possible types of analysis errors.

-

- <dl><dt class="value">COMPILE_TIME_ERROR</dt><dt class="value">HINT</dt><dt class="value">STATIC_TYPE_WARNING</dt><dt class="value">STATIC_WARNING</dt><dt class="value">SYNTACTIC_ERROR</dt><dt class="value">TODO</dt></dl></dd><dt class="typeDefinition"><a name="type_ExecutableFile">ExecutableFile: object</a></dt><dd>

+ <dl><dt class="value">CLASS</dt><dt class="value">CLASS_TYPE_ALIAS</dt><dt class="value">COMPILATION_UNIT</dt><dt class="value">CONSTRUCTOR</dt><dt class="value">FIELD</dt><dt class="value">FUNCTION</dt><dt class="value">FUNCTION_TYPE_ALIAS</dt><dt class="value">GETTER</dt><dt class="value">LIBRARY</dt><dt class="value">LOCAL_VARIABLE</dt><dt class="value">METHOD</dt><dt class="value">PARAMETER</dt><dt class="value">SETTER</dt><dt class="value">TOP_LEVEL_VARIABLE</dt><dt class="value">TYPE_PARAMETER</dt><dt class="value">UNIT_TEST_GROUP</dt><dt class="value">UNIT_TEST_TEST</dt><dt class="value">UNKNOWN</dt></dl></dd><dt class="typeDefinition"><a name="type_ExecutableFile">ExecutableFile: object</a></dt><dd>

A description of an executable file.