Unverified Commit e467018d authored by Alexandre Ardhuin's avatar Alexandre Ardhuin Committed by GitHub

alignment of doc comments and annotations (#84256)

parent 9dd8bcd8
...@@ -222,7 +222,7 @@ Future<String> getAndroidManifest(String apk) async { ...@@ -222,7 +222,7 @@ Future<String> getAndroidManifest(String apk) async {
); );
} }
/// Checks that the classes are contained in the APK, throws otherwise. /// Checks that the classes are contained in the APK, throws otherwise.
Future<void> checkApkContainsClasses(File apk, List<String> classes) async { Future<void> checkApkContainsClasses(File apk, List<String> classes) async {
final ApkExtractor extractor = ApkExtractor(apk); final ApkExtractor extractor = ApkExtractor(apk);
for (final String className in classes) { for (final String className in classes) {
......
...@@ -60,10 +60,10 @@ class ScaleStartDetails { ...@@ -60,10 +60,10 @@ class ScaleStartDetails {
/// coordinates. /// coordinates.
final Offset localFocalPoint; final Offset localFocalPoint;
/// The number of pointers being tracked by the gesture recognizer. /// The number of pointers being tracked by the gesture recognizer.
/// ///
/// Typically this is the number of fingers being used to pan the widget using the gesture /// Typically this is the number of fingers being used to pan the widget using the gesture
/// recognizer. /// recognizer.
final int pointerCount; final int pointerCount;
@override @override
......
...@@ -48,7 +48,7 @@ class ContinuousRectangleBorder extends OutlinedBorder { ...@@ -48,7 +48,7 @@ class ContinuousRectangleBorder extends OutlinedBorder {
/// [getOuterPath]. /// [getOuterPath].
final BorderRadiusGeometry borderRadius; final BorderRadiusGeometry borderRadius;
@override @override
EdgeInsetsGeometry get dimensions => EdgeInsets.all(side.width); EdgeInsetsGeometry get dimensions => EdgeInsets.all(side.width);
@override @override
......
...@@ -62,7 +62,7 @@ class RawKeyEventDataWindows extends RawKeyEventData { ...@@ -62,7 +62,7 @@ class RawKeyEventDataWindows extends RawKeyEventData {
@override @override
PhysicalKeyboardKey get physicalKey => kWindowsToPhysicalKey[scanCode] ?? PhysicalKeyboardKey.none; PhysicalKeyboardKey get physicalKey => kWindowsToPhysicalKey[scanCode] ?? PhysicalKeyboardKey.none;
@override @override
LogicalKeyboardKey get logicalKey { LogicalKeyboardKey get logicalKey {
// Look to see if the keyCode is a printable number pad key, so that a // Look to see if the keyCode is a printable number pad key, so that a
// difference between regular keys (e.g. "=") and the number pad version // difference between regular keys (e.g. "=") and the number pad version
...@@ -286,7 +286,7 @@ class RawKeyEventDataWindows extends RawKeyEventData { ...@@ -286,7 +286,7 @@ class RawKeyEventDataWindows extends RawKeyEventData {
/// {@macro flutter.services.RawKeyEventDataWindows.modifierShift} /// {@macro flutter.services.RawKeyEventDataWindows.modifierShift}
static const int modifierNumLock = 1 << 12; static const int modifierNumLock = 1 << 12;
/// This mask is used to check the [modifiers] field to test whether the SCROLL LOCK key /// This mask is used to check the [modifiers] field to test whether the SCROLL LOCK key
/// is pressed. /// is pressed.
/// ///
/// {@macro flutter.services.RawKeyEventDataWindows.modifierShift} /// {@macro flutter.services.RawKeyEventDataWindows.modifierShift}
......
...@@ -127,17 +127,23 @@ abstract class GlobalCupertinoLocalizations implements CupertinoLocalizations { ...@@ -127,17 +127,23 @@ abstract class GlobalCupertinoLocalizations implements CupertinoLocalizations {
} }
/// Subclasses should provide the optional zero pluralization of [datePickerHourSemanticsLabel] based on the ARB file. /// Subclasses should provide the optional zero pluralization of [datePickerHourSemanticsLabel] based on the ARB file.
@protected String? get datePickerHourSemanticsLabelZero => null; @protected
String? get datePickerHourSemanticsLabelZero => null;
/// Subclasses should provide the optional one pluralization of [datePickerHourSemanticsLabel] based on the ARB file. /// Subclasses should provide the optional one pluralization of [datePickerHourSemanticsLabel] based on the ARB file.
@protected String? get datePickerHourSemanticsLabelOne => null; @protected
String? get datePickerHourSemanticsLabelOne => null;
/// Subclasses should provide the optional two pluralization of [datePickerHourSemanticsLabel] based on the ARB file. /// Subclasses should provide the optional two pluralization of [datePickerHourSemanticsLabel] based on the ARB file.
@protected String? get datePickerHourSemanticsLabelTwo => null; @protected
String? get datePickerHourSemanticsLabelTwo => null;
/// Subclasses should provide the optional few pluralization of [datePickerHourSemanticsLabel] based on the ARB file. /// Subclasses should provide the optional few pluralization of [datePickerHourSemanticsLabel] based on the ARB file.
@protected String? get datePickerHourSemanticsLabelFew => null; @protected
String? get datePickerHourSemanticsLabelFew => null;
/// Subclasses should provide the optional many pluralization of [datePickerHourSemanticsLabel] based on the ARB file. /// Subclasses should provide the optional many pluralization of [datePickerHourSemanticsLabel] based on the ARB file.
@protected String? get datePickerHourSemanticsLabelMany => null; @protected
String? get datePickerHourSemanticsLabelMany => null;
/// Subclasses should provide the required other pluralization of [datePickerHourSemanticsLabel] based on the ARB file. /// Subclasses should provide the required other pluralization of [datePickerHourSemanticsLabel] based on the ARB file.
@protected String? get datePickerHourSemanticsLabelOther; @protected
String? get datePickerHourSemanticsLabelOther;
@override @override
String? datePickerHourSemanticsLabel(int hour) { String? datePickerHourSemanticsLabel(int hour) {
...@@ -154,17 +160,23 @@ abstract class GlobalCupertinoLocalizations implements CupertinoLocalizations { ...@@ -154,17 +160,23 @@ abstract class GlobalCupertinoLocalizations implements CupertinoLocalizations {
} }
/// Subclasses should provide the optional zero pluralization of [datePickerMinuteSemanticsLabel] based on the ARB file. /// Subclasses should provide the optional zero pluralization of [datePickerMinuteSemanticsLabel] based on the ARB file.
@protected String? get datePickerMinuteSemanticsLabelZero => null; @protected
String? get datePickerMinuteSemanticsLabelZero => null;
/// Subclasses should provide the optional one pluralization of [datePickerMinuteSemanticsLabel] based on the ARB file. /// Subclasses should provide the optional one pluralization of [datePickerMinuteSemanticsLabel] based on the ARB file.
@protected String? get datePickerMinuteSemanticsLabelOne => null; @protected
String? get datePickerMinuteSemanticsLabelOne => null;
/// Subclasses should provide the optional two pluralization of [datePickerMinuteSemanticsLabel] based on the ARB file. /// Subclasses should provide the optional two pluralization of [datePickerMinuteSemanticsLabel] based on the ARB file.
@protected String? get datePickerMinuteSemanticsLabelTwo => null; @protected
String? get datePickerMinuteSemanticsLabelTwo => null;
/// Subclasses should provide the optional few pluralization of [datePickerMinuteSemanticsLabel] based on the ARB file. /// Subclasses should provide the optional few pluralization of [datePickerMinuteSemanticsLabel] based on the ARB file.
@protected String? get datePickerMinuteSemanticsLabelFew => null; @protected
String? get datePickerMinuteSemanticsLabelFew => null;
/// Subclasses should provide the optional many pluralization of [datePickerMinuteSemanticsLabel] based on the ARB file. /// Subclasses should provide the optional many pluralization of [datePickerMinuteSemanticsLabel] based on the ARB file.
@protected String? get datePickerMinuteSemanticsLabelMany => null; @protected
String? get datePickerMinuteSemanticsLabelMany => null;
/// Subclasses should provide the required other pluralization of [datePickerMinuteSemanticsLabel] based on the ARB file. /// Subclasses should provide the required other pluralization of [datePickerMinuteSemanticsLabel] based on the ARB file.
@protected String? get datePickerMinuteSemanticsLabelOther; @protected
String? get datePickerMinuteSemanticsLabelOther;
@override @override
String? datePickerMinuteSemanticsLabel(int minute) { String? datePickerMinuteSemanticsLabel(int minute) {
...@@ -279,17 +291,23 @@ abstract class GlobalCupertinoLocalizations implements CupertinoLocalizations { ...@@ -279,17 +291,23 @@ abstract class GlobalCupertinoLocalizations implements CupertinoLocalizations {
} }
/// Subclasses should provide the optional zero pluralization of [timerPickerHourLabel] based on the ARB file. /// Subclasses should provide the optional zero pluralization of [timerPickerHourLabel] based on the ARB file.
@protected String? get timerPickerHourLabelZero => null; @protected
String? get timerPickerHourLabelZero => null;
/// Subclasses should provide the optional one pluralization of [timerPickerHourLabel] based on the ARB file. /// Subclasses should provide the optional one pluralization of [timerPickerHourLabel] based on the ARB file.
@protected String? get timerPickerHourLabelOne => null; @protected
String? get timerPickerHourLabelOne => null;
/// Subclasses should provide the optional two pluralization of [timerPickerHourLabel] based on the ARB file. /// Subclasses should provide the optional two pluralization of [timerPickerHourLabel] based on the ARB file.
@protected String? get timerPickerHourLabelTwo => null; @protected
String? get timerPickerHourLabelTwo => null;
/// Subclasses should provide the optional few pluralization of [timerPickerHourLabel] based on the ARB file. /// Subclasses should provide the optional few pluralization of [timerPickerHourLabel] based on the ARB file.
@protected String? get timerPickerHourLabelFew => null; @protected
String? get timerPickerHourLabelFew => null;
/// Subclasses should provide the optional many pluralization of [timerPickerHourLabel] based on the ARB file. /// Subclasses should provide the optional many pluralization of [timerPickerHourLabel] based on the ARB file.
@protected String? get timerPickerHourLabelMany => null; @protected
String? get timerPickerHourLabelMany => null;
/// Subclasses should provide the required other pluralization of [timerPickerHourLabel] based on the ARB file. /// Subclasses should provide the required other pluralization of [timerPickerHourLabel] based on the ARB file.
@protected String? get timerPickerHourLabelOther; @protected
String? get timerPickerHourLabelOther;
@override @override
String? timerPickerHourLabel(int hour) { String? timerPickerHourLabel(int hour) {
...@@ -316,17 +334,23 @@ abstract class GlobalCupertinoLocalizations implements CupertinoLocalizations { ...@@ -316,17 +334,23 @@ abstract class GlobalCupertinoLocalizations implements CupertinoLocalizations {
]; ];
/// Subclasses should provide the optional zero pluralization of [timerPickerMinuteLabel] based on the ARB file. /// Subclasses should provide the optional zero pluralization of [timerPickerMinuteLabel] based on the ARB file.
@protected String? get timerPickerMinuteLabelZero => null; @protected
String? get timerPickerMinuteLabelZero => null;
/// Subclasses should provide the optional one pluralization of [timerPickerMinuteLabel] based on the ARB file. /// Subclasses should provide the optional one pluralization of [timerPickerMinuteLabel] based on the ARB file.
@protected String? get timerPickerMinuteLabelOne => null; @protected
String? get timerPickerMinuteLabelOne => null;
/// Subclasses should provide the optional two pluralization of [timerPickerMinuteLabel] based on the ARB file. /// Subclasses should provide the optional two pluralization of [timerPickerMinuteLabel] based on the ARB file.
@protected String? get timerPickerMinuteLabelTwo => null; @protected
String? get timerPickerMinuteLabelTwo => null;
/// Subclasses should provide the optional few pluralization of [timerPickerMinuteLabel] based on the ARB file. /// Subclasses should provide the optional few pluralization of [timerPickerMinuteLabel] based on the ARB file.
@protected String? get timerPickerMinuteLabelFew => null; @protected
String? get timerPickerMinuteLabelFew => null;
/// Subclasses should provide the optional many pluralization of [timerPickerMinuteLabel] based on the ARB file. /// Subclasses should provide the optional many pluralization of [timerPickerMinuteLabel] based on the ARB file.
@protected String? get timerPickerMinuteLabelMany => null; @protected
String? get timerPickerMinuteLabelMany => null;
/// Subclasses should provide the required other pluralization of [timerPickerMinuteLabel] based on the ARB file. /// Subclasses should provide the required other pluralization of [timerPickerMinuteLabel] based on the ARB file.
@protected String? get timerPickerMinuteLabelOther; @protected
String? get timerPickerMinuteLabelOther;
@override @override
String? timerPickerMinuteLabel(int minute) { String? timerPickerMinuteLabel(int minute) {
...@@ -353,17 +377,23 @@ abstract class GlobalCupertinoLocalizations implements CupertinoLocalizations { ...@@ -353,17 +377,23 @@ abstract class GlobalCupertinoLocalizations implements CupertinoLocalizations {
]; ];
/// Subclasses should provide the optional zero pluralization of [timerPickerSecondLabel] based on the ARB file. /// Subclasses should provide the optional zero pluralization of [timerPickerSecondLabel] based on the ARB file.
@protected String? get timerPickerSecondLabelZero => null; @protected
String? get timerPickerSecondLabelZero => null;
/// Subclasses should provide the optional one pluralization of [timerPickerSecondLabel] based on the ARB file. /// Subclasses should provide the optional one pluralization of [timerPickerSecondLabel] based on the ARB file.
@protected String? get timerPickerSecondLabelOne => null; @protected
String? get timerPickerSecondLabelOne => null;
/// Subclasses should provide the optional two pluralization of [timerPickerSecondLabel] based on the ARB file. /// Subclasses should provide the optional two pluralization of [timerPickerSecondLabel] based on the ARB file.
@protected String? get timerPickerSecondLabelTwo => null; @protected
String? get timerPickerSecondLabelTwo => null;
/// Subclasses should provide the optional few pluralization of [timerPickerSecondLabel] based on the ARB file. /// Subclasses should provide the optional few pluralization of [timerPickerSecondLabel] based on the ARB file.
@protected String? get timerPickerSecondLabelFew => null; @protected
String? get timerPickerSecondLabelFew => null;
/// Subclasses should provide the optional many pluralization of [timerPickerSecondLabel] based on the ARB file. /// Subclasses should provide the optional many pluralization of [timerPickerSecondLabel] based on the ARB file.
@protected String? get timerPickerSecondLabelMany => null; @protected
String? get timerPickerSecondLabelMany => null;
/// Subclasses should provide the required other pluralization of [timerPickerSecondLabel] based on the ARB file. /// Subclasses should provide the required other pluralization of [timerPickerSecondLabel] based on the ARB file.
@protected String? get timerPickerSecondLabelOther; @protected
String? get timerPickerSecondLabelOther;
@override @override
String? timerPickerSecondLabel(int second) { String? timerPickerSecondLabel(int second) {
......
...@@ -6,7 +6,7 @@ import 'package:flutter/widgets.dart'; ...@@ -6,7 +6,7 @@ import 'package:flutter/widgets.dart';
import 'binding.dart'; import 'binding.dart';
/// Ensure the [WidgetsBinding] is initialized. /// Ensure the [WidgetsBinding] is initialized.
WidgetsBinding ensureInitialized([@visibleForTesting Map<String, String>? environment]) { WidgetsBinding ensureInitialized([@visibleForTesting Map<String, String>? environment]) {
if (WidgetsBinding.instance == null) { if (WidgetsBinding.instance == null) {
AutomatedTestWidgetsFlutterBinding(); AutomatedTestWidgetsFlutterBinding();
...@@ -15,8 +15,8 @@ WidgetsBinding ensureInitialized([@visibleForTesting Map<String, String>? enviro ...@@ -15,8 +15,8 @@ WidgetsBinding ensureInitialized([@visibleForTesting Map<String, String>? enviro
return WidgetsBinding.instance!; return WidgetsBinding.instance!;
} }
/// This method is a noop on the web. /// This method is a noop on the web.
void setupHttpOverrides() { } void setupHttpOverrides() { }
/// This method is a noop on the web. /// This method is a noop on the web.
void mockFlutterAssets() { } void mockFlutterAssets() { }
...@@ -18,7 +18,7 @@ class LocalFileComparator extends GoldenFileComparator { ...@@ -18,7 +18,7 @@ class LocalFileComparator extends GoldenFileComparator {
throw UnsupportedError('LocalFileComparator is not supported on the web.'); throw UnsupportedError('LocalFileComparator is not supported on the web.');
} }
@override @override
Future<void> update(Uri golden, Uint8List imageBytes) { Future<void> update(Uri golden, Uint8List imageBytes) {
throw UnsupportedError('LocalFileComparator is not supported on the web.'); throw UnsupportedError('LocalFileComparator is not supported on the web.');
} }
......
...@@ -478,7 +478,7 @@ class Cache { ...@@ -478,7 +478,7 @@ class Cache {
return versionFile.existsSync() ? versionFile.readAsStringSync().trim() : null; return versionFile.existsSync() ? versionFile.readAsStringSync().trim() : null;
} }
/// Delete all stamp files maintained by the cache. /// Delete all stamp files maintained by the cache.
void clearStampFiles() { void clearStampFiles() {
try { try {
getStampFileFor('flutter_tools').deleteSync(); getStampFileFor('flutter_tools').deleteSync();
...@@ -1072,7 +1072,7 @@ class ArtifactUpdater { ...@@ -1072,7 +1072,7 @@ class ArtifactUpdater {
} }
} }
/// Clear any zip/gzip files downloaded. /// Clear any zip/gzip files downloaded.
void removeDownloadedFiles() { void removeDownloadedFiles() {
for (final File file in downloadedFiles) { for (final File file in downloadedFiles) {
if (!file.existsSync()) { if (!file.existsSync()) {
......
...@@ -91,7 +91,7 @@ class VisualStudio { ...@@ -91,7 +91,7 @@ class VisualStudio {
return _bestVisualStudioDetails[_isLaunchableKey] as bool? ?? true; return _bestVisualStudioDetails[_isLaunchableKey] as bool? ?? true;
} }
/// True if the Visual Studio installation is as pre-release version. /// True if the Visual Studio installation is as pre-release version.
bool get isPrerelease => _bestVisualStudioDetails[_isPrereleaseKey] as bool? ?? false; bool get isPrerelease => _bestVisualStudioDetails[_isPrereleaseKey] as bool? ?? false;
/// True if a reboot is required to complete the Visual Studio installation. /// True if a reboot is required to complete the Visual Studio installation.
......
...@@ -160,6 +160,6 @@ class NoDevicesManager extends DeviceManager { ...@@ -160,6 +160,6 @@ class NoDevicesManager extends DeviceManager {
Future<List<Device>> refreshAllConnectedDevices({Duration timeout}) => Future<List<Device>> refreshAllConnectedDevices({Duration timeout}) =>
getAllConnectedDevices(); getAllConnectedDevices();
@override @override
List<DeviceDiscovery> get deviceDiscoverers => <DeviceDiscovery>[]; List<DeviceDiscovery> get deviceDiscoverers => <DeviceDiscovery>[];
} }
...@@ -236,7 +236,7 @@ class FakeOperatingSystemUtils extends Fake implements OperatingSystemUtils { ...@@ -236,7 +236,7 @@ class FakeOperatingSystemUtils extends Fake implements OperatingSystemUtils {
} }
class FakeThrowingFlutterVersion extends FakeFlutterVersion { class FakeThrowingFlutterVersion extends FakeFlutterVersion {
@override @override
String get frameworkCommitDate { String get frameworkCommitDate {
throw VersionCheckError('version error'); throw VersionCheckError('version error');
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment