pkg/analysis_server/doc/api.html - Issue 825393005: Addition of the optional FileReadMode into the server spec.

Side by Side Diff: pkg/analysis_server/doc/api.html

Issue 825393005: Addition of the optional FileReadMode into the server spec. (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart

Patch Set: Created 5 years, 11 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 | Annotate | Revision Log

« no previous file with comments | « editor/tools/plugins/com.google.dart.tools.core/src/com/google/dart/tools/core/internal/analysis/model/AnalysisServerDataImpl.java ('k') | pkg/analysis_server/lib/src/generated_protocol.dart » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

OLD	NEW
1 <html><head>	1 <html><head>

2 <meta charset="UTF-8">	2 <meta charset="UTF-8">

3 <title>Analysis Server API Specification</title>	3 <title>Analysis Server API Specification</title>

4 <style>body {	4 <style>body {

5 font-family: sans-serif, serif;	5 font-family: sans-serif, serif;

6 padding-left: 5%;	6 padding-left: 5%;

7 padding-right: 5%;	7 padding-right: 5%;

8 }	8 }

9 h1 {	9 h1 {

10 text-align: center;	10 text-align: center;

(...skipping 1989 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
2000	2000

2001	2001

2002	2002

2003	2003

2004	2004

2005	2005

2006	2006

2007	2007

2008	2008

2009	2009

	2010

2010 <dl><dt class="typeDefinition"><a name="type_AddContentOverlay">AddContentOv erlay: object</a></dt><dd>	2011 <dl><dt class="typeDefinition"><a name="type_AddContentOverlay">AddContentOv erlay: object</a></dt><dd>

2011 <p>	2012 <p>

2012 A directive to begin overlaying the contents of a file. The	2013 A directive to begin overlaying the contents of a file. The

2013 supplied content will be used for analysis in place of the	2014 supplied content will be used for analysis in place of the

2014 file contents in the filesystem.	2015 file contents in the filesystem.

2015 </p>	2016 </p>

2016 <p>	2017 <p>

2017 If this directive is used on a file that already has a file	2018 If this directive is used on a file that already has a file

2018 content overlay, the old overlay is discarded and replaced	2019 content overlay, the old overlay is discarded and replaced

2019 with the new one.	2020 with the new one.

(...skipping 105 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
2125 <p>	2126 <p>

2126 True if hints should be generated as part of generating	2127 True if hints should be generated as part of generating

2127 errors and warnings.	2128 errors and warnings.

2128 </p>	2129 </p>

2129 </dd><dt class="field"><b><i>generateLints ( <span style="color:#99999 9">optional</span> bool )</i></b></dt><dd>	2130 </dd><dt class="field"><b><i>generateLints ( <span style="color:#99999 9">optional</span> bool )</i></b></dt><dd>

2130	2131

2131 <p>	2132 <p>

2132 True if lints should be generated as part of generating	2133 True if lints should be generated as part of generating

2133 errors and warnings.	2134 errors and warnings.

2134 </p>	2135 </p>

	2136 </dd><dt class="field"><b><i>fileReadMode ( <span style="color:#999999 ">optional</span> <a href="#type_FileReadMode">FileReadMode</a> )</i></b></dt><d d>

	2137

	2138 <p>

	2139 The mode to read files from disk, by default this value is AS_IS.

	2140 </p>

2135 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisServic e">AnalysisService: String</a></dt><dd>	2141 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisServic e">AnalysisService: String</a></dt><dd>

2136 <p>	2142 <p>

2137 An enumeration of the services provided by the analysis	2143 An enumeration of the services provided by the analysis

2138 domain.	2144 domain.

2139 </p>	2145 </p>

2140	2146

2141 <dl><dt class="value">FOLDING</dt><dt class="value">HIGHLIGHTS</dt><dt cla ss="value">INVALIDATE</dt><dt class="value">NAVIGATION</dt><dt class="value">OCC URRENCES</dt><dt class="value">OUTLINE</dt><dt class="value">OVERRIDES</dt></dl> </dd><dt class="typeDefinition"><a name="type_AnalysisStatus">AnalysisStatus: ob ject</a></dt><dd>	2147 <dl><dt class="value">FOLDING</dt><dt class="value">HIGHLIGHTS</dt><dt cla ss="value">INVALIDATE</dt><dt class="value">NAVIGATION</dt><dt class="value">OCC URRENCES</dt><dt class="value">OUTLINE</dt><dt class="value">OVERRIDES</dt></dl> </dd><dt class="typeDefinition"><a name="type_AnalysisStatus">AnalysisStatus: ob ject</a></dt><dd>

2142 <p>	2148 <p>

2143 An indication of the current state of analysis.	2149 An indication of the current state of analysis.

2144 </p>	2150 </p>

(...skipping 288 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
2433 <p>	2439 <p>

2434 An enumeration of the services provided by the execution	2440 An enumeration of the services provided by the execution

2435 domain.	2441 domain.

2436 </p>	2442 </p>

2437	2443

2438 <dl><dt class="value">LAUNCH_DATA</dt></dl></dd><dt class="typeDefinition" ><a name="type_FilePath">FilePath: String</a></dt><dd>	2444 <dl><dt class="value">LAUNCH_DATA</dt></dl></dd><dt class="typeDefinition" ><a name="type_FilePath">FilePath: String</a></dt><dd>

2439	2445

2440 <p>	2446 <p>

2441 The absolute path of a file.	2447 The absolute path of a file.

2442 </p>	2448 </p>

2443 </dd><dt class="typeDefinition"><a name="type_FoldingKind">FoldingKind: St ring</a></dt><dd>	2449 </dd><dt class="typeDefinition"><a name="type_FileReadMode">FileReadMode: String</a></dt><dd>

	2450 <p>

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

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

	2453 range information incorrect.

	2454 </p>

	2455

	2456 <dl><dt class="value">AS_IS</dt><dd>

	2457

	2458 <p>

	2459 File contents are read as-is, no file changes occur.

	2460 </p>

	2461 </dd><dt class="value">NORMALIZE_EOL</dt><dd>

	2462

	2463 <p>

	2464 File contents normalize the end of line characters to the single

	2465 character new line '\n'.

	2466 </p>

	2467 </dd></dl></dd><dt class="typeDefinition"><a name="type_FoldingKind">F oldingKind: String</a></dt><dd>

2444 <p>	2468 <p>

2445 An enumeration of the kinds of folding regions.	2469 An enumeration of the kinds of folding regions.

2446 </p>	2470 </p>

2447	2471

2448 <dl><dt class="value">COMMENT</dt><dt class="value">CLASS_MEMBER</dt><dt c lass="value">DIRECTIVES</dt><dt class="value">DOCUMENTATION_COMMENT</dt><dt clas s="value">TOP_LEVEL_DECLARATION</dt></dl></dd><dt class="typeDefinition"><a name ="type_FoldingRegion">FoldingRegion: object</a></dt><dd>	2472 <dl><dt class="value">COMMENT</dt><dt class="value">CLASS_MEMBER</dt><dt c lass="value">DIRECTIVES</dt><dt class="value">DOCUMENTATION_COMMENT</dt><dt clas s="value">TOP_LEVEL_DECLARATION</dt></dl></dd><dt class="typeDefinition"><a name ="type_FoldingRegion">FoldingRegion: object</a></dt><dd>

2449 <p>	2473 <p>

2450 A description of a region that can be folded.	2474 A description of a region that can be folded.

2451 </p>	2475 </p>

2452	2476

2453 <dl><dt class="field"><b><i>kind ( <a href="#type_FoldingKind">FoldingKind </a> )</i></b></dt><dd>	2477 <dl><dt class="field"><b><i>kind ( <a href="#type_FoldingKind">FoldingKind </a> )</i></b></dt><dd>

(...skipping 1155 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
3609 <p>	3633 <p>

3610 This section contains a list of all of the errors that are	3634 This section contains a list of all of the errors that are

3611 produced by the server and the data that is returned with each.	3635 produced by the server and the data that is returned with each.

3612 </p>	3636 </p>

3613 <p>	3637 <p>

3614 TBD	3638 TBD

3615 </p>	3639 </p>

3616	3640

3617	3641

3618 </body></html>	3642 </body></html>

OLD	NEW