From 75b6a2ff6a48b01d7e1ffc205a0113d02fef4792 Mon Sep 17 00:00:00 2001 From: Michael Goderbauer Date: Mon, 5 Aug 2024 16:19:51 -0700 Subject: [PATCH] more docImports (#151951) Part of https://github.com/flutter/flutter/issues/150800. --- packages/flutter/lib/src/gestures/binding.dart | 1 + packages/flutter/lib/src/painting/binding.dart | 1 + packages/flutter/lib/src/painting/box_shadow.dart | 1 + packages/flutter/lib/src/painting/debug.dart | 2 ++ packages/flutter/lib/src/scheduler/ticker.dart | 1 + .../flutter/lib/src/services/binary_messenger.dart | 2 ++ .../flutter/lib/src/services/hardware_keyboard.dart | 1 + packages/flutter/pubspec.yaml | 6 +++++- .../lib/src/common/diagnostics_tree.dart | 2 +- .../lib/src/common/text_input_action.dart | 3 +++ packages/flutter_test/lib/src/_goldens_io.dart | 3 +-- packages/flutter_test/lib/src/_goldens_web.dart | 3 +-- packages/flutter_test/lib/src/controller.dart | 11 +++++++---- .../flutter_test/lib/src/frame_timing_summarizer.dart | 3 +++ packages/flutter_test/lib/src/goldens.dart | 6 ++---- packages/flutter_test/pubspec.yaml | 7 ++++++- .../flutter_web_plugins/lib/flutter_web_plugins.dart | 2 +- 17 files changed, 39 insertions(+), 16 deletions(-) diff --git a/packages/flutter/lib/src/gestures/binding.dart b/packages/flutter/lib/src/gestures/binding.dart index f9e09c9617..467d3546fc 100644 --- a/packages/flutter/lib/src/gestures/binding.dart +++ b/packages/flutter/lib/src/gestures/binding.dart @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +/// @docImport 'package:fake_async/fake_async.dart'; /// @docImport 'package:flutter/rendering.dart'; /// @docImport 'package:flutter/widgets.dart'; /// diff --git a/packages/flutter/lib/src/painting/binding.dart b/packages/flutter/lib/src/painting/binding.dart index c0d2b55189..df2a09b3c1 100644 --- a/packages/flutter/lib/src/painting/binding.dart +++ b/packages/flutter/lib/src/painting/binding.dart @@ -5,6 +5,7 @@ /// @docImport 'dart:ui'; /// /// @docImport 'package:flutter/widgets.dart'; +/// @docImport 'package:flutter_driver/driver_extension.dart'; library; import 'dart:ui' as ui; diff --git a/packages/flutter/lib/src/painting/box_shadow.dart b/packages/flutter/lib/src/painting/box_shadow.dart index 01232791d7..9d170b6bb2 100644 --- a/packages/flutter/lib/src/painting/box_shadow.dart +++ b/packages/flutter/lib/src/painting/box_shadow.dart @@ -3,6 +3,7 @@ // found in the LICENSE file. /// @docImport 'package:flutter/material.dart'; +/// @docImport 'package:flutter_test/flutter_test.dart'; library; import 'dart:math' as math; diff --git a/packages/flutter/lib/src/painting/debug.dart b/packages/flutter/lib/src/painting/debug.dart index 47a480f619..489f3ee65a 100644 --- a/packages/flutter/lib/src/painting/debug.dart +++ b/packages/flutter/lib/src/painting/debug.dart @@ -5,6 +5,8 @@ /// @docImport 'dart:developer'; /// @docImport 'dart:ui'; /// +/// @docImport 'package:flutter_test/flutter_test.dart'; +/// /// @docImport 'borders.dart'; /// @docImport 'box_decoration.dart'; /// @docImport 'box_shadow.dart'; diff --git a/packages/flutter/lib/src/scheduler/ticker.dart b/packages/flutter/lib/src/scheduler/ticker.dart index 58b2d75029..714da01348 100644 --- a/packages/flutter/lib/src/scheduler/ticker.dart +++ b/packages/flutter/lib/src/scheduler/ticker.dart @@ -3,6 +3,7 @@ // found in the LICENSE file. /// @docImport 'package:flutter/widgets.dart'; +/// @docImport 'package:flutter_test/flutter_test.dart'; library; import 'dart:async'; diff --git a/packages/flutter/lib/src/services/binary_messenger.dart b/packages/flutter/lib/src/services/binary_messenger.dart index 45065393e6..b242bf179e 100644 --- a/packages/flutter/lib/src/services/binary_messenger.dart +++ b/packages/flutter/lib/src/services/binary_messenger.dart @@ -3,6 +3,8 @@ // found in the LICENSE file. /// @docImport 'dart:ui'; +/// +/// @docImport 'package:flutter_test/flutter_test.dart'; library; import 'dart:typed_data'; diff --git a/packages/flutter/lib/src/services/hardware_keyboard.dart b/packages/flutter/lib/src/services/hardware_keyboard.dart index 1f54e7dac7..7551e84ace 100644 --- a/packages/flutter/lib/src/services/hardware_keyboard.dart +++ b/packages/flutter/lib/src/services/hardware_keyboard.dart @@ -4,6 +4,7 @@ /// @docImport 'package:flutter/cupertino.dart'; /// @docImport 'package:flutter/material.dart'; +/// @docImport 'package:flutter_test/flutter_test.dart'; library; import 'dart:ui' as ui; diff --git a/packages/flutter/pubspec.yaml b/packages/flutter/pubspec.yaml index 35e175edca..df3287cc1a 100644 --- a/packages/flutter/pubspec.yaml +++ b/packages/flutter/pubspec.yaml @@ -19,6 +19,8 @@ dependencies: sdk: flutter dev_dependencies: + flutter_driver: + sdk: flutter flutter_test: sdk: flutter flutter_goldens: @@ -43,9 +45,11 @@ dev_dependencies: stack_trace: 1.11.1 # THIS LINE IS AUTOGENERATED - TO UPDATE USE "flutter update-packages --force-upgrade" stream_channel: 2.1.2 # THIS LINE IS AUTOGENERATED - TO UPDATE USE "flutter update-packages --force-upgrade" string_scanner: 1.3.0 # THIS LINE IS AUTOGENERATED - TO UPDATE USE "flutter update-packages --force-upgrade" + sync_http: 0.3.1 # THIS LINE IS AUTOGENERATED - TO UPDATE USE "flutter update-packages --force-upgrade" term_glyph: 1.2.1 # THIS LINE IS AUTOGENERATED - TO UPDATE USE "flutter update-packages --force-upgrade" test_api: 0.7.3 # THIS LINE IS AUTOGENERATED - TO UPDATE USE "flutter update-packages --force-upgrade" typed_data: 1.3.2 # THIS LINE IS AUTOGENERATED - TO UPDATE USE "flutter update-packages --force-upgrade" vm_service: 14.2.4 # THIS LINE IS AUTOGENERATED - TO UPDATE USE "flutter update-packages --force-upgrade" + webdriver: 3.0.3 # THIS LINE IS AUTOGENERATED - TO UPDATE USE "flutter update-packages --force-upgrade" -# PUBSPEC CHECKSUM: a74f +# PUBSPEC CHECKSUM: c795 diff --git a/packages/flutter_driver/lib/src/common/diagnostics_tree.dart b/packages/flutter_driver/lib/src/common/diagnostics_tree.dart index cb4be00fe6..b3a23d1556 100644 --- a/packages/flutter_driver/lib/src/common/diagnostics_tree.dart +++ b/packages/flutter_driver/lib/src/common/diagnostics_tree.dart @@ -2,7 +2,7 @@ // 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'; +/// @docImport 'package:flutter/widgets.dart'; library; import 'enum_util.dart'; diff --git a/packages/flutter_driver/lib/src/common/text_input_action.dart b/packages/flutter_driver/lib/src/common/text_input_action.dart index 6a64b195d2..9e8b0ad558 100644 --- a/packages/flutter_driver/lib/src/common/text_input_action.dart +++ b/packages/flutter_driver/lib/src/common/text_input_action.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/material.dart'; +library; + import 'enum_util.dart'; import 'message.dart'; diff --git a/packages/flutter_test/lib/src/_goldens_io.dart b/packages/flutter_test/lib/src/_goldens_io.dart index 43f8048b28..34d88aeef5 100644 --- a/packages/flutter_test/lib/src/_goldens_io.dart +++ b/packages/flutter_test/lib/src/_goldens_io.dart @@ -57,8 +57,7 @@ import 'test_async_utils.dart'; /// /// * [GoldenFileComparator], the abstract class that [LocalFileComparator] /// implements. -/// * [matchesGoldenFile], the function from [flutter_test] that invokes the -/// comparator. +/// * [matchesGoldenFile], the function that invokes the comparator. class LocalFileComparator extends GoldenFileComparator with LocalComparisonOutput { /// Creates a new [LocalFileComparator] for the specified [testFile]. /// diff --git a/packages/flutter_test/lib/src/_goldens_web.dart b/packages/flutter_test/lib/src/_goldens_web.dart index 28e8ffdaf7..3abdcf6cab 100644 --- a/packages/flutter_test/lib/src/_goldens_web.dart +++ b/packages/flutter_test/lib/src/_goldens_web.dart @@ -42,8 +42,7 @@ Future compareLists(List test, List master) async { /// /// See also: /// -/// * [matchesGoldenFile], the function from [flutter_test] that invokes the -/// comparator. +/// * [matchesGoldenFile], the function that invokes the comparator. class DefaultWebGoldenComparator extends WebGoldenComparator { /// Creates a new [DefaultWebGoldenComparator] for the specified [testUri]. /// diff --git a/packages/flutter_test/lib/src/controller.dart b/packages/flutter_test/lib/src/controller.dart index b198b926d5..069da72fa4 100644 --- a/packages/flutter_test/lib/src/controller.dart +++ b/packages/flutter_test/lib/src/controller.dart @@ -2,7 +2,10 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +/// @docImport 'dart:io'; +/// /// @docImport 'package:flutter/scheduler.dart'; +/// @docImport 'package:flutter_driver/flutter_driver.dart'; /// /// @docImport 'binding.dart'; /// @docImport 'finders.dart'; @@ -1962,7 +1965,7 @@ abstract class WidgetController { /// soft keyboard. /// /// Specify `platform` as one of the platforms allowed in - /// [platform.Platform.operatingSystem] to make the event appear to be from + /// [Platform.operatingSystem] to make the event appear to be from /// that type of system. If not specified, defaults to "web" on web, and the /// operating system name based on [defaultTargetPlatform] everywhere else. /// @@ -2004,7 +2007,7 @@ abstract class WidgetController { /// from a soft keyboard. /// /// Specify `platform` as one of the platforms allowed in - /// [platform.Platform.operatingSystem] to make the event appear to be from + /// [Platform.operatingSystem] to make the event appear to be from /// that type of system. If not specified, defaults to "web" on web, and the /// operating system name based on [defaultTargetPlatform] everywhere else. /// @@ -2041,7 +2044,7 @@ abstract class WidgetController { /// not from a soft keyboard. /// /// Specify `platform` as one of the platforms allowed in - /// [platform.Platform.operatingSystem] to make the event appear to be from + /// [Platform.operatingSystem] to make the event appear to be from /// that type of system. If not specified, defaults to "web" on web, and the /// operating system name based on [defaultTargetPlatform] everywhere else. /// @@ -2071,7 +2074,7 @@ abstract class WidgetController { /// from a soft keyboard. /// /// Specify `platform` as one of the platforms allowed in - /// [platform.Platform.operatingSystem] to make the event appear to be from + /// [Platform.operatingSystem] to make the event appear to be from /// that type of system. If not specified, defaults to "web" on web, and the /// operating system name based on [defaultTargetPlatform] everywhere else. /// diff --git a/packages/flutter_test/lib/src/frame_timing_summarizer.dart b/packages/flutter_test/lib/src/frame_timing_summarizer.dart index 12c60b238a..663ac5a793 100644 --- a/packages/flutter_test/lib/src/frame_timing_summarizer.dart +++ b/packages/flutter_test/lib/src/frame_timing_summarizer.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:ui'; /// The maximum amount of time considered safe to spend for a frame's build diff --git a/packages/flutter_test/lib/src/goldens.dart b/packages/flutter_test/lib/src/goldens.dart index c27f50ce1c..e7da2b1d59 100644 --- a/packages/flutter_test/lib/src/goldens.dart +++ b/packages/flutter_test/lib/src/goldens.dart @@ -55,8 +55,7 @@ import '_goldens_io.dart' if (dart.library.js_interop) '_goldens_web.dart' as go /// /// * [LocalFileComparator] for the default [GoldenFileComparator] /// implementation for `flutter test`. -/// * [matchesGoldenFile], the function from [flutter_test] that invokes the -/// comparator. +/// * [matchesGoldenFile], the function that invokes the comparator. abstract class GoldenFileComparator { /// Compares the pixels of decoded png [imageBytes] against the golden file /// identified by [golden]. @@ -216,8 +215,7 @@ GoldenFileComparator goldenFileComparator = const TrivialComparator._(); /// not running in a web browser. /// * [DefaultWebGoldenComparator] for the default [WebGoldenComparator] /// implementation for `flutter test`. -/// * [matchesGoldenFile], the function from [flutter_test] that invokes the -/// comparator. +/// * [matchesGoldenFile], the function that invokes the comparator. abstract class WebGoldenComparator { /// Compares the rendered pixels of size [width]x[height] that is being /// rendered on the top left of the screen against the golden file identified diff --git a/packages/flutter_test/pubspec.yaml b/packages/flutter_test/pubspec.yaml index 1a77e1e7b6..d5167f0abc 100644 --- a/packages/flutter_test/pubspec.yaml +++ b/packages/flutter_test/pubspec.yaml @@ -52,5 +52,10 @@ dependencies: dev_dependencies: file: 7.0.0 + flutter_driver: + sdk: flutter -# PUBSPEC CHECKSUM: ba58 + sync_http: 0.3.1 # THIS LINE IS AUTOGENERATED - TO UPDATE USE "flutter update-packages --force-upgrade" + webdriver: 3.0.3 # THIS LINE IS AUTOGENERATED - TO UPDATE USE "flutter update-packages --force-upgrade" + +# PUBSPEC CHECKSUM: a19e diff --git a/packages/flutter_web_plugins/lib/flutter_web_plugins.dart b/packages/flutter_web_plugins/lib/flutter_web_plugins.dart index 0799371b4c..5c42fa3597 100644 --- a/packages/flutter_web_plugins/lib/flutter_web_plugins.dart +++ b/packages/flutter_web_plugins/lib/flutter_web_plugins.dart @@ -12,7 +12,7 @@ /// See also: /// /// * [How to Write a Flutter Web Plugin](https://medium.com/flutter/how-to-write-a-flutter-web-plugin-5e26c689ea1), a Medium article -/// describing how the `url_launcher` package was created using [flutter_web_plugins]. +/// describing how the `url_launcher` package was created using `flutter_web_plugins`. /// /// @docImport 'src/plugin_registry.dart'; library flutter_web_plugins;