Fix unresolved doc comment references in dev/integration_tests and dev/benchmarks (#193433) Fixes doc comment references in `dev/integration_tests` and `dev/benchmarks` that don't resolve in Dart scope, mostly by adding doc imports; parameters and locals go in backticks. Towards https://github.com/flutter/flutter/issues/192870 — enabling the `comment_references` lint.
diff --git a/dev/benchmarks/macrobenchmarks/lib/src/web/bench_text_layout.dart b/dev/benchmarks/macrobenchmarks/lib/src/web/bench_text_layout.dart index b624b85..9a7e286 100644 --- a/dev/benchmarks/macrobenchmarks/lib/src/web/bench_text_layout.dart +++ b/dev/benchmarks/macrobenchmarks/lib/src/web/bench_text_layout.dart
@@ -150,7 +150,7 @@ } /// Global counter incremented every time the benchmark is asked to -/// [createWidget]. +/// [BenchBuildColorsGrid.createWidget]. /// /// The purpose of this counter is to make sure the rendered paragraphs on each /// build are unique.
diff --git a/dev/benchmarks/macrobenchmarks/lib/src/web/recorder.dart b/dev/benchmarks/macrobenchmarks/lib/src/web/recorder.dart index 7f8c190..7b59500 100644 --- a/dev/benchmarks/macrobenchmarks/lib/src/web/recorder.dart +++ b/dev/benchmarks/macrobenchmarks/lib/src/web/recorder.dart
@@ -1274,7 +1274,7 @@ /// [WidgetBuildRecorder] only measures frames that build widgets, and ignores /// frames that clear the screen. /// -/// Warm-up frames are not measured. If [profile.isWarmingUp] is true, +/// Warm-up frames are not measured. If [Profile.isWarmingUp] is true, /// this function does nothing. void startMeasureFrame(Profile profile) { if (_calledStartMeasureFrame) { @@ -1295,7 +1295,7 @@ /// See [startMeasureFrame] for details on what this instrumentation is used /// for. /// -/// Warm-up frames are not measured. If [profile.isWarmingUp] was true +/// Warm-up frames are not measured. If [Profile.isWarmingUp] was true /// when the corresponding [startMeasureFrame] was called, /// this function does nothing. void endMeasureFrame() {
diff --git a/dev/benchmarks/macrobenchmarks/lib/web_benchmarks.dart b/dev/benchmarks/macrobenchmarks/lib/web_benchmarks.dart index efcc812..a5e2b98 100644 --- a/dev/benchmarks/macrobenchmarks/lib/web_benchmarks.dart +++ b/dev/benchmarks/macrobenchmarks/lib/web_benchmarks.dart
@@ -2,6 +2,9 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +/// @docImport 'dart:html'; +library; + import 'dart:async'; import 'dart:convert' show json; import 'dart:js_interop'; @@ -450,7 +453,7 @@ ); } - /// This is the same as calling [html.HttpRequest.request] but it doesn't + /// This is the same as calling [HttpRequest.request] but it doesn't /// crash on 404, which we use to detect `flutter run`. Future<web.XMLHttpRequest> _requestXhr( Uri url, {
diff --git a/dev/integration_tests/android_hardware_smoke_test/test/widget_test.dart b/dev/integration_tests/android_hardware_smoke_test/test/widget_test.dart index a681ac8..e7011fc 100644 --- a/dev/integration_tests/android_hardware_smoke_test/test/widget_test.dart +++ b/dev/integration_tests/android_hardware_smoke_test/test/widget_test.dart
@@ -22,10 +22,10 @@ /// Pre-compiled 1x1 transparent PNG bytes used for mock asset loads and golden comparisons. /// -/// This is used instead of [testImage] (which is a decoded [ui.Image] object) because: +/// This is used instead of `testImage` (which is a decoded [ui.Image] object) because: /// 1. `compareGoldenOnDevice` and our comparator expect raw compressed [Uint8List] bytes. /// 2. The mock `'flutter/assets'` binary messenger channel must return raw file bytes. -/// 3. Converting [testImage] to PNG bytes dynamically using `toByteData(format: png)` +/// 3. Converting `testImage` to PNG bytes dynamically using `toByteData(format: png)` /// is slow and deadlocks inside the test's `FakeAsync` zone. final Uint8List transparentImageBytes = Uint8List.fromList( img.encodePng(img.Image(width: 1, height: 1)),
diff --git a/dev/integration_tests/android_semantics_testing/lib/src/common.dart b/dev/integration_tests/android_semantics_testing/lib/src/common.dart index 99957dd..cd07cff 100644 --- a/dev/integration_tests/android_semantics_testing/lib/src/common.dart +++ b/dev/integration_tests/android_semantics_testing/lib/src/common.dart
@@ -2,6 +2,9 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +/// @docImport 'package:flutter/semantics.dart'; +library; + // ignore_for_file: avoid_dynamic_calls import 'dart:convert'; @@ -148,7 +151,7 @@ return Size(rect.bottom - rect.top, rect.right - rect.left); } - /// Gets a list of [AndroidSemanticsActions] which are defined for the node. + /// Gets a list of [AndroidSemanticsAction]s which are defined for the node. List<AndroidSemanticsAction> getActions() { final List<int>? actions = (_values['actions'] as List<dynamic>?)?.cast<int>(); if (actions == null) {
diff --git a/dev/integration_tests/android_semantics_testing/lib/src/tests/controls_constants.dart b/dev/integration_tests/android_semantics_testing/lib/src/tests/controls_constants.dart index 11ed58f..cd6b819 100644 --- a/dev/integration_tests/android_semantics_testing/lib/src/tests/controls_constants.dart +++ b/dev/integration_tests/android_semantics_testing/lib/src/tests/controls_constants.dart
@@ -2,6 +2,9 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +/// @docImport 'package:flutter/foundation.dart'; +library; + /// The name of the route containing the test suite. const String selectionControlsRoute = 'controls';
diff --git a/dev/integration_tests/android_semantics_testing/lib/src/tests/headings_constants.dart b/dev/integration_tests/android_semantics_testing/lib/src/tests/headings_constants.dart index 9a31bc2..cac036f 100644 --- a/dev/integration_tests/android_semantics_testing/lib/src/tests/headings_constants.dart +++ b/dev/integration_tests/android_semantics_testing/lib/src/tests/headings_constants.dart
@@ -2,6 +2,9 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +/// @docImport 'package:flutter/foundation.dart'; +library; + /// The name of the route containing the test suite. const String headingsRoute = 'headings';
diff --git a/dev/integration_tests/android_semantics_testing/lib/src/tests/popup_constants.dart b/dev/integration_tests/android_semantics_testing/lib/src/tests/popup_constants.dart index ca4b41b..2d2836b 100644 --- a/dev/integration_tests/android_semantics_testing/lib/src/tests/popup_constants.dart +++ b/dev/integration_tests/android_semantics_testing/lib/src/tests/popup_constants.dart
@@ -2,6 +2,9 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +/// @docImport 'package:flutter/foundation.dart'; +library; + /// The name of the route containing the test suite. const String popupControlsRoute = 'popups';
diff --git a/dev/integration_tests/android_semantics_testing/lib/src/tests/text_field_constants.dart b/dev/integration_tests/android_semantics_testing/lib/src/tests/text_field_constants.dart index ebc396d..3b2f524 100644 --- a/dev/integration_tests/android_semantics_testing/lib/src/tests/text_field_constants.dart +++ b/dev/integration_tests/android_semantics_testing/lib/src/tests/text_field_constants.dart
@@ -2,6 +2,9 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +/// @docImport 'package:flutter/foundation.dart'; +library; + /// The name of the route containing the text field tests. const String textFieldRoute = 'textField';
diff --git a/dev/integration_tests/android_views/lib/motion_events_page.dart b/dev/integration_tests/android_views/lib/motion_events_page.dart index 2962e92..fcae201 100644 --- a/dev/integration_tests/android_views/lib/motion_events_page.dart +++ b/dev/integration_tests/android_views/lib/motion_events_page.dart
@@ -2,6 +2,9 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +/// @docImport 'package:flutter_driver/flutter_driver.dart'; +library; + import 'dart:async'; import 'dart:io';
diff --git a/dev/integration_tests/engine_integration_golden_test/integration_test/flutter_test_config.dart b/dev/integration_tests/engine_integration_golden_test/integration_test/flutter_test_config.dart index e412abd..0cb41c6 100644 --- a/dev/integration_tests/engine_integration_golden_test/integration_test/flutter_test_config.dart +++ b/dev/integration_tests/engine_integration_golden_test/integration_test/flutter_test_config.dart
@@ -2,6 +2,9 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +/// @docImport 'package:flutter_test/flutter_test.dart'; +library; + import 'dart:async'; import 'package:flutter_goldens/flutter_goldens.dart' as flutter_goldens;
diff --git a/dev/integration_tests/flutter_gallery/test/live_smoketest.dart b/dev/integration_tests/flutter_gallery/test/live_smoketest.dart index 9d6dfd2..2005aff 100644 --- a/dev/integration_tests/flutter_gallery/test/live_smoketest.dart +++ b/dev/integration_tests/flutter_gallery/test/live_smoketest.dart
@@ -109,7 +109,7 @@ /// until there are no pending frames in the app under test. bool frameSync = true; - /// Waits until at the end of a frame the provided [condition] is [true]. + /// Waits until at the end of a frame the provided [condition] is `true`. Future<void> _waitUntilFrame(bool Function() condition, [Completer<void>? completer]) { completer ??= Completer<void>(); if (!condition()) {
diff --git a/dev/integration_tests/hybrid_android_views/lib/future_data_handler.dart b/dev/integration_tests/hybrid_android_views/lib/future_data_handler.dart index a343d7b..f12f215 100644 --- a/dev/integration_tests/hybrid_android_views/lib/future_data_handler.dart +++ b/dev/integration_tests/hybrid_android_views/lib/future_data_handler.dart
@@ -2,6 +2,9 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +/// @docImport 'package:flutter_driver/flutter_driver.dart'; +library; + import 'dart:async'; import 'package:flutter_driver/driver_extension.dart';
diff --git a/dev/integration_tests/new_gallery/lib/feature_discovery/animation.dart b/dev/integration_tests/new_gallery/lib/feature_discovery/animation.dart index 13b494f..d2e389e 100644 --- a/dev/integration_tests/new_gallery/lib/feature_discovery/animation.dart +++ b/dev/integration_tests/new_gallery/lib/feature_discovery/animation.dart
@@ -2,6 +2,9 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +/// @docImport 'feature_discovery.dart'; +library; + import 'package:flutter/material.dart'; /// Animations class to compute animation values for overlay widgets.
diff --git a/dev/integration_tests/new_gallery/lib/pages/home.dart b/dev/integration_tests/new_gallery/lib/pages/home.dart index cc17a55..1d11933 100644 --- a/dev/integration_tests/new_gallery/lib/pages/home.dart +++ b/dev/integration_tests/new_gallery/lib/pages/home.dart
@@ -553,7 +553,7 @@ } } -/// Animates the category item to stagger in. The [_AnimatedCategoryItem.startDelayFraction] +/// Animates the category item to stagger in. The `_AnimatedCategoryItem.startDelayFraction` /// gives a delay in the unit of a fraction of the whole animation duration, /// which is defined in [_AnimatedHomePageState]. class _AnimatedCategoryItem extends StatelessWidget {
diff --git a/dev/integration_tests/wide_gamut_test/integration_test/app_test.dart b/dev/integration_tests/wide_gamut_test/integration_test/app_test.dart index 0d3c7bb..3d2b060 100644 --- a/dev/integration_tests/wide_gamut_test/integration_test/app_test.dart +++ b/dev/integration_tests/wide_gamut_test/integration_test/app_test.dart
@@ -116,7 +116,7 @@ } /// Precache the Display P3 test image so it is fully decoded before we take a -/// screenshot. Must be called after [pumpAndSettle] so a [BuildContext] exists. +/// screenshot. Must be called after [WidgetTester.pumpAndSettle] so a [BuildContext] exists. Future<void> _precacheP3Image(WidgetTester tester) async { final BuildContext context = tester.element(find.byType(app.MyApp)); await tester.runAsync(() => precacheImage(MemoryImage(base64Decode(app.displayP3Logo)), context));