From 8ee08e11287bd0bb790db0d4db03b097ec2d2dbb Mon Sep 17 00:00:00 2001 From: Brian Wilkerson Date: Tue, 26 Jan 2021 00:03:16 +0000 Subject: [PATCH] Clean up some docs from the analyzer_plugin package Change-Id: Iea3e8233641fb294ca1006a7b68178c439cc5e4f Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/180780 Auto-Submit: Brian Wilkerson Commit-Queue: Konstantin Shcheglov Reviewed-by: Konstantin Shcheglov --- pkg/analyzer_plugin/doc/tutorial/assists.md | 2 +- pkg/analyzer_plugin/doc/tutorial/fixes.md | 3 +-- pkg/analyzer_plugin/doc/tutorial/package_structure.md | 2 +- pkg/analyzer_plugin/lib/plugin/plugin.dart | 3 ++- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/pkg/analyzer_plugin/doc/tutorial/assists.md b/pkg/analyzer_plugin/doc/tutorial/assists.md index dd38b781ed6..2be0e4df44f 100644 --- a/pkg/analyzer_plugin/doc/tutorial/assists.md +++ b/pkg/analyzer_plugin/doc/tutorial/assists.md @@ -102,7 +102,7 @@ class MyPlugin extends ServerPlugin with AssistsMixin, DartAssistsMixin { // ... @override - List getAssistContributors(AnalysisDriver driver) { + List getAssistContributors(String path) { return [MyAssistContributor()]; } } diff --git a/pkg/analyzer_plugin/doc/tutorial/fixes.md b/pkg/analyzer_plugin/doc/tutorial/fixes.md index efe2537e37d..b77e517ff38 100644 --- a/pkg/analyzer_plugin/doc/tutorial/fixes.md +++ b/pkg/analyzer_plugin/doc/tutorial/fixes.md @@ -117,8 +117,7 @@ class MyPlugin extends ServerPlugin with FixesMixin, DartFixesMixin { // ... @override - List getFixContributors( - AnalysisDriverGeneric driver) { + List getFixContributors(String path) { return [MyFixContributor()]; } } diff --git a/pkg/analyzer_plugin/doc/tutorial/package_structure.md b/pkg/analyzer_plugin/doc/tutorial/package_structure.md index 19638928f0f..c2443ecd595 100644 --- a/pkg/analyzer_plugin/doc/tutorial/package_structure.md +++ b/pkg/analyzer_plugin/doc/tutorial/package_structure.md @@ -56,7 +56,7 @@ analyzer: If a listed host package can be found (via the `.packages` file associated with the target package), then the tool looks in the host package for the folder -`/tools/analysis_plugin`. If that directory exists and contains a +`/tools/analyzer_plugin`. If that directory exists and contains a valid bootstrap package, then the bootstrap package is run as a plugin. ## Bootstrap Package Structure diff --git a/pkg/analyzer_plugin/lib/plugin/plugin.dart b/pkg/analyzer_plugin/lib/plugin/plugin.dart index 97593682822..cdf8829210b 100644 --- a/pkg/analyzer_plugin/lib/plugin/plugin.dart +++ b/pkg/analyzer_plugin/lib/plugin/plugin.dart @@ -95,7 +95,8 @@ abstract class ServerPlugin { /// Return the SDK manager used to manage SDKs. DartSdkManager get sdkManager => _sdkManager; - /// Return the version number of this plugin, encoded as a string. + /// Return the version number of the plugin spec required by this plugin, + /// encoded as a string. String get version; /// Handle the fact that the file with the given [path] has been modified.