Skip to content

Commit fb290b3

Browse files
authored
docimports for flutter_goldens, flutter_localizations, flutter_web_plugins, fuchsia_remote_debug_protocol, integration_test (#151271)
Part of flutter/flutter#150800
1 parent 17584ab commit fb290b3

File tree

12 files changed

+46
-15
lines changed

12 files changed

+46
-15
lines changed

packages/flutter/test/rendering/rendering_tester.dart

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,8 @@ class TestRenderingFlutterBinding extends BindingBase with SchedulerBinding, Ser
229229
/// The EnginePhase must not be [EnginePhase.build], since the rendering layer
230230
/// has no build phase.
231231
///
232-
/// If `onErrors` is not null, it is set as [TestRenderingFlutterBinding.onError].
232+
/// If `onErrors` is not null, it is set as
233+
/// [TestRenderingFlutterBinding.onErrors].
233234
void layout(
234235
RenderBox box, { // If you want to just repump the last box, call pumpFrame().
235236
BoxConstraints? constraints,
@@ -256,7 +257,8 @@ void layout(
256257

257258
/// Pumps a single frame.
258259
///
259-
/// If `onErrors` is not null, it is set as [TestRenderingFlutterBinding.onError].
260+
/// If `onErrors` is not null, it is set as
261+
/// [TestRenderingFlutterBinding.onErrors].
260262
void pumpFrame({ EnginePhase phase = EnginePhase.layout, VoidCallback? onErrors }) {
261263
assert(TestRenderingFlutterBinding.instance.renderView.child != null); // call layout() first!
262264

packages/flutter_goldens/lib/flutter_goldens.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ abstract class FlutterGoldenFileComparator extends GoldenFileComparator {
190190
///
191191
/// The optional [suffix] argument is used by the
192192
/// [FlutterPostSubmitFileComparator] and the [FlutterPreSubmitFileComparator].
193-
/// These [FlutterGoldenFileComparators] randomize their base directories to
193+
/// These [FlutterGoldenFileComparator]s randomize their base directories to
194194
/// maintain thread safety while using the `goldctl` tool.
195195
@protected
196196
@visibleForTesting
@@ -535,7 +535,7 @@ class FlutterSkippingFileComparator extends FlutterGoldenFileComparator {
535535
///
536536
/// This comparator utilizes the [SkiaGoldClient] to request baseline images for
537537
/// the given device under test for comparison. This comparator is initialized
538-
/// when conditions for all other [FlutterGoldenFileComparators] have not been
538+
/// when conditions for all other [FlutterGoldenFileComparator]s have not been
539539
/// met, see the `isForEnvironment` method for each one listed below.
540540
///
541541
/// The [FlutterLocalFileComparator] is intended to run on local machines and

packages/flutter_goldens/lib/skia_client.dart

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

5+
/// @docImport 'flutter_goldens.dart';
6+
library;
7+
58
import 'dart:convert';
69
import 'dart:io' as io;
710

@@ -24,7 +27,7 @@ const String _kImpellerKey = 'FLUTTER_TEST_IMPELLER';
2427
/// Signature of callbacks used to inject [print] replacements.
2528
typedef LogCallback = void Function(String);
2629

27-
/// Exception thrown when an error is returned from the [SkiaClient].
30+
/// Exception thrown when an error is returned from the [SkiaGoldClient].
2831
class SkiaException implements Exception {
2932
/// Creates a new `SkiaException` with a required error [message].
3033
const SkiaException(this.message);
@@ -75,12 +78,12 @@ class SkiaGoldClient {
7578
/// A client for making Http requests to the Flutter Gold dashboard.
7679
final io.HttpClient httpClient;
7780

78-
/// The local [Directory] within the [comparisonRoot] for the current test
81+
/// The local [Directory] within the comparison root for the current test
7982
/// context. In this directory, the client will create image and JSON files
8083
/// for the goldctl tool to use.
8184
///
82-
/// This is informed by the [FlutterGoldenFileComparator] [basedir]. It cannot
83-
/// be null.
85+
/// This is informed by [FlutterGoldenFileComparator.basedir]. It cannot be
86+
/// null.
8487
final Directory workDirectory;
8588

8689
/// The logging function to use when reporting messages to the console.

packages/flutter_goldens/test/json_templates.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ String authTemplate({
1717
}
1818

1919
/// Json response template for Skia Gold image request:
20-
/// https://flutter-gold.skia.org/img/images/[imageHash].png
20+
/// https://flutter-gold.skia.org/img/images/{imageHash}.png
2121
List<List<int>> imageResponseTemplate() {
2222
return <List<int>>[
2323
<int>[

packages/flutter_localizations/lib/src/cupertino_localizations.dart

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

5+
/// @docImport 'package:intl/intl.dart';
6+
library;
7+
58
import 'package:flutter/cupertino.dart';
69
import 'package:flutter/foundation.dart';
710
import 'package:intl/intl.dart' as intl;

packages/flutter_localizations/lib/src/material_localizations.dart

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

5+
/// @docImport 'package:intl/intl.dart';
6+
library;
7+
58
import 'package:flutter/foundation.dart';
69
import 'package:flutter/material.dart';
710
import 'package:intl/intl.dart' as intl;

packages/flutter_localizations/lib/src/widgets_localizations.dart

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
// Use of this source code is governed by a BSD-style license that can be
33
// found in the LICENSE file.
44

5+
/// @docImport 'package:flutter/material.dart';
6+
///
7+
/// @docImport 'material_localizations.dart';
8+
library;
9+
510
import 'package:flutter/foundation.dart';
611
import 'package:flutter/widgets.dart';
712

@@ -17,7 +22,7 @@ import 'l10n/generated_widgets_localizations.dart';
1722
///
1823
/// This list is available programmatically via [kWidgetsSupportedLanguages].
1924
///
20-
/// Besides localized strings, this class also maps [locale] to [textDirection].
25+
/// Besides localized strings, this class also maps [Locale] to [textDirection].
2126
/// All locales are [TextDirection.ltr] except for locales with the following
2227
/// [Locale.languageCode] values, which are [TextDirection.rtl]:
2328
///

packages/flutter_web_plugins/lib/flutter_web_plugins.dart

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313
///
1414
/// * [How to Write a Flutter Web Plugin](https://medium.com/flutter/how-to-write-a-flutter-web-plugin-5e26c689ea1), a Medium article
1515
/// describing how the `url_launcher` package was created using [flutter_web_plugins].
16+
///
17+
/// @docImport 'src/plugin_registry.dart';
1618
library flutter_web_plugins;
1719

1820
export 'src/navigation/url_strategy.dart';

packages/fuchsia_remote_debug_protocol/lib/src/dart/dart_vm.dart

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,7 @@ class RpcFormatError extends Error {
9090

9191
/// Handles JSON RPC-2 communication with a Dart VM service.
9292
///
93-
/// Either wraps existing RPC calls to the Dart VM service, or runs raw RPC
94-
/// function calls via [invokeRpc].
93+
/// Wraps existing RPC calls to the Dart VM service.
9594
class DartVm {
9695
DartVm._(this._vmService, this.uri);
9796

packages/integration_test/lib/common.dart

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

5+
/// @docImport 'package:flutter_driver/flutter_driver.dart';
6+
///
7+
/// @docImport 'integration_test.dart';
8+
/// @docImport 'integration_test_driver_extended.dart';
9+
library;
10+
511
import 'dart:async';
612
import 'dart:convert';
713

0 commit comments

Comments
 (0)