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

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

Issue 2947743002: Add support to pass the location of the analysis options file to plugins (Closed)
Patch Set: Created 3 years, 6 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
Index: pkg/analyzer_plugin/doc/api.html
diff --git a/pkg/analyzer_plugin/doc/api.html b/pkg/analyzer_plugin/doc/api.html
index ba4607baa48f659dcb8f0b23a473e6a70d110740..76b10252845df422cffea0995529fa084b5a1ee9 100644
--- a/pkg/analyzer_plugin/doc/api.html
+++ b/pkg/analyzer_plugin/doc/api.html
@@ -141,8 +141,8 @@ a:focus, a:hover {
"id": String
"method": "plugin.versionCheck"
"params": {
- "<b>byteStorePath</b>": String
- "<b>sdkPath</b>": String
+ "<b>byteStorePath</b>": <a href="#type_FilePath">FilePath</a>
+ "<b>sdkPath</b>": <a href="#type_FilePath">FilePath</a>
"<b>version</b>": String
}
}</pre><br><pre>response: {
@@ -162,13 +162,13 @@ a:focus, a:hover {
</p>
- <h4>parameters:</h4><dl><dt class="field"><b>byteStorePath: String</b></dt><dd>
+ <h4>parameters:</h4><dl><dt class="field"><b>byteStorePath: <a href="#type_FilePath">FilePath</a></b></dt><dd>
<p>
The path to the directory containing the on-disk byte store that is to
be used by any analysis drivers that are created.
</p>
- </dd><dt class="field"><b>sdkPath: String</b></dt><dd>
+ </dd><dt class="field"><b>sdkPath: <a href="#type_FilePath">FilePath</a></b></dt><dd>
<p>
The path to the directory containing the SDK that is to be used by any
@@ -1369,14 +1369,14 @@ a:focus, a:hover {
The options used to build an analysis context.
</p>
- <dl><dt class="field"><b>dartSdkSummaryPath: String<span style="color:#999999"> (optional)</span></b></dt><dd>
+ <dl><dt class="field"><b>dartSdkSummaryPath: <a href="#type_FilePath">FilePath</a><span style="color:#999999"> (optional)</span></b></dt><dd>
<p>
The file path of the file containing the summary of the SDK that
should be used to "analyze" the SDK. The field will be omitted if the
summary should be found in the SDK.
</p>
- </dd><dt class="field"><b>defaultAnalysisOptionsFilePath: List&lt;String&gt;<span style="color:#999999"> (optional)</span></b></dt><dd>
+ </dd><dt class="field"><b>defaultAnalysisOptionsFilePath: List&lt;<a href="#type_FilePath">FilePath</a>&gt;<span style="color:#999999"> (optional)</span></b></dt><dd>
<p>
The file path of the analysis options file that should be used in
@@ -1391,7 +1391,7 @@ a:focus, a:hover {
The field will be omitted if no additional variables need to be
declared.
</p>
- </dd><dt class="field"><b>defaultPackageFilePath: List&lt;String&gt;<span style="color:#999999"> (optional)</span></b></dt><dd>
+ </dd><dt class="field"><b>defaultPackageFilePath: List&lt;<a href="#type_FilePath">FilePath</a>&gt;<span style="color:#999999"> (optional)</span></b></dt><dd>
<p>
The file path of the .packages file that should be used in place of
@@ -1399,7 +1399,7 @@ a:focus, a:hover {
mechanism. The field will be omitted if the normal lookup mechanism
should be used.
</p>
- </dd><dt class="field"><b>defaultPackagesDirectoryPath: List&lt;String&gt;<span style="color:#999999"> (optional)</span></b></dt><dd>
+ </dd><dt class="field"><b>defaultPackagesDirectoryPath: List&lt;<a href="#type_FilePath">FilePath</a>&gt;<span style="color:#999999"> (optional)</span></b></dt><dd>
<p>
The file path of the packages directory that should be used in place
@@ -1412,18 +1412,24 @@ a:focus, a:hover {
A description of an analysis context.
</p>
- <dl><dt class="field"><b>root: String</b></dt><dd>
+ <dl><dt class="field"><b>root: <a href="#type_FilePath">FilePath</a></b></dt><dd>
<p>
The absolute path of the root directory containing the files to be
analyzed.
</p>
- </dd><dt class="field"><b>exclude: List&lt;String&gt;</b></dt><dd>
+ </dd><dt class="field"><b>exclude: List&lt;<a href="#type_FilePath">FilePath</a>&gt;</b></dt><dd>
<p>
A list of the absolute paths of files and directories within the root
directory that should not be analyzed.
</p>
+ </dd><dt class="field"><b>optionsFile: <a href="#type_FilePath">FilePath</a><span style="color:#999999"> (optional)</span></b></dt><dd>
+
+ <p>
+ The absolute path of the analysis options file that should be used to
+ control the analysis of the files in the context.
+ </p>
</dd></dl></dd><dt class="typeDefinition"><a name="type_Element">Element: object</a></dt><dd>
<p>
Information about an element (something that can be declared in code).
@@ -2221,7 +2227,7 @@ a:focus, a:hover {
<p>
The type of change represented by this event.
</p>
- </dd><dt class="field"><b>path: String</b></dt><dd>
+ </dd><dt class="field"><b>path: <a href="#type_FilePath">FilePath</a></b></dt><dd>
<p>
The absolute path of the file or directory that changed.
« no previous file with comments | « pkg/analyzer/lib/source/analysis_options_provider.dart ('k') | pkg/analyzer_plugin/lib/protocol/protocol_generated.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698