Skip to content

Commit f261c2f

Browse files
authored
update comments (#115603)
1 parent 5487a7d commit f261c2f

File tree

4 files changed

+29
-29
lines changed

4 files changed

+29
-29
lines changed

packages/flutter/lib/src/material/bottom_sheet_theme.dart

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,19 +39,19 @@ class BottomSheetThemeData with Diagnosticable {
3939
this.constraints,
4040
});
4141

42-
/// Default value for [BottomSheet.backgroundColor].
42+
/// Overrides the default value for [BottomSheet.backgroundColor].
4343
///
4444
/// If null, [BottomSheet] defaults to [Material]'s default.
4545
final Color? backgroundColor;
4646

47-
/// Default value for surfaceTintColor.
47+
/// Overrides the default value for surfaceTintColor.
4848
///
4949
/// If null, [BottomSheet] will not display an overlay color.
5050
///
5151
/// See [Material.surfaceTintColor] for more details.
5252
final Color? surfaceTintColor;
5353

54-
/// Default value for [BottomSheet.elevation].
54+
/// Overrides the default value for [BottomSheet.elevation].
5555
///
5656
/// {@macro flutter.material.material.elevation}
5757
///
@@ -62,21 +62,21 @@ class BottomSheetThemeData with Diagnosticable {
6262
/// as a modal bottom sheet.
6363
final Color? modalBackgroundColor;
6464

65-
/// Default value for barrier color when the Bottom sheet is presented as
65+
/// Overrides the default value for barrier color when the Bottom sheet is presented as
6666
/// a modal bottom sheet.
6767
final Color? modalBarrierColor;
6868

6969
/// Value for [BottomSheet.elevation] when the Bottom sheet is presented as a
7070
/// modal bottom sheet.
7171
final double? modalElevation;
7272

73-
/// Default value for [BottomSheet.shape].
73+
/// Overrides the default value for [BottomSheet.shape].
7474
///
7575
/// If null, no overriding shape is specified for [BottomSheet], so the
7676
/// [BottomSheet] is rectangular.
7777
final ShapeBorder? shape;
7878

79-
/// Default value for [BottomSheet.clipBehavior].
79+
/// Overrides the default value for [BottomSheet.clipBehavior].
8080
///
8181
/// If null, [BottomSheet] uses [Clip.none].
8282
final Clip? clipBehavior;

packages/flutter/lib/src/material/card_theme.dart

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,40 +42,40 @@ class CardTheme with Diagnosticable {
4242
this.shape,
4343
}) : assert(elevation == null || elevation >= 0.0);
4444

45-
/// Default value for [Card.clipBehavior].
45+
/// Overrides the default value for [Card.clipBehavior].
4646
///
4747
/// If null, [Card] uses [Clip.none].
4848
final Clip? clipBehavior;
4949

50-
/// Default value for [Card.color].
50+
/// Overrides the default value for [Card.color].
5151
///
5252
/// If null, [Card] uses [ThemeData.cardColor].
5353
final Color? color;
5454

55-
/// Default value for [Card.shadowColor].
55+
/// Overrides the default value for [Card.shadowColor].
5656
///
5757
/// If null, [Card] defaults to fully opaque black.
5858
final Color? shadowColor;
5959

60-
/// Default value for [Card.surfaceTintColor].
60+
/// Overrides the default value for [Card.surfaceTintColor].
6161
///
6262
/// If null, [Card] will not display an overlay color.
6363
///
6464
/// See [Material.surfaceTintColor] for more details.
6565
final Color? surfaceTintColor;
6666

67-
/// Default value for [Card.elevation].
67+
/// Overrides the default value for [Card.elevation].
6868
///
6969
/// If null, [Card] uses a default of 1.0.
7070
final double? elevation;
7171

72-
/// Default value for [Card.margin].
72+
/// Overrides the default value for [Card.margin].
7373
///
7474
/// If null, [Card] uses a default margin of 4.0 logical pixels on all sides:
7575
/// `EdgeInsets.all(4.0)`.
7676
final EdgeInsetsGeometry? margin;
7777

78-
/// Default value for [Card.shape].
78+
/// Overrides the default value for [Card.shape].
7979
///
8080
/// If null, [Card] then uses a [RoundedRectangleBorder] with a circular
8181
/// corner radius of 4.0.

