From 06b9f7ba0bef2b5b44a643c73f4295a096de1202 Mon Sep 17 00:00:00 2001 From: Michael Goderbauer Date: Tue, 2 Jul 2024 10:30:41 -0700 Subject: [PATCH] docimports for services (#151134) Part of https://github.com/flutter/flutter/issues/150800 --- dev/tools/gen_keycodes/data/keyboard_key.tmpl | 5 +++++ .../flutter/lib/src/services/asset_bundle.dart | 3 +++ .../lib/src/services/binary_messenger.dart | 3 +++ packages/flutter/lib/src/services/binding.dart | 7 +++++++ packages/flutter/lib/src/services/debug.dart | 4 ++++ .../lib/src/services/hardware_keyboard.dart | 4 ++++ .../lib/src/services/keyboard_key.g.dart | 5 +++++ .../flutter/lib/src/services/live_text.dart | 3 +++ .../flutter/lib/src/services/mouse_cursor.dart | 10 +++++++--- .../lib/src/services/mouse_tracking.dart | 3 +++ .../lib/src/services/platform_views.dart | 5 +++++ .../flutter/lib/src/services/raw_keyboard.dart | 4 ++++ .../lib/src/services/raw_keyboard_android.dart | 3 +++ .../lib/src/services/raw_keyboard_fuchsia.dart | 3 +++ .../lib/src/services/raw_keyboard_ios.dart | 3 +++ .../lib/src/services/raw_keyboard_linux.dart | 3 +++ .../lib/src/services/raw_keyboard_macos.dart | 3 +++ .../lib/src/services/raw_keyboard_web.dart | 3 +++ .../lib/src/services/raw_keyboard_windows.dart | 3 +++ .../flutter/lib/src/services/restoration.dart | 5 +++++ .../flutter/lib/src/services/spell_check.dart | 3 +++ .../lib/src/services/system_channels.dart | 18 ++++++++++++++++++ .../lib/src/services/system_chrome.dart | 4 ++++ .../lib/src/services/system_navigator.dart | 3 +++ .../lib/src/services/text_editing_delta.dart | 3 +++ .../lib/src/services/text_formatter.dart | 2 ++ .../flutter/lib/src/services/text_input.dart | 8 ++++++++ 27 files changed, 120 insertions(+), 3 deletions(-) diff --git a/dev/tools/gen_keycodes/data/keyboard_key.tmpl b/dev/tools/gen_keycodes/data/keyboard_key.tmpl index c3b983f6d2..93974ed52b 100644 --- a/dev/tools/gen_keycodes/data/keyboard_key.tmpl +++ b/dev/tools/gen_keycodes/data/keyboard_key.tmpl @@ -2,6 +2,11 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +/// @docImport 'package:flutter/widgets.dart'; +/// +/// @docImport 'raw_keyboard.dart'; +library; + import 'package:flutter/foundation.dart'; export 'package:flutter/foundation.dart' show DiagnosticPropertiesBuilder; diff --git a/packages/flutter/lib/src/services/asset_bundle.dart b/packages/flutter/lib/src/services/asset_bundle.dart index 0c65ca323c..227ffb7bfc 100644 --- a/packages/flutter/lib/src/services/asset_bundle.dart +++ b/packages/flutter/lib/src/services/asset_bundle.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 'dart:async'; import 'dart:convert'; import 'dart:io'; diff --git a/packages/flutter/lib/src/services/binary_messenger.dart b/packages/flutter/lib/src/services/binary_messenger.dart index d7774eae8e..45065393e6 100644 --- a/packages/flutter/lib/src/services/binary_messenger.dart +++ b/packages/flutter/lib/src/services/binary_messenger.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:ui'; +library; + import 'dart:typed_data'; import 'dart:ui' as ui; diff --git a/packages/flutter/lib/src/services/binding.dart b/packages/flutter/lib/src/services/binding.dart index 29e61fa069..ae7294296e 100644 --- a/packages/flutter/lib/src/services/binding.dart +++ b/packages/flutter/lib/src/services/binding.dart @@ -2,6 +2,13 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +/// @docImport 'dart:ui'; +/// +/// @docImport 'package:flutter/widgets.dart'; +/// +/// @docImport 'system_chrome.dart'; +library; + import 'dart:async'; import 'dart:convert'; import 'dart:io'; diff --git a/packages/flutter/lib/src/services/debug.dart b/packages/flutter/lib/src/services/debug.dart index cc35a03f34..5073dbad7d 100644 --- a/packages/flutter/lib/src/services/debug.dart +++ b/packages/flutter/lib/src/services/debug.dart @@ -2,6 +2,10 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +/// @docImport 'platform_channel.dart'; +/// @docImport 'service_extensions.dart'; +library; + import 'package:flutter/foundation.dart'; import 'hardware_keyboard.dart'; diff --git a/packages/flutter/lib/src/services/hardware_keyboard.dart b/packages/flutter/lib/src/services/hardware_keyboard.dart index 390c0fe8bb..1f54e7dac7 100644 --- a/packages/flutter/lib/src/services/hardware_keyboard.dart +++ b/packages/flutter/lib/src/services/hardware_keyboard.dart @@ -2,6 +2,10 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +/// @docImport 'package:flutter/cupertino.dart'; +/// @docImport 'package:flutter/material.dart'; +library; + import 'dart:ui' as ui; import 'package:flutter/foundation.dart'; diff --git a/packages/flutter/lib/src/services/keyboard_key.g.dart b/packages/flutter/lib/src/services/keyboard_key.g.dart index 4feaa7b0ad..a3a03025ec 100644 --- a/packages/flutter/lib/src/services/keyboard_key.g.dart +++ b/packages/flutter/lib/src/services/keyboard_key.g.dart @@ -2,6 +2,11 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +/// @docImport 'package:flutter/widgets.dart'; +/// +/// @docImport 'raw_keyboard.dart'; +library; + import 'package:flutter/foundation.dart'; export 'package:flutter/foundation.dart' show DiagnosticPropertiesBuilder; diff --git a/packages/flutter/lib/src/services/live_text.dart b/packages/flutter/lib/src/services/live_text.dart index ef58feb3fc..86e84aaa8f 100644 --- a/packages/flutter/lib/src/services/live_text.dart +++ b/packages/flutter/lib/src/services/live_text.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 'text_input.dart'; +library; + import 'system_channels.dart'; /// Utility methods for interacting with the system's Live Text. diff --git a/packages/flutter/lib/src/services/mouse_cursor.dart b/packages/flutter/lib/src/services/mouse_cursor.dart index bfd900277c..2083e419d4 100644 --- a/packages/flutter/lib/src/services/mouse_cursor.dart +++ b/packages/flutter/lib/src/services/mouse_cursor.dart @@ -2,6 +2,10 @@ // 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'; +/// @docImport 'package:flutter/rendering.dart'; +library; + import 'package:flutter/foundation.dart'; import 'package:flutter/gestures.dart'; @@ -278,12 +282,12 @@ class _NoopMouseCursorSession extends MouseCursorSession { /// A mouse cursor that doesn't change the cursor when activated. /// -/// Although setting a region's cursor to [NoopMouseCursor] doesn't change the +/// Although setting a region's cursor to [_NoopMouseCursor] doesn't change the /// cursor, it blocks regions behind it from changing the cursor, in contrast to /// setting the cursor to null. More information about the usage of this class -/// can be found at [MouseCursors.uncontrolled]. +/// can be found at [MouseCursor.uncontrolled]. /// -/// To use this class, use [MouseCursors.uncontrolled]. Directly +/// To use this class, use [MouseCursor.uncontrolled]. Directly /// instantiating this class is not allowed. class _NoopMouseCursor extends MouseCursor { // Application code shouldn't directly instantiate this class, since its only diff --git a/packages/flutter/lib/src/services/mouse_tracking.dart b/packages/flutter/lib/src/services/mouse_tracking.dart index a6a066e482..c1635a41ec 100644 --- a/packages/flutter/lib/src/services/mouse_tracking.dart +++ b/packages/flutter/lib/src/services/mouse_tracking.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/rendering.dart'; +/// @docImport 'package:flutter/widgets.dart'; +library; import 'package:flutter/foundation.dart'; import 'package:flutter/gestures.dart'; diff --git a/packages/flutter/lib/src/services/platform_views.dart b/packages/flutter/lib/src/services/platform_views.dart index 5dbc2008f5..2cefb2f50c 100644 --- a/packages/flutter/lib/src/services/platform_views.dart +++ b/packages/flutter/lib/src/services/platform_views.dart @@ -2,6 +2,11 @@ // 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'; +/// +/// @docImport 'message_codecs.dart'; +library; + import 'dart:async'; import 'dart:ui'; diff --git a/packages/flutter/lib/src/services/raw_keyboard.dart b/packages/flutter/lib/src/services/raw_keyboard.dart index 348fe3df41..7fb79a9166 100644 --- a/packages/flutter/lib/src/services/raw_keyboard.dart +++ b/packages/flutter/lib/src/services/raw_keyboard.dart @@ -2,6 +2,10 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +/// @docImport 'package:flutter/cupertino.dart'; +/// @docImport 'package:flutter/material.dart'; +library; + import 'dart:io'; import 'package:flutter/foundation.dart'; diff --git a/packages/flutter/lib/src/services/raw_keyboard_android.dart b/packages/flutter/lib/src/services/raw_keyboard_android.dart index 235f013b9b..19d16dbf10 100644 --- a/packages/flutter/lib/src/services/raw_keyboard_android.dart +++ b/packages/flutter/lib/src/services/raw_keyboard_android.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 'hardware_keyboard.dart'; +library; + import 'package:flutter/foundation.dart'; import 'keyboard_maps.g.dart'; diff --git a/packages/flutter/lib/src/services/raw_keyboard_fuchsia.dart b/packages/flutter/lib/src/services/raw_keyboard_fuchsia.dart index ae4aa0ddf3..c2dda66f34 100644 --- a/packages/flutter/lib/src/services/raw_keyboard_fuchsia.dart +++ b/packages/flutter/lib/src/services/raw_keyboard_fuchsia.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 'hardware_keyboard.dart'; +library; + import 'package:flutter/foundation.dart'; import 'keyboard_maps.g.dart'; diff --git a/packages/flutter/lib/src/services/raw_keyboard_ios.dart b/packages/flutter/lib/src/services/raw_keyboard_ios.dart index ca88e0325f..1aac4b871b 100644 --- a/packages/flutter/lib/src/services/raw_keyboard_ios.dart +++ b/packages/flutter/lib/src/services/raw_keyboard_ios.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 'hardware_keyboard.dart'; +library; + import 'package:flutter/foundation.dart'; import 'keyboard_maps.g.dart'; diff --git a/packages/flutter/lib/src/services/raw_keyboard_linux.dart b/packages/flutter/lib/src/services/raw_keyboard_linux.dart index f9035fb736..e43f9b634b 100644 --- a/packages/flutter/lib/src/services/raw_keyboard_linux.dart +++ b/packages/flutter/lib/src/services/raw_keyboard_linux.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 'hardware_keyboard.dart'; +library; + import 'package:flutter/foundation.dart'; import 'keyboard_maps.g.dart'; diff --git a/packages/flutter/lib/src/services/raw_keyboard_macos.dart b/packages/flutter/lib/src/services/raw_keyboard_macos.dart index 921f01a909..e655392d0f 100644 --- a/packages/flutter/lib/src/services/raw_keyboard_macos.dart +++ b/packages/flutter/lib/src/services/raw_keyboard_macos.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 'hardware_keyboard.dart'; +library; + import 'package:flutter/foundation.dart'; import 'keyboard_maps.g.dart'; diff --git a/packages/flutter/lib/src/services/raw_keyboard_web.dart b/packages/flutter/lib/src/services/raw_keyboard_web.dart index c1f575241d..1b55557bf4 100644 --- a/packages/flutter/lib/src/services/raw_keyboard_web.dart +++ b/packages/flutter/lib/src/services/raw_keyboard_web.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 'hardware_keyboard.dart'; +library; + import 'package:flutter/foundation.dart'; import 'keyboard_maps.g.dart'; diff --git a/packages/flutter/lib/src/services/raw_keyboard_windows.dart b/packages/flutter/lib/src/services/raw_keyboard_windows.dart index 52f9edaf08..51f15969fc 100644 --- a/packages/flutter/lib/src/services/raw_keyboard_windows.dart +++ b/packages/flutter/lib/src/services/raw_keyboard_windows.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 'hardware_keyboard.dart'; +library; + import 'package:flutter/foundation.dart'; import 'keyboard_maps.g.dart'; diff --git a/packages/flutter/lib/src/services/restoration.dart b/packages/flutter/lib/src/services/restoration.dart index d49af9183d..874f5a2e42 100644 --- a/packages/flutter/lib/src/services/restoration.dart +++ b/packages/flutter/lib/src/services/restoration.dart @@ -2,6 +2,11 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +/// @docImport 'package:flutter/widgets.dart'; +/// +/// @docImport 'binding.dart'; +library; + import 'dart:async'; import 'package:flutter/foundation.dart'; diff --git a/packages/flutter/lib/src/services/spell_check.dart b/packages/flutter/lib/src/services/spell_check.dart index c07e63cd43..1b665b3ff3 100644 --- a/packages/flutter/lib/src/services/spell_check.dart +++ b/packages/flutter/lib/src/services/spell_check.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/widgets.dart'; +library; + import 'dart:ui'; import 'package:flutter/foundation.dart'; diff --git a/packages/flutter/lib/src/services/system_channels.dart b/packages/flutter/lib/src/services/system_channels.dart index 63dcc7fdb2..d310abbb6d 100644 --- a/packages/flutter/lib/src/services/system_channels.dart +++ b/packages/flutter/lib/src/services/system_channels.dart @@ -2,6 +2,24 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +/// @docImport 'dart:typed_data'; +/// +/// @docImport 'package:flutter/semantics.dart'; +/// @docImport 'package:flutter/widgets.dart'; +/// +/// @docImport 'binding.dart'; +/// @docImport 'clipboard.dart'; +/// @docImport 'haptic_feedback.dart'; +/// @docImport 'platform_views.dart'; +/// @docImport 'raw_keyboard.dart'; +/// @docImport 'raw_keyboard_android.dart'; +/// @docImport 'raw_keyboard_fuchsia.dart'; +/// @docImport 'system_chrome.dart'; +/// @docImport 'system_navigator.dart'; +/// @docImport 'system_sound.dart'; +/// @docImport 'text_input.dart'; +library; + import 'dart:ui'; import 'message_codecs.dart'; diff --git a/packages/flutter/lib/src/services/system_chrome.dart b/packages/flutter/lib/src/services/system_chrome.dart index 3480d1eeda..83f4bda153 100644 --- a/packages/flutter/lib/src/services/system_chrome.dart +++ b/packages/flutter/lib/src/services/system_chrome.dart @@ -2,6 +2,10 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +/// @docImport 'package:flutter/cupertino.dart'; +/// @docImport 'package:flutter/material.dart'; +library; + import 'dart:async'; import 'dart:ui'; diff --git a/packages/flutter/lib/src/services/system_navigator.dart b/packages/flutter/lib/src/services/system_navigator.dart index 1ea16f921a..50a5d338e2 100644 --- a/packages/flutter/lib/src/services/system_navigator.dart +++ b/packages/flutter/lib/src/services/system_navigator.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:io'; +library; + import 'package:flutter/foundation.dart'; import 'system_channels.dart'; diff --git a/packages/flutter/lib/src/services/text_editing_delta.dart b/packages/flutter/lib/src/services/text_editing_delta.dart index 119fbc9689..34dd7da9a7 100644 --- a/packages/flutter/lib/src/services/text_editing_delta.dart +++ b/packages/flutter/lib/src/services/text_editing_delta.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 'text_input.dart'; +library; + import 'dart:ui' show TextRange; import 'package:flutter/foundation.dart'; diff --git a/packages/flutter/lib/src/services/text_formatter.dart b/packages/flutter/lib/src/services/text_formatter.dart index daaeef1f37..e932981fe1 100644 --- a/packages/flutter/lib/src/services/text_formatter.dart +++ b/packages/flutter/lib/src/services/text_formatter.dart @@ -2,6 +2,8 @@ // 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 'dart:math' as math; diff --git a/packages/flutter/lib/src/services/text_input.dart b/packages/flutter/lib/src/services/text_input.dart index 14242ea679..8c46bf88c0 100644 --- a/packages/flutter/lib/src/services/text_input.dart +++ b/packages/flutter/lib/src/services/text_input.dart @@ -2,6 +2,14 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +/// @docImport 'package:flutter/cupertino.dart'; +/// @docImport 'package:flutter/material.dart'; +/// @docImport 'package:flutter/rendering.dart'; +/// +/// @docImport 'live_text.dart'; +/// @docImport 'text_formatter.dart'; +library; + import 'dart:async'; import 'dart:io' show Platform; import 'dart:ui' show