diff --git a/packages/flutter/lib/src/material/app_bar.dart b/packages/flutter/lib/src/material/app_bar.dart index 4b520fc90c3..31956c1dea5 100644 --- a/packages/flutter/lib/src/material/app_bar.dart +++ b/packages/flutter/lib/src/material/app_bar.dart @@ -1243,14 +1243,14 @@ class SliverAppBar extends StatefulWidget { /// Defines the height of the app bar when it is collapsed. /// - /// By default, the collapsed height is [toolbarHeight]. If [bottom] widget - /// is specified, then its [PreferredSizeWidget.height] is added to the - /// height. If [primary] is true, then the [MediaQuery] top padding, - /// [EdgeInsets.top] of [MediaQueryData.padding], is added as well. + /// By default, the collapsed height is [toolbarHeight]. If [bottom] widget is + /// specified, then its height from [PreferredSizeWidget.preferredSize] is + /// added to the height. If [primary] is true, then the [MediaQuery] top + /// padding, [EdgeInsets.top] of [MediaQueryData.padding], is added as well. /// /// If [pinned] and [floating] are true, with [bottom] set, the default - /// collapsed height is only [bottom.preferredSize.height] with the - /// [MediaQuery] top padding. + /// collapsed height is only the height of [PreferredSizeWidget.preferredSize] + /// with the [MediaQuery] top padding. final double collapsedHeight; /// The size of the app bar when it is fully expanded. diff --git a/packages/flutter/lib/src/material/floating_action_button.dart b/packages/flutter/lib/src/material/floating_action_button.dart index d3c9e92afbd..cf6db513db9 100644 --- a/packages/flutter/lib/src/material/floating_action_button.dart +++ b/packages/flutter/lib/src/material/floating_action_button.dart @@ -254,7 +254,7 @@ class FloatingActionButton extends StatelessWidget { /// If this property is null, then the /// [FloatingActionButtonThemeData.backgroundColor] of /// [ThemeData.floatingActionButtonTheme] is used. If that property is also - /// null, then the [Theme]'s [ThemeData.colorScheme.secondary] color is used. + /// null, then the [Theme]'s [ColorScheme.secondary] color is used. final Color backgroundColor; /// The color to use for filling the button when the button has input focus. diff --git a/packages/flutter/lib/src/material/input_decorator.dart b/packages/flutter/lib/src/material/input_decorator.dart index a74fd106ac0..b41ee652d8c 100644 --- a/packages/flutter/lib/src/material/input_decorator.dart +++ b/packages/flutter/lib/src/material/input_decorator.dart @@ -2500,11 +2500,10 @@ class InputDecoration { /// Creates a bundle of the border, labels, icons, and styles used to /// decorate a Material Design text field. /// - /// Unless specified by [ThemeData.inputDecorationTheme], - /// [InputDecorator] defaults [isDense] to false, and [filled] to false, - /// and [maxLines] to 1. The default border is an instance - /// of [UnderlineInputBorder]. If [border] is [InputBorder.none] then - /// no border is drawn. + /// Unless specified by [ThemeData.inputDecorationTheme], [InputDecorator] + /// defaults [isDense] to false and [filled] to false. The default border is + /// an instance of [UnderlineInputBorder]. If [border] is [InputBorder.none] + /// then no border is drawn. /// /// The [enabled] argument must not be null. /// @@ -2659,9 +2658,9 @@ class InputDecoration { /// Text that provides context about the [InputDecorator.child]'s value, such /// as how the value will be used. /// - /// If non-null, the text is displayed below the input [child], in the same - /// location as [errorText]. If a non-null [errorText] value is specified then - /// the helper text is not shown. + /// If non-null, the text is displayed below the [InputDecorator.child], in + /// the same location as [errorText]. If a non-null [errorText] value is + /// specified then the helper text is not shown. final String helperText; /// The style to use for the [helperText]. @@ -2683,9 +2682,9 @@ class InputDecoration { /// Text that suggests what sort of input the field accepts. /// /// Displayed on top of the [InputDecorator.child] (i.e., at the same location - /// on the screen where text may be entered in the input [child]) when the - /// input [isEmpty] and either (a) [labelText] is null or (b) the input has - /// the focus. + /// on the screen where text may be entered in the [InputDecorator.child]) + /// when the input [isEmpty] and either (a) [labelText] is null or (b) the + /// input has the focus. final String hintText; /// The style to use for the [hintText]. @@ -3081,8 +3080,8 @@ class InputDecoration { /// If true the decoration's container is filled with [fillColor]. /// - /// When [isFocused] is true, the [focusColor] is also blended into the final - /// fill color. When [isHovering] is true, the [hoverColor] is also blended + /// When [InputDecorator.isFocused] is true, the [focusColor] is also blended into the final + /// fill color. When [InputDecorator.isHovering] is true, the [hoverColor] is also blended /// into the final fill color. /// /// Typically this field set to true if [border] is an @@ -3098,9 +3097,9 @@ class InputDecoration { /// The base fill color of the decoration's container color. /// - /// When [isFocused] is true, the [focusColor] is also blended into the final - /// fill color. When [isHovering] is true, the [hoverColor] is also blended - /// into the final fill color. + /// When [InputDecorator.isFocused] is true, the [focusColor] is also blended + /// into the final fill color. When [InputDecorator.isHovering] is true, the + /// [hoverColor] is also blended into the final fill color. /// /// By default the fillColor is based on the current [Theme]. /// @@ -3114,7 +3113,7 @@ class InputDecoration { /// The color to blend with [fillColor] and fill the decoration's container /// with, if [filled] is true and the container has input focus. /// - /// When [isHovering] is true, the [hoverColor] is also blended into the final + /// When [InputDecorator.isHovering] is true, the [hoverColor] is also blended into the final /// fill color. /// /// By default the [focusColor] is based on the current [Theme]. @@ -3129,11 +3128,11 @@ class InputDecoration { /// is being hovered over by a mouse. /// /// If [filled] is true, the color is blended with [fillColor] and fills the - /// decoration's container. When [isFocused] is true, the [focusColor] is also - /// blended into the final fill color. + /// decoration's container. When [InputDecorator.isFocused] is true, the + /// [focusColor] is also blended into the final fill color. /// - /// If [filled] is false, and [isFocused] is false, the color is blended over - /// the [enabledBorder]'s color. + /// If [filled] is false, and [InputDecorator.isFocused] is false, the color + /// is blended over the [enabledBorder]'s color. /// /// By default the [hoverColor] is based on the current [Theme]. /// @@ -3664,17 +3663,17 @@ class InputDecorationTheme with Diagnosticable { /// The style to use for [InputDecoration.helperText]. final TextStyle helperStyle; - /// The maximum number of lines the [InputDecorator.helperText] can occupy. + /// The maximum number of lines the [InputDecoration.helperText] can occupy. /// - /// Defaults to null, which means that the [InputDecorator.helperText] will be - /// limited to a single line with [TextOverflow.ellipsis]. + /// Defaults to null, which means that the [InputDecoration.helperText] will + /// be limited to a single line with [TextOverflow.ellipsis]. /// /// This value is passed along to the [Text.maxLines] attribute /// of the [Text] widget used to display the helper. /// /// See also: /// - /// * [errorMaxLines], the equivalent but for the [InputDecorator.errorText]. + /// * [errorMaxLines], the equivalent but for the [InputDecoration.errorText]. final int helperMaxLines; /// The style to use for the [InputDecoration.hintText]. @@ -3696,8 +3695,8 @@ class InputDecorationTheme with Diagnosticable { /// The maximum number of lines the [InputDecoration.errorText] can occupy. /// - /// Defaults to null, which means that the [errorText] will be limited - /// to a single line with [TextOverflow.ellipsis]. + /// Defaults to null, which means that the [InputDecoration.errorText] will be + /// limited to a single line with [TextOverflow.ellipsis]. /// /// This value is passed along to the [Text.maxLines] attribute /// of the [Text] widget used to display the error. diff --git a/packages/flutter/lib/src/material/navigation_rail.dart b/packages/flutter/lib/src/material/navigation_rail.dart index c2a29b86501..67890a52784 100644 --- a/packages/flutter/lib/src/material/navigation_rail.dart +++ b/packages/flutter/lib/src/material/navigation_rail.dart @@ -262,7 +262,7 @@ class NavigationRail extends StatefulWidget { /// When one of the [destinations] is selected the [selectedLabelTextStyle] /// will be used instead. /// - /// The default value is based on the [Theme]'s [TextTheme.bodyText]. The + /// The default value is based on the [Theme]'s [TextTheme.bodyText1]. The /// default color is based on the [Theme]'s [ColorScheme.onSurface]. /// /// Properties from this text style, or @@ -275,7 +275,7 @@ class NavigationRail extends StatefulWidget { /// When a [NavigationRailDestination] is not selected, /// [unselectedLabelTextStyle] will be used. /// - /// The default value is based on the [TextTheme.bodyText] of + /// The default value is based on the [TextTheme.bodyText1] of /// [ThemeData.textTheme]. The default color is based on the [Theme]'s /// [ColorScheme.primary]. /// diff --git a/packages/flutter/lib/src/material/outlined_button.dart b/packages/flutter/lib/src/material/outlined_button.dart index 258a5e736c2..a911f875015 100644 --- a/packages/flutter/lib/src/material/outlined_button.dart +++ b/packages/flutter/lib/src/material/outlined_button.dart @@ -96,15 +96,15 @@ class OutlinedButton extends ButtonStyleButton { /// [ButtonStyle] given simple values. /// /// The [primary], and [onSurface] colors are used to to create a - /// [MaterialStateProperty] [ButtonStyle.foreground] value in the same way - /// that [defaultStyleOf] uses the [ColorScheme] colors with the same names. - /// Specify a value for [primary] to specify the color of the button's text - /// and icons as well as the overlay colors used to indicate the hover, focus, - /// and pressed states. Use [onSurface] to specify the button's disabled text - /// and icon color. + /// [MaterialStateProperty] [ButtonStyle.foregroundColor] value in the same + /// way that [defaultStyleOf] uses the [ColorScheme] colors with the same + /// names. Specify a value for [primary] to specify the color of the button's + /// text and icons as well as the overlay colors used to indicate the hover, + /// focus, and pressed states. Use [onSurface] to specify the button's + /// disabled text and icon color. /// /// Similarly, the [enabledMouseCursor] and [disabledMouseCursor] - /// parameters are used to construct [ButtonStyle].mouseCursor. + /// parameters are used to construct [ButtonStyle.mouseCursor]. /// /// All of the other parameters are either used directly or used to /// create a [MaterialStateProperty] with a single value for all @@ -192,7 +192,7 @@ class OutlinedButton extends ButtonStyleButton { /// each state and "others" means all other states. /// /// The color of the [ButtonStyle.textStyle] is not used, the - /// [ButtonStyle.foreground] color is used instead. + /// [ButtonStyle.foregroundColor] is used instead. /// /// * `textStyle` - Theme.textTheme.button /// * `backgroundColor` - transparent diff --git a/packages/flutter/lib/src/material/page.dart b/packages/flutter/lib/src/material/page.dart index 2550e33f660..9aadd28cb30 100644 --- a/packages/flutter/lib/src/material/page.dart +++ b/packages/flutter/lib/src/material/page.dart @@ -35,7 +35,7 @@ import 'theme.dart'; class MaterialPageRoute extends PageRoute with MaterialRouteTransitionMixin { /// Construct a MaterialPageRoute whose contents are defined by [builder]. /// - /// The values of [builder], [maintainState], and [PageRoute.fullScreenDialog] + /// The values of [builder], [maintainState], and [PageRoute.fullscreenDialog] /// must not be null. MaterialPageRoute({ @required this.builder, diff --git a/packages/flutter/lib/src/material/progress_indicator.dart b/packages/flutter/lib/src/material/progress_indicator.dart index 08c8215ca29..841e9154f08 100644 --- a/packages/flutter/lib/src/material/progress_indicator.dart +++ b/packages/flutter/lib/src/material/progress_indicator.dart @@ -87,8 +87,9 @@ abstract class ProgressIndicator extends StatefulWidget { /// intended for use with determinate progress indicators to announce /// how far along they are. /// - /// For determinate progress indicators, this will be defaulted to [value] - /// expressed as a percentage, i.e. `0.1` will become '10%'. + /// For determinate progress indicators, this will be defaulted to + /// [ProgressIndicator.value] expressed as a percentage, i.e. `0.1` will + /// become '10%'. /// {@endtemplate} final String semanticsValue; diff --git a/packages/flutter/lib/src/material/range_slider.dart b/packages/flutter/lib/src/material/range_slider.dart index 104b8878a6d..7e65ffbcac0 100644 --- a/packages/flutter/lib/src/material/range_slider.dart +++ b/packages/flutter/lib/src/material/range_slider.dart @@ -314,7 +314,7 @@ class RangeSlider extends StatefulWidget { /// /// Each label is rendered using the active [ThemeData]'s /// [TextTheme.bodyText1] text style, with the theme data's - /// [ColorScheme.onPrimaryColor]. The label's text style can be overridden + /// [ColorScheme.onPrimary] color. The label's text style can be overridden /// with [SliderThemeData.valueIndicatorTextStyle]. /// /// If null, then the value indicator will not be displayed. diff --git a/packages/flutter/lib/src/material/scaffold.dart b/packages/flutter/lib/src/material/scaffold.dart index d8aaee647a6..dd6952aff4b 100644 --- a/packages/flutter/lib/src/material/scaffold.dart +++ b/packages/flutter/lib/src/material/scaffold.dart @@ -1330,10 +1330,11 @@ class Scaffold extends StatefulWidget { /// drawer. /// /// By default, the value used is 20.0 added to the padding edge of - /// `MediaQuery.of(context).padding` that corresponds to [alignment]. - /// This ensures that the drag area for notched devices is not obscured. For - /// example, if `TextDirection.of(context)` is set to [TextDirection.ltr], - /// 20.0 will be added to `MediaQuery.of(context).padding.left`. + /// `MediaQuery.of(context).padding` that corresponds to the surrounding + /// [TextDirection]. This ensures that the drag area for notched devices is + /// not obscured. For example, if `TextDirection.of(context)` is set to + /// [TextDirection.ltr], 20.0 will be added to + /// `MediaQuery.of(context).padding.left`. final double drawerEdgeDragWidth; /// Determines if the [Scaffold.drawer] can be opened with a drag diff --git a/packages/flutter/lib/src/material/selectable_text.dart b/packages/flutter/lib/src/material/selectable_text.dart index 857238af42b..dbebf14c9e1 100644 --- a/packages/flutter/lib/src/material/selectable_text.dart +++ b/packages/flutter/lib/src/material/selectable_text.dart @@ -390,7 +390,8 @@ class SelectableText extends StatefulWidget { /// If not set, select all and copy will be enabled by default. final ToolbarOptions toolbarOptions; - /// {@macro flutter.rendering.editable.selectionEnabled} + /// True if interactive selection is enabled based on the values of + /// [enableInteractiveSelection]. bool get selectionEnabled { return enableInteractiveSelection; } diff --git a/packages/flutter/lib/src/material/slider_theme.dart b/packages/flutter/lib/src/material/slider_theme.dart index 7510fdcb440..bb139a76bd1 100644 --- a/packages/flutter/lib/src/material/slider_theme.dart +++ b/packages/flutter/lib/src/material/slider_theme.dart @@ -552,7 +552,7 @@ class SliderThemeData with Diagnosticable { /// Use this only if you want to control the visual appearance of the thumbs /// in terms of a logical pixel value. This can be done when you want a /// specific look for thumbs when they are close together. To limit with the - /// real values, rather than logical pixels, the [values] can be restricted by + /// real values, rather than logical pixels, the values can be restricted by /// the parent. final double minThumbSeparation; @@ -821,9 +821,9 @@ abstract class SliderComponentShape { /// /// {@template flutter.material.slider.shape.argument.enableAnimation} /// The `enableAnimation` argument is an animation triggered when the [Slider] - /// is enabled, and it reverses when the slider is disabled. Enabled is the - /// [Slider.isInteractive] state. Use this to paint intermediate frames for - /// this shape when the slider changes enabled state. + /// is enabled, and it reverses when the slider is disabled. The [Slider] is + /// enabled when [Slider.onChanged] is not null.Use this to paint intermediate + /// frames for this shape when the slider changes enabled state. /// {@endtemplate} /// /// {@template flutter.material.slider.shape.argument.isDiscrete} @@ -924,8 +924,8 @@ abstract class SliderTickMarkShape { /// {@macro flutter.material.slider.shape.argument.sliderTheme} /// /// {@template flutter.material.slider.shape.argument.isEnabled} - /// The `isEnabled` argument has the same value as [Slider.isInteractive]. When - /// true, the slider will respond to input. + /// The `isEnabled` argument is false when [Slider.onChanged] is null and true + /// otherwise. When true, the slider will respond to input. /// {@endtemplate} Size getPreferredSize({ SliderThemeData sliderTheme, @@ -1085,8 +1085,8 @@ abstract class RangeSliderThumbShape { /// {@endtemplate} /// /// {@template flutter.material.rangeSlider.shape.argument.isEnabled} - /// The `isEnabled` argument has the same value as [RangeSlider.isEnabled]. - /// When true, the slider will respond to input. + /// The `isEnabled` argument is false when [RangeSlider.onChanged] is null and + /// true otherwise. When true, the slider will respond to input. /// {@endtemplate} Size getPreferredSize(bool isEnabled, bool isDiscrete); @@ -1106,9 +1106,10 @@ abstract class RangeSliderThumbShape { /// /// {@template flutter.material.rangeSlider.shape.argument.enableAnimation} /// The `enableAnimation` argument is an animation triggered when the - /// [RangeSlider] is enabled, and it reverses when the slider is disabled. - /// Enabled is the [RangeSlider.isEnabled] state. Use this to paint - /// intermediate frames for this shape when the slider changes enabled state. + /// [RangeSlider] is enabled, and it reverses when the slider is disabled. The + /// [RangeSlider] is enabled when [RangeSlider.onChanged] is not null. Use + /// this to paint intermediate frames for this shape when the slider changes + /// enabled state. /// {@endtemplate} /// /// {@macro flutter.material.rangeSlider.shape.argument.isDiscrete} diff --git a/packages/flutter/lib/src/material/snack_bar.dart b/packages/flutter/lib/src/material/snack_bar.dart index 6412b056ec7..39c1e7a39cd 100644 --- a/packages/flutter/lib/src/material/snack_bar.dart +++ b/packages/flutter/lib/src/material/snack_bar.dart @@ -50,7 +50,7 @@ enum SnackBarClosedReason { /// The snack bar was closed after the user tapped a [SnackBarAction]. action, - /// The snack bar was closed through a [SemanticAction.dismiss]. + /// The snack bar was closed through a [SemanticsAction.dismiss]. dismiss, /// The snack bar was closed by a user's swipe. @@ -92,11 +92,12 @@ class SnackBarAction extends StatefulWidget { assert(onPressed != null), super(key: key); - /// The button label color. If not provided, defaults to [accentColor]. + /// The button label color. If not provided, defaults to + /// [SnackBarThemeData.actionTextColor]. final Color textColor; /// The button disabled label color. This color is shown after the - /// [snackBarAction] is dismissed. + /// [SnackBarAction] is dismissed. final Color disabledTextColor; /// The button label. @@ -207,9 +208,10 @@ class SnackBar extends StatefulWidget { final Widget content; /// The snack bar's background color. If not specified it will use - /// [ThemeData.snackBarTheme.backgroundColor]. If that is not specified - /// it will default to a dark variation of [ColorScheme.surface] for light - /// themes, or [ColorScheme.onSurface] for dark themes. + /// [SnackBarThemeData.backgroundColor] of [ThemeData.snackBarTheme]. If that + /// is not specified it will default to a dark variation of + /// [ColorScheme.surface] for light themes, or [ColorScheme.onSurface] for + /// dark themes. final Color backgroundColor; /// The z-coordinate at which to place the snack bar. This controls the size @@ -217,8 +219,9 @@ class SnackBar extends StatefulWidget { /// /// Defines the card's [Material.elevation]. /// - /// If this property is null, then [ThemeData.snackBarTheme.elevation] is - /// used, if that is also null, the default value is 6.0. + /// If this property is null, then [SnackBarThemeData.elevation] of + /// [ThemeData.snackBarTheme] is used, if that is also null, the default value + /// is 6.0. final double elevation; /// Empty space to surround the snack bar. @@ -253,11 +256,12 @@ class SnackBar extends StatefulWidget { /// /// Defines the snack bar's [Material.shape]. /// - /// If this property is null then [ThemeData.snackBarTheme.shape] is used. - /// If that's null then the shape will depend on the [SnackBarBehavior]. For - /// [SnackBarBehavior.fixed], no overriding shape is specified, so the - /// [SnackBar] is rectangular. For [SnackBarBehavior.floating], it uses a - /// [RoundedRectangleBorder] with a circular corner radius of 4.0. + /// If this property is null then [SnackBarThemeData.shape] of + /// [ThemeData.snackBarTheme] is used. If that's null then the shape will + /// depend on the [SnackBarBehavior]. For [SnackBarBehavior.fixed], no + /// overriding shape is specified, so the [SnackBar] is rectangular. For + /// [SnackBarBehavior.floating], it uses a [RoundedRectangleBorder] with a + /// circular corner radius of 4.0. final ShapeBorder shape; /// This defines the behavior and location of the snack bar. @@ -266,8 +270,9 @@ class SnackBar extends StatefulWidget { /// location should be adjusted when the scaffold also includes a /// [FloatingActionButton] or a [BottomNavigationBar] /// - /// If this property is null, then [ThemeData.snackBarTheme.behavior] - /// is used. If that is null, then the default is [SnackBarBehavior.fixed]. + /// If this property is null, then [SnackBarThemeData.behavior] of + /// [ThemeData.snackBarTheme] is used. If that is null, then the default is + /// [SnackBarBehavior.fixed]. final SnackBarBehavior behavior; /// (optional) An action that the user can take based on the snack bar. diff --git a/packages/flutter/lib/src/material/snack_bar_theme.dart b/packages/flutter/lib/src/material/snack_bar_theme.dart index ef9d15fb652..0f3c11f2fbd 100644 --- a/packages/flutter/lib/src/material/snack_bar_theme.dart +++ b/packages/flutter/lib/src/material/snack_bar_theme.dart @@ -71,7 +71,8 @@ class SnackBarThemeData with Diagnosticable { /// Default value for [SnackBarAction.textColor]. /// - /// If null, [SnackBarAction] defaults to [ThemeData.colorScheme.secondaryColor]. + /// If null, [SnackBarAction] defaults to [ColorScheme.secondary] of + /// [ThemeData.colorScheme] . final Color actionTextColor; /// Default value for [SnackBarAction.disabledTextColor]. diff --git a/packages/flutter/lib/src/material/switch.dart b/packages/flutter/lib/src/material/switch.dart index 5404320739f..0cfadd0301f 100644 --- a/packages/flutter/lib/src/material/switch.dart +++ b/packages/flutter/lib/src/material/switch.dart @@ -96,7 +96,7 @@ class Switch extends StatefulWidget { /// If a [CupertinoSwitch] is created, the following parameters are /// ignored: [activeTrackColor], [inactiveThumbColor], [inactiveTrackColor], /// [activeThumbImage], [onActiveThumbImageError], [inactiveThumbImage], - /// [onInactiveImageThumbError], [materialTapTargetSize]. + /// [onInactiveThumbImageError], [materialTapTargetSize]. /// /// The target platform is based on the current [Theme]: [ThemeData.platform]. const Switch.adaptive({ diff --git a/packages/flutter/lib/src/material/switch_list_tile.dart b/packages/flutter/lib/src/material/switch_list_tile.dart index c8609102996..2cfa7074d29 100644 --- a/packages/flutter/lib/src/material/switch_list_tile.dart +++ b/packages/flutter/lib/src/material/switch_list_tile.dart @@ -290,7 +290,7 @@ class SwitchListTile extends StatelessWidget { /// /// If a [CupertinoSwitch] is created, the following parameters are /// ignored: [activeTrackColor], [inactiveThumbColor], [inactiveTrackColor], - /// [activeThumbImage], [inactiveThumbImage], [materialTapTargetSize]. + /// [activeThumbImage], [inactiveThumbImage]. const SwitchListTile.adaptive({ Key key, @required this.value, diff --git a/packages/flutter/lib/src/material/tab_indicator.dart b/packages/flutter/lib/src/material/tab_indicator.dart index 9393f26a9f0..e32cb93e71f 100644 --- a/packages/flutter/lib/src/material/tab_indicator.dart +++ b/packages/flutter/lib/src/material/tab_indicator.dart @@ -32,9 +32,10 @@ class UnderlineTabIndicator extends Decoration { /// Locates the selected tab's underline relative to the tab's boundary. /// - /// The [TabBar.indicatorSize] property can be used to define the - /// tab indicator's bounds in terms of its (centered) tab widget with - /// [TabIndicatorSize.label], or the entire tab with [TabIndicatorSize.tab]. + /// The [TabBar.indicatorSize] property can be used to define the tab + /// indicator's bounds in terms of its (centered) tab widget with + /// [TabBarIndicatorSize.label], or the entire tab with + /// [TabBarIndicatorSize.tab]. final EdgeInsetsGeometry insets; @override diff --git a/packages/flutter/lib/src/material/text_button.dart b/packages/flutter/lib/src/material/text_button.dart index e9f2d6ba9fe..449733d3cd2 100644 --- a/packages/flutter/lib/src/material/text_button.dart +++ b/packages/flutter/lib/src/material/text_button.dart @@ -103,15 +103,15 @@ class TextButton extends ButtonStyleButton { /// [ButtonStyle] given simple values. /// /// The [primary], and [onSurface] colors are used to to create a - /// [MaterialStateProperty] [foreground] value in the same way that - /// [defaultStyleOf] uses the [ColorScheme] colors with the same - /// names. Specify a value for [primary] to specify the color of the - /// button's text and icons as well as the overlay colors used to - /// indicate the hover, focus, and pressed states. Use [onSurface] - /// to specify the button's disabled text and icon color. + /// [MaterialStateProperty] [ButtonStyle.foregroundColor] value in the same + /// way that [defaultStyleOf] uses the [ColorScheme] colors with the same + /// names. Specify a value for [primary] to specify the color of the button's + /// text and icons as well as the overlay colors used to indicate the hover, + /// focus, and pressed states. Use [onSurface] to specify the button's + /// disabled text and icon color. /// /// Similarly, the [enabledMouseCursor] and [disabledMouseCursor] - /// parameters are used to construct [ButtonStyle].mouseCursor. + /// parameters are used to construct [ButtonStyle.mouseCursor]. /// /// All of the other parameters are either used directly or used to /// create a [MaterialStateProperty] with a single value for all @@ -200,8 +200,8 @@ class TextButton extends ButtonStyleButton { /// EdgeInsets constructors and `EdgeInsetsGeometry.lerp` have been /// abbreviated for readability. /// - /// The color of the [textStyle] is not used, the [foreground] color - /// is used instead. + /// The color of the [ButtonStyle.textStyle] is not used, the + /// [ButtonStyle.foregroundColor] color is used instead. /// /// * `textStyle` - Theme.textTheme.button /// * `backgroundColor` - transparent diff --git a/packages/flutter/lib/src/material/text_button_theme.dart b/packages/flutter/lib/src/material/text_button_theme.dart index 42943ae3157..0c5decc9e37 100644 --- a/packages/flutter/lib/src/material/text_button_theme.dart +++ b/packages/flutter/lib/src/material/text_button_theme.dart @@ -103,7 +103,7 @@ class TextButtonTheme extends InheritedTheme { /// The closest instance of this class that encloses the given context. /// - /// If there is no enclosing [TextButtonsTheme] widget, then + /// If there is no enclosing [TextButtonTheme] widget, then /// [ThemeData.textButtonTheme] is used. /// /// Typical usage is as follows: diff --git a/packages/flutter/lib/src/material/text_field.dart b/packages/flutter/lib/src/material/text_field.dart index c3737eb7ba7..42ff4eba7d3 100644 --- a/packages/flutter/lib/src/material/text_field.dart +++ b/packages/flutter/lib/src/material/text_field.dart @@ -556,8 +556,9 @@ class TextField extends StatefulWidget { /// character count. /// /// If [maxLengthEnforced] is set to false, then more than [maxLength] - /// characters may be entered, but the error counter and divider will - /// switch to the [decoration.errorStyle] when the limit is exceeded. + /// characters may be entered, but the error counter and divider will switch + /// to the [decoration]'s [InputDecoration.errorStyle] when the limit is + /// exceeded. /// /// ## Limitations /// @@ -601,7 +602,7 @@ class TextField extends StatefulWidget { /// /// * [inputFormatters], which are called before [onChanged] /// runs and can validate and change ("format") the input value. - /// * [onEditingComplete], [onSubmitted], [onSelectionChanged]: + /// * [onEditingComplete], [onSubmitted]: /// which are more specialized input change notifications. final ValueChanged onChanged; @@ -624,7 +625,7 @@ class TextField extends StatefulWidget { /// [decoration] is rendered in grey. /// /// If non-null this property overrides the [decoration]'s - /// [Decoration.enabled] property. + /// [InputDecoration.enabled] property. final bool enabled; /// {@macro flutter.widgets.editableText.cursorWidth} @@ -638,7 +639,7 @@ class TextField extends StatefulWidget { /// The color to use when painting the cursor. /// - /// Defaults to [ThemeData.cursorColor] or [CupertinoTheme.primaryColor] + /// Defaults to [ThemeData.cursorColor] or [CupertinoThemeData.primaryColor] /// depending on [ThemeData.platform]. final Color cursorColor; @@ -712,15 +713,15 @@ class TextField extends StatefulWidget { /// the editing position. final MouseCursor mouseCursor; - /// Callback that generates a custom [InputDecorator.counter] widget. + /// Callback that generates a custom [InputDecoration.counter] widget. /// /// See [InputCounterWidgetBuilder] for an explanation of the passed in /// arguments. The returned widget will be placed below the line in place of - /// the default widget built when [counterText] is specified. + /// the default widget built when [InputDecoration.counterText] is specified. /// /// The returned widget will be wrapped in a [Semantics] widget for - /// accessibility, but it also needs to be accessible itself. For example, - /// if returning a Text widget, set the [semanticsLabel] property. + /// accessibility, but it also needs to be accessible itself. For example, + /// if returning a Text widget, set the [Text.semanticsLabel] property. /// /// {@tool snippet} /// ```dart diff --git a/packages/flutter/lib/src/material/theme_data.dart b/packages/flutter/lib/src/material/theme_data.dart index b3407396b5d..b59d2a39176 100644 --- a/packages/flutter/lib/src/material/theme_data.dart +++ b/packages/flutter/lib/src/material/theme_data.dart @@ -91,7 +91,7 @@ const Color _kDarkThemeSplashColor = Color(0x40CCCCCC); enum MaterialTapTargetSize { /// Expands the minimum tap target size to 48px by 48px. /// - /// This is the default value of [ThemeData.materialHitTestSize] and the + /// This is the default value of [ThemeData.materialTapTargetSize] and the /// recommended size to conform to Android accessibility scanner /// recommendations. padded, @@ -954,7 +954,7 @@ class ThemeData with Diagnosticable { /// objects at lower layers that try to emulate the underlying platform /// platform can depend on [defaultTargetPlatform] directly, or may require /// that the target platform be provided as an argument. The - /// [dart.io.Platform] object should only be used directly when it's critical + /// [dart:io.Platform] object should only be used directly when it's critical /// to actually know the current platform, without any overrides possible (for /// example, when a system API is about to be called). /// @@ -979,17 +979,17 @@ class ThemeData with Diagnosticable { /// overlay increases in opacity. [applyElevationOverlayColor] turns the /// application of this overlay on or off for dark themes. /// - /// If [true] and [brightness] is [Brightness.dark], a - /// semi-transparent version of [colorScheme.onSurface] will be - /// applied on top of [Material] widgets that have a [colorScheme.surface] + /// If true and [brightness] is [Brightness.dark], a + /// semi-transparent version of [ColorScheme.onSurface] will be + /// applied on top of [Material] widgets that have a [ColorScheme.surface] /// color. The level of transparency is based on [Material.elevation] as /// per the Material Dark theme specification. /// - /// If [false] the surface color will be used unmodified. + /// If false the surface color will be used unmodified. /// - /// Defaults to [false] in order to maintain backwards compatibility with + /// Defaults to false in order to maintain backwards compatibility with /// apps that were built before the Material Dark theme specification - /// was published. New apps should set this to [true] for any themes + /// was published. New apps should set this to true for any themes /// where [brightness] is [Brightness.dark]. /// /// See also: @@ -1004,9 +1004,9 @@ class ThemeData with Diagnosticable { /// Default [MaterialPageRoute] transitions per [TargetPlatform]. /// - /// [MaterialPageRoute.buildTransitions] delegates to a [PageTransitionsBuilder] - /// whose [PageTransitionsBuilder.platform] matches [platform]. If a matching - /// builder is not found, a builder whose platform is null is used. + /// [MaterialPageRoute.buildTransitions] delegates to a [platform] specific + /// [PageTransitionsBuilder]. If a matching builder is not found, a builder + /// whose platform is null is used. final PageTransitionsTheme pageTransitionsTheme; /// A theme for customizing the color, elevation, brightness, iconTheme and @@ -1049,7 +1049,7 @@ class ThemeData with Diagnosticable { /// /// By default, [cupertinoOverrideTheme] is null and Cupertino widgets /// descendant to the Material [Theme] will adhere to a [CupertinoTheme] - /// derived from the Material [ThemeData]. e.g. [ThemeData]'s [ColorTheme] + /// derived from the Material [ThemeData]. e.g. [ThemeData]'s [ColorScheme] /// will also inform the [CupertinoThemeData]'s `primaryColor` etc. /// /// This cascading effect for individual attributes of the [CupertinoThemeData] diff --git a/packages/flutter/lib/src/material/tooltip.dart b/packages/flutter/lib/src/material/tooltip.dart index 3741e6f1a7b..a7b2e830e1f 100644 --- a/packages/flutter/lib/src/material/tooltip.dart +++ b/packages/flutter/lib/src/material/tooltip.dart @@ -110,7 +110,7 @@ class Tooltip extends StatefulWidget { /// Whether the tooltip's [message] should be excluded from the semantics /// tree. /// - /// Defaults to false. A tooltip will add a [Semantics.label] that is set to + /// Defaults to false. A tooltip will add a [Semantics] label that is set to /// [Tooltip.message]. Set this property to true if the app is going to /// provide its own custom semantics label. final bool excludeFromSemantics; @@ -132,9 +132,10 @@ class Tooltip extends StatefulWidget { /// /// If null, the message's [TextStyle] will be determined based on /// [ThemeData]. If [ThemeData.brightness] is set to [Brightness.dark], - /// [ThemeData.textTheme.bodyText2] will be used with [Colors.white]. Otherwise, - /// if [ThemeData.brightness] is set to [Brightness.light], - /// [ThemeData.textTheme.bodyText2] will be used with [Colors.black]. + /// [TextTheme.bodyText2] of [ThemeData.textTheme] will be used with + /// [Colors.white]. Otherwise, if [ThemeData.brightness] is set to + /// [Brightness.light], [TextTheme.bodyText2] of [ThemeData.textTheme] will be + /// used with [Colors.black]. final TextStyle textStyle; /// The length of time that a pointer must hover over a tooltip's widget diff --git a/packages/flutter/lib/src/material/tooltip_theme.dart b/packages/flutter/lib/src/material/tooltip_theme.dart index c1831a421e5..4318efc9863 100644 --- a/packages/flutter/lib/src/material/tooltip_theme.dart +++ b/packages/flutter/lib/src/material/tooltip_theme.dart @@ -65,10 +65,10 @@ class TooltipThemeData with Diagnosticable { /// direction, the tooltip will be displayed in the opposite direction. final bool preferBelow; - /// Whether the tooltip's [message] should be excluded from the semantics + /// Whether the [Tooltip.message] should be excluded from the semantics /// tree. /// - /// By default, [Tooltip]s will add a [Semantics.label] that is set to + /// By default, [Tooltip]s will add a [Semantics] label that is set to /// [Tooltip.message]. Set this property to true if the app is going to /// provide its own custom semantics label. final bool excludeFromSemantics; diff --git a/packages/flutter/lib/src/material/typography.dart b/packages/flutter/lib/src/material/typography.dart index da492df8615..63a54da270a 100644 --- a/packages/flutter/lib/src/material/typography.dart +++ b/packages/flutter/lib/src/material/typography.dart @@ -111,7 +111,7 @@ class Typography with Diagnosticable { /// If [platform] is [TargetPlatform.iOS] or [TargetPlatform.macOS], the /// default values for [black] and [white] are [blackCupertino] and /// [whiteCupertino] respectively. Otherwise they are [blackMountainView] and - /// [whiteMoutainView]. If [platform] is null then both [black] and [white] + /// [whiteMountainView]. If [platform] is null then both [black] and [white] /// must be specified. /// /// The default values for [englishLike], [dense], and [tall] are @@ -139,7 +139,7 @@ class Typography with Diagnosticable { /// If [platform] is [TargetPlatform.iOS] or [TargetPlatform.macOS], the /// default values for [black] and [white] are [blackCupertino] and /// [whiteCupertino] respectively. Otherwise they are [blackMountainView] and - /// [whiteMoutainView]. If [platform] is null then both [black] and [white] + /// [whiteMountainView]. If [platform] is null then both [black] and [white] /// must be specified. /// /// The default values for [englishLike], [dense], and [tall] are