packages/flutter/lib/src/material/snack_bar_theme.dart

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -66,18 +66,18 @@ class SnackBarThemeData with Diagnosticable {
6666
width == null ||
6767
(width != null && identical(behavior, SnackBarBehavior.floating)),
6868
'Width can only be set if behaviour is SnackBarBehavior.floating');
69-
/// Default value for [SnackBar.backgroundColor].
69+
/// Overrides the default value for [SnackBar.backgroundColor].
7070
///
7171
/// If null, [SnackBar] defaults to dark grey: `Color(0xFF323232)`.
7272
final Color? backgroundColor;
7373

74-
/// Default value for [SnackBarAction.textColor].
74+
/// Overrides the default value for [SnackBarAction.textColor].
7575
///
7676
/// If null, [SnackBarAction] defaults to [ColorScheme.secondary] of
7777
/// [ThemeData.colorScheme] .
7878
final Color? actionTextColor;
7979

80-
/// Default value for [SnackBarAction.disabledTextColor].
80+
/// Overrides the default value for [SnackBarAction.disabledTextColor].
8181
///
8282
/// If null, [SnackBarAction] defaults to [ColorScheme.onSurface] with its
8383
/// opacity set to 0.30 if the [Theme]'s brightness is [Brightness.dark], 0.38
@@ -89,12 +89,12 @@ class SnackBarThemeData with Diagnosticable {
8989
/// If null, [SnackBar] defines its default.
9090
final TextStyle? contentTextStyle;
9191

92-
/// Default value for [SnackBar.elevation].
92+
/// Overrides the default value for [SnackBar.elevation].
9393
///
9494
/// If null, [SnackBar] uses a default of 6.0.
9595
final double? elevation;
9696

97-
/// Default value for [SnackBar.shape].
97+
/// Overrides the default value for [SnackBar.shape].
9898
///
9999
/// If null, [SnackBar] provides different defaults depending on the
100100
/// [SnackBarBehavior]. For [SnackBarBehavior.fixed], no overriding shape is
@@ -103,12 +103,12 @@ class SnackBarThemeData with Diagnosticable {
103103
/// circular corner radius of 4.0.
104104
final ShapeBorder? shape;
105105

106-
/// Default value for [SnackBar.behavior].
106+
/// Overrides the default value for [SnackBar.behavior].
107107
///
108108
/// If null, [SnackBar] will default to [SnackBarBehavior.fixed].
109109
final SnackBarBehavior? behavior;
110110

111-
/// Default value for [SnackBar.width].
111+
/// Overrides the default value for [SnackBar.width].
112112
///
113113
/// If this property is null, then the snack bar will take up the full device
114114
/// width less the margin. This value is only used when [behavior] is

packages/flutter/lib/src/material/tab_bar_theme.dart

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,35 +40,35 @@ class TabBarTheme with Diagnosticable {
4040
this.mouseCursor,
4141
});
4242

43-
/// Default value for [TabBar.indicator].
43+
/// Overrides the default value for [TabBar.indicator].
4444
final Decoration? indicator;
4545

46-
/// Default value for [TabBar.indicatorSize].
46+
/// Overrides the default value for [TabBar.indicatorSize].
4747
final TabBarIndicatorSize? indicatorSize;
4848

49-
/// Default value for [TabBar.labelColor].
49+
/// Overrides the default value for [TabBar.labelColor].
5050
final Color? labelColor;
5151

52-
/// Default value for [TabBar.labelPadding].
52+
/// Overrides the default value for [TabBar.labelPadding].
5353
///
5454
/// If there are few tabs with both icon and text and few
5555
/// tabs with only icon or text, this padding is vertically
5656
/// adjusted to provide uniform padding to all tabs.
5757
final EdgeInsetsGeometry? labelPadding;
5858

59-
/// Default value for [TabBar.labelStyle].
59+
/// Overrides the default value for [TabBar.labelStyle].
6060
final TextStyle? labelStyle;
6161

62-
/// Default value for [TabBar.unselectedLabelColor].
62+
/// Overrides the default value for [TabBar.unselectedLabelColor].
6363
final Color? unselectedLabelColor;
6464

65-
/// Default value for [TabBar.unselectedLabelStyle].
65+
/// Overrides the default value for [TabBar.unselectedLabelStyle].
6666
final TextStyle? unselectedLabelStyle;
6767

68-
/// Default value for [TabBar.overlayColor].
68+
/// Overrides the default value for [TabBar.overlayColor].
6969
final MaterialStateProperty<Color?>? overlayColor;
7070

71-
/// Default value for [TabBar.splashFactory].
71+
/// Overrides the default value for [TabBar.splashFactory].
7272
final InteractiveInkFeatureFactory? splashFactory;
7373

7474
/// {@macro flutter.material.tabs.mouseCursor}

0 commit comments

Comments
 (0)