Skip to content

Commit 093ab49

Browse files
srawlinsCommit Queue
authored andcommitted
DAS: Correct several broken comment references
Change-Id: Id0e80d5566a5c05296a5941746888a48284c4ae0 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/407861 Reviewed-by: Phil Quitslund <[email protected]> Commit-Queue: Samuel Rawlins <[email protected]> Reviewed-by: Brian Wilkerson <[email protected]>
1 parent 03c0855 commit 093ab49

File tree

7 files changed

+21
-20
lines changed

7 files changed

+21
-20
lines changed

pkg/analysis_server/lib/src/analysis_server.dart

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ typedef UserPromptSender =
107107
);
108108

109109
/// Implementations of [AnalysisServer] implement a server that listens
110-
/// on a [CommunicationChannel] for analysis messages and process them.
110+
/// on an [AbstractNotificationManager] for analysis messages and process them.
111111
abstract class AnalysisServer {
112112
/// A flag indicating whether plugins are supported in this build.
113113
static final bool supportsPlugins = true;
@@ -418,7 +418,7 @@ abstract class AnalysisServer {
418418
///
419419
/// Request handlers should be careful to use the correct clients capabilities
420420
/// if they are available to non-editor clients (such as over DTD). The
421-
/// capabilities of the caller are available in [MessageInfo] and should
421+
/// capabilities of the caller are available in [lsp.MessageInfo] and should
422422
/// usually be used when computing the results for requests, but if those
423423
/// requests additionally trigger requests to the editor, those requests to
424424
/// the editor should consider these capabilities.
@@ -437,7 +437,7 @@ abstract class AnalysisServer {
437437
/// A [Future] that completes when the LSP server moves into the initialized
438438
/// state and can handle normal LSP requests.
439439
///
440-
/// Completes with the [InitializedStateMessageHandler] that is active.
440+
/// Completes with the [lsp.InitializedStateMessageHandler] that is active.
441441
///
442442
/// When the server leaves the initialized state, [lspUninitialized] will
443443
/// complete.
@@ -493,8 +493,8 @@ abstract class AnalysisServer {
493493

494494
void afterContextsDestroyed() {}
495495

496-
/// Broadcast a request built from the given [params] to all of the plugins
497-
/// that are currently associated with the context root from the given
496+
/// Broadcast a request built from the given [requestParams] to all of the
497+
/// plugins that are currently associated with the context root from the given
498498
/// [driver]. Return a list containing futures that will complete when each of
499499
/// the plugins have sent a response, or an empty list if no [driver] is
500500
/// provided.

pkg/analysis_server/lib/src/services/search/element_visitors.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ class _ElementByNameOffsetVisitor extends GeneralizingElementVisitor<void> {
7878
}
7979
}
8080

81-
/// A [GeneralizingElementVisitor] adapter for [ElementProcessor].
81+
/// A [GeneralizingElementVisitor] adapter for [BoolElementProcessor].
8282
class _ElementVisitorAdapter extends GeneralizingElementVisitor<void> {
8383
final BoolElementProcessor processor;
8484

pkg/analysis_server/lib/src/services/search/hierarchy.dart

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -87,12 +87,8 @@ List<Element2> getExtensionMembers(
8787
return members;
8888
}
8989

90-
/// Return all implementations of the given [member], including in its
90+
/// Returns all implementations of the given [member], including in its
9191
/// superclasses and their subclasses.
92-
///
93-
/// If [includeParametersForFields] is true and [member] is a [FieldElement2],
94-
/// any [FieldFormalParameterElement2]s for the member will also be provided
95-
/// (otherwise, the parameter set will be empty in the result).
9692
Future<Set<Element2>> getHierarchyMembers(
9793
SearchEngine searchEngine,
9894
Element2 member, {
@@ -106,10 +102,10 @@ Future<Set<Element2>> getHierarchyMembers(
106102
return members;
107103
}
108104

109-
/// Return all implementations of the given [member], including in its
105+
/// Returns all implementations of the given [member2], including in its
110106
/// superclasses and their subclasses.
111107
///
112-
/// If [includeParametersForFields] is true and [member] is a [FieldElement2],
108+
/// If [includeParametersForFields] is true and [member2] is a [FieldElement2],
113109
/// any [FieldFormalParameterElement2]s for the member will also be provided
114110
/// (otherwise, the parameter set will be empty in the result).
115111
Future<(Set<Element2>, Set<FormalParameterElement>)>

pkg/analysis_server/lib/src/status/element_writer.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ class ElementWriter with TreeWriter {
3131
}
3232
}
3333

34-
/// Write a representation of the properties of the given [node] to the
34+
/// Writes a representation of the properties of the given [element] to the
3535
/// buffer.
3636
Map<String, Object?> _computeProperties(Element2 element) {
3737
var properties = <String, Object?>{};

pkg/analysis_server/lib/src/status/tree_writer.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ mixin TreeWriter {
8888
return null;
8989
}
9090

91-
/// Write the [value] of the property with the given [name].
91+
/// Writes the [value] of the property.
9292
void _writePropertyValue(Object value, int baseIndent) {
9393
if (value is List<Object>) {
9494
if (value.isEmpty) {

pkg/analysis_server/lib/src/utilities/import_analyzer.dart

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,11 @@ class ImportAnalyzer {
3434
/// the set of imports used to reference those declarations.
3535
final Map<Element2, Set<LibraryImport>> stayingReferences = {};
3636

37-
/// Analyze the given library [result] to find the declarations and references
38-
/// being moved and that are staying. The declarations being moved are in the
39-
/// file at the given [path] in the given [range].
37+
/// Analyzes the given library [result] to find the declarations and
38+
/// references being moved and that are staying.
39+
///
40+
/// The declarations being moved are in the file at the given [path] in the
41+
/// given [ranges].
4042
ImportAnalyzer(this.result, String path, List<SourceRange> ranges) {
4143
for (var unit in result.units) {
4244
var finder = _ReferenceFinder(
@@ -92,7 +94,7 @@ class _ElementRecorder {
9294

9395
/// Initialize a newly created recorder to use the [analyzer] to record
9496
/// declarations of and references to elements, based on whether the reference
95-
/// is within the [range].
97+
/// is within the [ranges].
9698
_ElementRecorder(this.analyzer, this.ranges);
9799

98100
/// Record that the [declaredElement] is declared in the library.
@@ -174,7 +176,7 @@ class _ReferenceFinder extends RecursiveAstVisitor<void> {
174176
/// empty string is used for unprefixed imports.
175177
///
176178
/// Library imports are ordered the same as they appear in the source file
177-
/// (since this is a [LinkedHashSet]).
179+
/// (since this is a `LinkedHashSet`).
178180
final _importsByPrefix = <String, Set<LibraryImport>>{};
179181

180182
/// Initialize a newly created finder to send information to the [recorder].

pkg/analysis_server/lib/src/utilities/mocks.dart

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
// for details. All rights reserved. Use of this source code is governed by a
33
// BSD-style license that can be found in the LICENSE file.
44

5+
/// @docImport 'package:analysis_server/src/analysis_server.dart';
6+
library;
7+
58
import 'dart:async';
69
import 'dart:convert';
710

0 commit comments

Comments
 (0)