analyzer: Fix 40 broken comment references

srawlins · Commit Queue · commit 09b4ec74459a · 2024-10-31T16:28:07.000Z
Change-Id: I91c6ae9473cc6cdde1b5131a349c2701e51a1aaf Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/392800 Reviewed-by: Phil Quitslund <pquitslund@google.com> Commit-Queue: Samuel Rawlins <srawlins@google.com>
diff --git a/pkg/analyzer/lib/src/analysis_options/error/option_codes.g.dart b/pkg/analyzer/lib/src/analysis_options/error/option_codes.g.dart
@@ -7,17 +7,17 @@
 // Instead modify 'pkg/analyzer/messages.yaml' and run
 // 'dart run pkg/analyzer/tool/messages/generate.dart' to update.
 
-// We allow some snake_case and SCREAMING_SNAKE_CASE identifiers in generated
-// code, as they match names declared in the source configuration files.
-// ignore_for_file: constant_identifier_names
-
 // While transitioning `HintCodes` to `WarningCodes`, we refer to deprecated
 // codes here.
 // ignore_for_file: deprecated_member_use_from_same_package
 //
 // Generated comments don't quite align with flutter style.
 // ignore_for_file: flutter_style_todos
 
+/// @docImport 'package:analyzer/src/dart/error/syntactic_errors.g.dart';
+/// @docImport 'package:analyzer/src/task/inference_error.dart';
+library;
+
 import "package:analyzer/error/error.dart";
 
 class AnalysisOptionsErrorCode extends ErrorCode {
diff --git a/pkg/analyzer/lib/src/dart/analysis/library_analyzer.dart b/pkg/analyzer/lib/src/dart/analysis/library_analyzer.dart
@@ -504,7 +504,7 @@ class LibraryAnalyzer {
       verifier.generateDuplicateExportWarnings(errorReporter);
       verifier.generateDuplicateImportWarnings(errorReporter);
       verifier.generateDuplicateShownHiddenNameWarnings(errorReporter);
-      verifier.generateUnusedImportHints(errorReporter);
+      verifier.generateUnusedImportWarnings(errorReporter);
       verifier.generateUnusedShownNameHints(errorReporter);
       verifier.generateUnnecessaryImportHints(errorReporter);
     }
diff --git a/pkg/analyzer/lib/src/dart/analysis/library_context.dart b/pkg/analyzer/lib/src/dart/analysis/library_context.dart
@@ -2,6 +2,9 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
+/// @docImport 'package:analyzer/src/generated/engine.dart';
+library;
+
 import 'dart:collection';
 import 'dart:typed_data';
 
diff --git a/pkg/analyzer/lib/src/dart/error/ffi_code.g.dart b/pkg/analyzer/lib/src/dart/error/ffi_code.g.dart
@@ -7,17 +7,17 @@
 // Instead modify 'pkg/analyzer/messages.yaml' and run
 // 'dart run pkg/analyzer/tool/messages/generate.dart' to update.
 
-// We allow some snake_case and SCREAMING_SNAKE_CASE identifiers in generated
-// code, as they match names declared in the source configuration files.
-// ignore_for_file: constant_identifier_names
-
 // While transitioning `HintCodes` to `WarningCodes`, we refer to deprecated
 // codes here.
 // ignore_for_file: deprecated_member_use_from_same_package
 //
 // Generated comments don't quite align with flutter style.
 // ignore_for_file: flutter_style_todos
 
+/// @docImport 'package:analyzer/src/dart/error/syntactic_errors.g.dart';
+/// @docImport 'package:analyzer/src/task/inference_error.dart';
+library;
+
 import "package:analyzer/error/error.dart";
 import "package:analyzer/src/error/analyzer_error_code.dart";
 
diff --git a/pkg/analyzer/lib/src/dart/error/hint_codes.g.dart b/pkg/analyzer/lib/src/dart/error/hint_codes.g.dart
@@ -7,17 +7,17 @@
 // Instead modify 'pkg/analyzer/messages.yaml' and run
 // 'dart run pkg/analyzer/tool/messages/generate.dart' to update.
 
-// We allow some snake_case and SCREAMING_SNAKE_CASE identifiers in generated
-// code, as they match names declared in the source configuration files.
-// ignore_for_file: constant_identifier_names
-
 // While transitioning `HintCodes` to `WarningCodes`, we refer to deprecated
 // codes here.
 // ignore_for_file: deprecated_member_use_from_same_package
 //
 // Generated comments don't quite align with flutter style.
 // ignore_for_file: flutter_style_todos
 
+/// @docImport 'package:analyzer/src/dart/error/syntactic_errors.g.dart';
+/// @docImport 'package:analyzer/src/task/inference_error.dart';
+library;
+
 import "package:analyzer/error/error.dart";
 import "package:analyzer/src/error/analyzer_error_code.dart";
 
diff --git a/pkg/analyzer/lib/src/dart/error/syntactic_errors.g.dart b/pkg/analyzer/lib/src/dart/error/syntactic_errors.g.dart
@@ -7,17 +7,17 @@
 // Instead modify 'pkg/analyzer/messages.yaml' and run
 // 'dart run pkg/analyzer/tool/messages/generate.dart' to update.
 
-// We allow some snake_case and SCREAMING_SNAKE_CASE identifiers in generated
-// code, as they match names declared in the source configuration files.
-// ignore_for_file: constant_identifier_names
-
 // While transitioning `HintCodes` to `WarningCodes`, we refer to deprecated
 // codes here.
 // ignore_for_file: deprecated_member_use_from_same_package
 //
 // Generated comments don't quite align with flutter style.
 // ignore_for_file: flutter_style_todos
 
+/// @docImport 'package:analyzer/src/dart/error/syntactic_errors.g.dart';
+/// @docImport 'package:analyzer/src/task/inference_error.dart';
+library;
+
 import "package:analyzer/error/error.dart";
 
 final fastaAnalyzerErrorCodes = <ErrorCode?>[
diff --git a/pkg/analyzer/lib/src/dart/resolver/exit_detector.dart b/pkg/analyzer/lib/src/dart/resolver/exit_detector.dart
@@ -645,8 +645,8 @@ class ExitDetector extends GeneralizingAstVisitor<bool> {
   @override
   bool visitYieldStatement(YieldStatement node) => _nodeExits(node.expression);
 
-  /// If the given [expression] has a known Boolean value, return the known
-  /// value, otherwise return `null`.
+  /// If the given [conditionExpression] has a known Boolean value, return the
+  /// known value, otherwise return `null`.
   bool? _knownConditionValue(Expression conditionExpression) {
     // TODO(jwren): Do we want to take all constant expressions into account?
     if (conditionExpression is BooleanLiteral) {
diff --git a/pkg/analyzer/lib/src/dart/resolver/scope.dart b/pkg/analyzer/lib/src/dart/resolver/scope.dart
@@ -185,7 +185,7 @@ class NamespaceBuilder {
   }
 
   /// Create a namespace representing the import namespace of the given
-  /// [element].
+  /// [importedLibrary].
   Namespace createImportNamespaceForDirective({
     required LibraryElement importedLibrary,
     required List<NamespaceCombinator> combinators,
diff --git a/pkg/analyzer/lib/src/dart/resolver/this_lookup.dart b/pkg/analyzer/lib/src/dart/resolver/this_lookup.dart
@@ -14,9 +14,11 @@ class ThisLookup {
     assert(false, 'Do not construct instances of LexicalLookup');
   }
 
-  /// Attempts to resolve an identifier with name [id] via implicit `this.`,
-  /// assuming we are trying to look up a getter.  If a matching element is
-  /// found, a [LexicalLookupResult] is returned.  Otherwise `null` is returned.
+  /// Attempts to resolve an identifier with name, `node.name`, via implicit
+  /// `this.`, assuming we are trying to look up a getter.
+  ///
+  /// If a matching element is found, a [LexicalLookupResult] is returned.
+  /// Otherwise `null` is returned.
   static LexicalLookupResult? lookupGetter(
       ResolverVisitor resolver, SimpleIdentifier node) {
     var id = node.name;
@@ -55,9 +57,11 @@ class ThisLookup {
     }
   }
 
-  /// Attempts to resolve an identifier with name [id] via implicit `this.`,
-  /// assuming we are trying to look up a setter.  If a matching element is
-  /// found, a [LexicalLookupResult] is returned.  Otherwise `null` is returned.
+  /// Attempts to resolve an identifier with name, `node.name`, via implicit
+  /// `this.`, assuming we are trying to look up a setter.
+  ///
+  /// If a matching element is found, a [LexicalLookupResult] is returned.
+  /// Otherwise `null` is returned.
   static LexicalLookupResult? lookupSetter(
       ResolverVisitor resolver, SimpleIdentifier node) {
     var id = node.name;
diff --git a/pkg/analyzer/lib/src/dart/sdk/sdk.dart b/pkg/analyzer/lib/src/dart/sdk/sdk.dart
@@ -2,6 +2,9 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
+/// @docImport 'package:analyzer/src/context/builder.dart';
+library;
+
 import 'dart:collection';
 import 'dart:io' as io;
 
diff --git a/pkg/analyzer/lib/src/diagnostic/diagnostic_factory.dart b/pkg/analyzer/lib/src/diagnostic/diagnostic_factory.dart
@@ -263,8 +263,6 @@ class DiagnosticFactory {
     );
   }
 
-  /// Return a diagnostic indicating that the [duplicateKey] (in a constant map)
-  /// is a duplicate of the [originalKey].
   AnalysisError invalidNullAwareAfterShortCircuit(Source source, int offset,
       int length, List<Object> arguments, Token previousToken) {
     var lexeme = previousToken.lexeme;
@@ -337,7 +335,7 @@ class DiagnosticFactory {
     );
   }
 
-  /// Return a diagnostic indicating that the given [identifier] was referenced
+  /// Return a diagnostic indicating that the given [nameToken] was referenced
   /// before it was declared.
   AnalysisError referencedBeforeDeclaration(
     Source source, {
diff --git a/pkg/analyzer/lib/src/error/best_practices_verifier.dart b/pkg/analyzer/lib/src/error/best_practices_verifier.dart
@@ -2,6 +2,9 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
+/// @docImport 'package:analyzer/src/dart/error/hint_codes.g.dart';
+library;
+
 import 'dart:collection';
 
 import 'package:analyzer/dart/analysis/analysis_options.dart';
@@ -1126,7 +1129,7 @@ class BestPracticesVerifier extends RecursiveAstVisitor<void> {
   /// @param importElement the [LibraryImportElement] retrieved from the node
   /// @return `true` if and only if an error code is generated on the passed
   ///         node
-  /// See [CompileTimeErrorCode.IMPORT_DEFERRED_LIBRARY_WITH_LOAD_FUNCTION].
+  /// See [HintCode.IMPORT_DEFERRED_LIBRARY_WITH_LOAD_FUNCTION].
   bool _checkForLoadLibraryFunction(
       ImportDirective node, LibraryImportElement importElement) {
     var importedLibrary = importElement.importedLibrary;
diff --git a/pkg/analyzer/lib/src/error/codes.g.dart b/pkg/analyzer/lib/src/error/codes.g.dart
@@ -7,17 +7,17 @@
 // Instead modify 'pkg/analyzer/messages.yaml' and run
 // 'dart run pkg/analyzer/tool/messages/generate.dart' to update.
 
-// We allow some snake_case and SCREAMING_SNAKE_CASE identifiers in generated
-// code, as they match names declared in the source configuration files.
-// ignore_for_file: constant_identifier_names
-
 // While transitioning `HintCodes` to `WarningCodes`, we refer to deprecated
 // codes here.
 // ignore_for_file: deprecated_member_use_from_same_package
 //
 // Generated comments don't quite align with flutter style.
 // ignore_for_file: flutter_style_todos
 
+/// @docImport 'package:analyzer/src/dart/error/syntactic_errors.g.dart';
+/// @docImport 'package:analyzer/src/task/inference_error.dart';
+library;
+
 import "package:analyzer/error/error.dart";
 import "package:analyzer/src/error/analyzer_error_code.dart";
 
@@ -7296,10 +7296,10 @@ class WarningCode extends AnalyzerErrorCode {
 
   ///  No parameters.
   ///
-  ///  There is also a [ParserError.EXPERIMENT_NOT_ENABLED] code which catches
-  ///  some cases of constructor tearoff features (like `List<int>.filled;`).
-  ///  Other constructor tearoff cases are not realized until resolution
-  ///  (like `List.filled;`).
+  ///  There is also a [ParserErrorCode.EXPERIMENT_NOT_ENABLED] code which
+  ///  catches some cases of constructor tearoff features (like
+  ///  `List<int>.filled;`). Other constructor tearoff cases are not realized
+  ///  until resolution (like `List.filled;`).
   static const WarningCode SDK_VERSION_CONSTRUCTOR_TEAROFFS = WarningCode(
     'SDK_VERSION_CONSTRUCTOR_TEAROFFS',
     "Tearing off a constructor requires the 'constructor-tearoffs' language "
diff --git a/pkg/analyzer/lib/src/error/error_handler_verifier.dart b/pkg/analyzer/lib/src/error/error_handler_verifier.dart
@@ -2,6 +2,9 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
+/// @docImport 'dart:async';
+library;
+
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/visitor.dart';
 import 'package:analyzer/dart/element/type.dart';
@@ -24,12 +27,12 @@ import 'package:collection/collection.dart';
 /// * as the first argument to [Future.catchError],
 /// * as the 'onError' named argument to [Future.then],
 /// * as the first argument to [Stream.handleError],
-/// * as the 'onError' named argument to [Future.onError],
+/// * as the 'onError' argument to [Stream.listen],
 /// * as the first argument to [StreamSubscription.onError],
 ///
 /// Additionally, a function passed as the first argument to
-/// [Future<T>.catchError] must return `FutureOr<T>`, and any return statements in a
-/// function literal must return a value of type `FutureOr<T>`.
+/// `Future<T>.catchError` must return `FutureOr<T>`, and any return statements
+/// in a function literal must return a value of type `FutureOr<T>`.
 class ErrorHandlerVerifier {
   final ErrorReporter _errorReporter;
 
@@ -256,7 +259,8 @@ class ErrorHandlerVerifier {
     }
   }
 
-  /// Returns whether [element] represents the []
+  /// Returns whether [type] represents the type named [typeName], declared in
+  /// the 'dart:async' library.
   bool _isDartCoreAsyncType(DartType type, String typeName) =>
       type is InterfaceType &&
       type.element.name == typeName &&
diff --git a/pkg/analyzer/lib/src/error/imports_verifier.dart b/pkg/analyzer/lib/src/error/imports_verifier.dart
@@ -11,11 +11,12 @@ import 'package:analyzer/src/error/codes.dart';
 
 /// Instances of the class `ImportsVerifier` visit all of the referenced
 /// libraries in the source code verifying that all of the imports are used,
-/// otherwise a [HintCode.UNUSED_IMPORT] hint is generated with
-/// [generateUnusedImportHints].
+/// otherwise a [WarningCode.UNUSED_IMPORT] hint is generated with
+/// [generateUnusedImportWarnings].
 ///
 /// Additionally, [generateDuplicateImportWarnings] generates
-/// [HintCode.DUPLICATE_IMPORT] hints and [HintCode.UNUSED_SHOWN_NAME] hints.
+/// [WarningCode.DUPLICATE_IMPORT] hints and [WarningCode.UNUSED_SHOWN_NAME]
+/// warnings.
 ///
 /// While this class does not yet have support for an "Organize Imports" action,
 /// this logic built up in this class could be used for such an action in the
@@ -34,11 +35,11 @@ class ImportsVerifier {
   /// from this list. After all the sources in the library have been evaluated,
   /// this list represents the set of unused imports.
   ///
-  /// See [ImportsVerifier.generateUnusedImportErrors].
+  /// See [generateUnusedImportWarnings].
   final Set<ImportDirective> _unusedImports = {};
 
-  /// After the list of [unusedImports] has been computed, this list is a proper
-  /// subset of the unused imports that are listed more than once.
+  /// After the list of [_unusedImports] has been computed, this list is a
+  /// proper subset of the unused imports that are listed more than once.
   final List<ImportDirective> _duplicateImports = [];
 
   /// This list is a proper subset of the unused exports that are listed more
@@ -234,8 +235,8 @@ class ImportsVerifier {
     }
   }
 
-  /// Report [WarningCode.UNUSED_IMPORT] for each unused import.
-  void generateUnusedImportHints(ErrorReporter errorReporter) {
+  /// Reports [WarningCode.UNUSED_IMPORT] for each unused import.
+  void generateUnusedImportWarnings(ErrorReporter errorReporter) {
     var importsTracking = fileAnalysis.importsTracking;
     for (var importDirective in fileAnalysis.unit.directives) {
       if (importDirective is ImportDirectiveImpl) {
@@ -276,7 +277,7 @@ class ImportsVerifier {
   /// Use the error [reporter] to report an [WarningCode.UNUSED_SHOWN_NAME]
   /// for each unused shown name.
   ///
-  /// This method should be invoked after [generateUnusedImportHints].
+  /// This method should be invoked after [generateUnusedImportWarnings].
   void generateUnusedShownNameHints(ErrorReporter reporter) {
     var importsTracking = fileAnalysis.importsTracking;
     for (var importDirective in fileAnalysis.unit.directives) {
diff --git a/pkg/analyzer/lib/src/error/must_call_super_verifier.dart b/pkg/analyzer/lib/src/error/must_call_super_verifier.dart
@@ -62,8 +62,8 @@ class MustCallSuperVerifier {
     }
   }
 
-  /// Find a method which is overridden by [node] and which is annotated with
-  /// `@mustCallSuper`.
+  /// Finds a method which is overridden by [element] and which is annotated
+  /// with `@mustCallSuper`.
   ///
   /// As per the definition of `mustCallSuper` [1], every method which overrides
   /// a method annotated with `@mustCallSuper` is implicitly annotated with
@@ -116,7 +116,7 @@ class MustCallSuperVerifier {
     return null;
   }
 
-  /// Returns whether [node] overrides a concrete method.
+  /// Returns whether [element] overrides a concrete method.
   bool _hasConcreteSuperMethod(ExecutableElement element) {
     var classElement = element.enclosingElement3 as InterfaceElement;
     String name = element.name;
diff --git a/pkg/analyzer/lib/src/error/type_arguments_verifier.dart b/pkg/analyzer/lib/src/error/type_arguments_verifier.dart
@@ -568,13 +568,8 @@ class TypeArgumentsVerifier {
   /// This function is used by other node-specific type checking functions, and
   /// should only be called when [node] has no explicit `typeArguments`.
   ///
-  /// [inferenceContextNode] is the node that has the downwards context type,
-  /// if any. For example an [InstanceCreationExpression].
+  /// This function will return false if either of the following are true:
   ///
-  /// This function will return false if any of the following are true:
-  ///
-  /// - [inferenceContextNode] has an inference context type that does not
-  ///   contain `_`
   /// - [type] does not have any `dynamic` type arguments.
   /// - the element is marked with `@optionalTypeArgs` from "package:meta".
   bool _isMissingTypeArguments(AstNode node, DartType type, Element? element) {
diff --git a/pkg/analyzer/lib/src/fasta/doc_comment_builder.dart b/pkg/analyzer/lib/src/fasta/doc_comment_builder.dart
diff --git a/pkg/analyzer/lib/src/manifest/manifest_warning_code.g.dart b/pkg/analyzer/lib/src/manifest/manifest_warning_code.g.dart
diff --git a/pkg/analyzer/lib/src/pubspec/pubspec_warning_code.g.dart b/pkg/analyzer/lib/src/pubspec/pubspec_warning_code.g.dart
diff --git a/pkg/analyzer/messages.yaml b/pkg/analyzer/messages.yaml
diff --git a/pkg/analyzer/test/src/pubspec/diagnostics/missing_dependency_test.dart b/pkg/analyzer/test/src/pubspec/diagnostics/missing_dependency_test.dart
diff --git a/pkg/analyzer/test/util/id_testing_helper.dart b/pkg/analyzer/test/util/id_testing_helper.dart
diff --git a/pkg/analyzer/tool/diagnostics/generate.dart b/pkg/analyzer/tool/diagnostics/generate.dart
diff --git a/pkg/analyzer/tool/messages/generate.dart b/pkg/analyzer/tool/messages/generate.dart

Original file line number	Diff line number	Diff line change
`@@ -504,7 +504,7 @@ class LibraryAnalyzer {`
`504`	`504`	`verifier.generateDuplicateExportWarnings(errorReporter);`
`505`	`505`	`verifier.generateDuplicateImportWarnings(errorReporter);`
`506`	`506`	`verifier.generateDuplicateShownHiddenNameWarnings(errorReporter);`
`507`		`- verifier.generateUnusedImportHints(errorReporter);`
	`507`	`+ verifier.generateUnusedImportWarnings(errorReporter);`
`508`	`508`	`verifier.generateUnusedShownNameHints(errorReporter);`
`509`	`509`	`verifier.generateUnnecessaryImportHints(errorReporter);`
`510`	`510`	`}`
Original file line number	Diff line number	Diff line change
`@@ -185,7 +185,7 @@ class NamespaceBuilder {`
`185`	`185`	`}`
`186`	`186`
`187`	`187`	`/// Create a namespace representing the import namespace of the given`
`188`		`- /// [element].`
	`188`	`+ /// [importedLibrary].`
`189`	`189`	`Namespace createImportNamespaceForDirective({`
`190`	`190`	`required LibraryElement importedLibrary,`
`191`	`191`	`required List<NamespaceCombinator> combinators,`