Unverified Commit 71078416 authored by Michael Goderbauer's avatar Michael Goderbauer Committed by GitHub

Fix more unresolved doc references in material (#62509)

parent 3099fb9e
......@@ -87,6 +87,11 @@ class AnimatedIcon extends StatelessWidget {
///
/// Announced in accessibility modes (e.g TalkBack/VoiceOver).
/// This label does not show in the UI.
///
/// See also:
///
/// * [SemanticsProperties.label], which is set to [semanticLabel] in the
/// underlying [Semantics] widget.
final String semanticLabel;
/// The text direction to use for rendering the icon.
......@@ -95,11 +100,6 @@ class AnimatedIcon extends StatelessWidget {
///
/// If the text direction is [TextDirection.rtl], the icon will be mirrored
/// horizontally (e.g back arrow will point right).
///
/// See also:
///
/// * [SemanticProperties.label], which is set to [semanticLabel] in the
/// underlying [Semantics] widget.
final TextDirection textDirection;
static final _UiPathFactory _pathFactory = () => ui.Path();
......
......@@ -331,14 +331,14 @@ class MaterialApp extends StatefulWidget {
/// If set to [ThemeMode.system], the choice of which theme to use will
/// be based on the user's system preferences. If the [MediaQuery.platformBrightnessOf]
/// is [Brightness.light], [theme] will be used. If it is [Brightness.dark],
/// [darkTheme] will be used (unless it is [null], in which case [theme]
/// [darkTheme] will be used (unless it is null, in which case [theme]
/// will be used.
///
/// If set to [ThemeMode.light] the [theme] will always be used,
/// regardless of the user's system preference.
///
/// If set to [ThemeMode.dark] the [darkTheme] will be used
/// regardless of the user's system preference. If [darkTheme] is [null]
/// regardless of the user's system preference. If [darkTheme] is null
/// then it will fallback to using [theme].
///
/// The default value is [ThemeMode.system].
......
......@@ -343,14 +343,14 @@ class AppBar extends StatefulWidget implements PreferredSizeWidget {
///
/// If this property is null, then [AppBarTheme.elevation] of
/// [ThemeData.appBarTheme] is used. If that is also null, the default value
/// is 4, the appropriate elevation for app bars.
/// is 4.
final double elevation;
/// The color to paint the shadow below the app bar.
///
/// If this property is null, then [AppBarTheme.shadowColor] of
/// [ThemeData.appBarTheme] is used. If that is also null, the default value
/// is fully opaque black, the appropriate color for shadows.
/// is fully opaque black.
final Color shadowColor;
/// The material's shape as well its shadow.
......@@ -1148,9 +1148,9 @@ class SliverAppBar extends StatefulWidget {
/// The z-coordinate at which to place this app bar when it is above other
/// content. This controls the size of the shadow below the app bar.
///
/// If this property is null, then [ThemeData.appBarTheme.elevation] is used,
/// if that is also null, the default value is 4, the appropriate elevation
/// for app bars.
/// If this property is null, then [AppBarTheme.elevation] of
/// [ThemeData.appBarTheme] is used, if that is also null, the default value
/// is 4.
///
/// If [forceElevated] is false, the elevation is ignored when the app bar has
/// no content underneath it. For example, if the app bar is [pinned] but no
......@@ -1161,9 +1161,9 @@ class SliverAppBar extends StatefulWidget {
/// The color to paint the shadow below the app bar. Typically this should be set
/// along with [elevation].
///
/// If this property is null, then [ThemeData.appBarTheme.shadowColor] is used,
/// if that is also null, the default value is fully opaque black, the appropriate
/// color for shadows.
/// If this property is null, then [AppBarTheme.shadowColor] of
/// [ThemeData.appBarTheme] is used, if that is also null, the default value
/// is fully opaque black.
final Color shadowColor;
/// Whether to show the shadow appropriate for the [elevation] even if the
......@@ -1180,37 +1180,42 @@ class SliverAppBar extends StatefulWidget {
/// The color to use for the app bar's material. Typically this should be set
/// along with [brightness], [iconTheme], [textTheme].
///
/// If this property is null, then [ThemeData.appBarTheme.color] is used,
/// if that is also null, then [ThemeData.primaryColor] is used.
/// If this property is null, then [AppBarTheme.color] of
/// [ThemeData.appBarTheme] is used. If that is also null, then
/// [ThemeData.primaryColor] is used.
final Color backgroundColor;
/// The brightness of the app bar's material. Typically this is set along
/// with [backgroundColor], [iconTheme], [textTheme].
///
/// If this property is null, then [ThemeData.appBarTheme.brightness] is used,
/// if that is also null, then [ThemeData.primaryColorBrightness] is used.
/// If this property is null, then [AppBarTheme.brightness] of
/// [ThemeData.appBarTheme] is used. If that is also null, then
/// [ThemeData.primaryColorBrightness] is used.
final Brightness brightness;
/// The color, opacity, and size to use for app bar icons. Typically this
/// is set along with [backgroundColor], [brightness], [textTheme].
///
/// If this property is null, then [ThemeData.appBarTheme.iconTheme] is used,
/// if that is also null, then [ThemeData.primaryIconTheme] is used.
/// If this property is null, then [AppBarTheme.iconTheme] of
/// [ThemeData.appBarTheme] is used, if that is also null, then
/// [ThemeData.primaryIconTheme] is used.
final IconThemeData iconTheme;
/// The color, opacity, and size to use for trailing app bar icons. This
/// should only be used when the trailing icons should be themed differently
/// than the leading icons.
///
/// If this property is null, then [ThemeData.appBarTheme.actionsIconTheme] is
/// used, if that is also null, then this falls back to [iconTheme].
/// If this property is null, then [AppBarTheme.actionsIconTheme] of
/// [ThemeData.appBarTheme] is used, if that is also null, then this falls
/// back to [iconTheme].
final IconThemeData actionsIconTheme;
/// The typographic styles to use for text in the app bar. Typically this is
/// set along with [brightness] [backgroundColor], [iconTheme].
///
/// If this property is null, then [ThemeData.appBarTheme.textTheme] is used,
/// if that is also null, then [ThemeData.primaryTextTheme] is used.
/// If this property is null, then [AppBarTheme.textTheme] of
/// [ThemeData.appBarTheme] is used, if that is also null, then
/// [ThemeData.primaryTextTheme] is used.
final TextTheme textTheme;
/// Whether this app bar is being displayed at the top of the screen.
......@@ -1239,9 +1244,9 @@ 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 [bottom.preferredSize.height] is added to the
/// is specified, then its [PreferredSizeWidget.height] is added to the
/// height. If [primary] is true, then the [MediaQuery] top padding,
/// [MediaQueryData.padding.top], is added as well.
/// [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
......
......@@ -59,7 +59,7 @@ class MaterialBanner extends StatelessWidget {
/// Style for the text in the [content] of the [MaterialBanner].
///
/// If `null`, [MaterialBannerThemeData.contentTextStyle] is used. If that is
/// also `null`, [ThemeData.textTheme.bodyText2] is used.
/// also `null`, [TextTheme.bodyText2] of [ThemeData.textTheme] is used.
final TextStyle contentTextStyle;
/// The set of actions that are displayed at the bottom or trailing side of
......@@ -79,7 +79,7 @@ class MaterialBanner extends StatelessWidget {
/// The color of the surface of this [MaterialBanner].
///
/// If `null`, [MaterialBannerThemeData.backgroundColor] is used. If that is
/// also `null`, [ThemeData.colorScheme.surface] is used.
/// also `null`, [ColorScheme.surface] of [ThemeData.colorScheme] is used.
final Color backgroundColor;
/// The amount of space by which to inset the [content].
......@@ -99,10 +99,10 @@ class MaterialBanner extends StatelessWidget {
/// An override to force the [actions] to be below the [content] regardless of
/// how many there are.
///
/// If this is `true`, the [actions] will be placed below the [content]. If
/// this is `false`, the [actions] will be placed on the trailing side of the
/// [content] if [actions.length] is `1` and below the [content] if greater
/// than `1`.
/// If this is true, the [actions] will be placed below the [content]. If
/// this is false, the [actions] will be placed on the trailing side of the
/// [content] if [actions]'s length is 1 and below the [content] if greater
/// than 1.
final bool forceActionsBelow;
@override
......
......@@ -154,7 +154,7 @@ class BottomSheet extends StatefulWidget {
/// a bottom sheet with rounded corners and an edge-to-edge [Image] at the
/// top.
///
/// If this property is null then [BottomSheetTheme.clipBehavior] of
/// If this property is null then [BottomSheetThemeData.clipBehavior] of
/// [ThemeData.bottomSheetTheme] is used. If that's null then the behavior
/// will be [Clip.none].
final Clip clipBehavior;
......
......@@ -125,7 +125,7 @@ class RawMaterialButton extends StatefulWidget {
/// Defines the default text style, with [Material.textStyle], for the
/// button's [child].
///
/// If [textStyle.color] is a [MaterialStateProperty<Color>], [MaterialStateProperty.resolve]
/// If [TextStyle.color] is a [MaterialStateProperty<Color>], [MaterialStateProperty.resolve]
/// is used for the following [MaterialState]s:
///
/// * [MaterialState.pressed].
......
......@@ -86,11 +86,12 @@ class ButtonBar extends StatelessWidget {
/// If that is null, it will default to [MainAxisSize.max].
final MainAxisSize mainAxisSize;
/// Overrides the surrounding [ButtonBarThemeData.textTheme] to define a button's
/// base colors, size, internal padding and shape.
/// Overrides the surrounding [ButtonBarThemeData.buttonTextTheme] to define a
/// button's base colors, size, internal padding and shape.
///
/// If null then it will use the surrounding [ButtonBarThemeData.buttonTextTheme].
/// If that is null, it will default to [ButtonTextTheme.primary].
/// If null then it will use the surrounding
/// [ButtonBarThemeData.buttonTextTheme]. If that is null, it will default to
/// [ButtonTextTheme.primary].
final ButtonTextTheme buttonTextTheme;
/// Overrides the surrounding [ButtonThemeData.minWidth] to define a button's
......
......@@ -608,7 +608,7 @@ class ButtonThemeData with Diagnosticable {
/// * [ButtonTextTheme.accent]: [ColorScheme.secondary] of [colorScheme].
/// * [ButtonTextTheme.primary]: If [getFillColor] is dark then [Colors.white],
/// otherwise if [button] is a [FlatButton] or an [OutlineButton] then
/// [colorScheme.primary], otherwise [Colors.black].
/// [ColorScheme.primary] of [colorScheme], otherwise [Colors.black].
Color getTextColor(MaterialButton button) {
if (!button.enabled)
return getDisabledTextColor(button);
......
......@@ -765,7 +765,7 @@ class SimpleDialog extends StatelessWidget {
/// Style for the text in the [title] of this [SimpleDialog].
///
/// If null, [DialogTheme.titleTextStyle] is used. If that's null, defaults to
/// [ThemeData.textTheme.headline6].
/// [TextTheme.headline6] of [ThemeData.textTheme].
final TextStyle titleTextStyle;
/// The (optional) content of the dialog is displayed in a
......@@ -804,7 +804,7 @@ class SimpleDialog extends StatelessWidget {
///
/// See also:
///
/// * [SemanticsConfiguration.isRouteName], for a description of how this
/// * [SemanticsConfiguration.namesRoute], for a description of how this
/// value is used.
final String semanticLabel;
......
......@@ -99,13 +99,13 @@ class ElevatedButton extends ButtonStyleButton {
/// [ButtonStyle] given simple values.
///
/// The [onPrimary], 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
/// [MaterialStateProperty] [ButtonStyle.foregroundColor] value in the same
/// way that [defaultStyleOf] uses the [ColorScheme] colors with the same
/// names. Specify a value for [onPrimary] 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 primary for
/// the button's background fill color and [onSurface]
/// to specify the button's disabled text, icon, and fill color.
/// button's text and icons as well as the overlay colors used to indicate the
/// hover, focus, and pressed states. Use [primary] for the button's background
/// fill color and [onSurface] to specify the button's disabled text, icon,
/// and fill color.
///
/// The button's elevations are defined relative to the [elevation]
/// parameter. The disabled elevation is the same as the parameter
......@@ -206,8 +206,8 @@ class ElevatedButton 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`
......
......@@ -103,7 +103,7 @@ class ElevatedButtonTheme extends InheritedTheme {
/// The closest instance of this class that encloses the given context.
///
/// If there is no enclosing [ElevatedButtonsTheme] widget, then
/// If there is no enclosing [ElevatedButtonTheme] widget, then
/// [ThemeData.elevatedButtonTheme] is used.
///
/// Typical usage is as follows:
......
......@@ -237,10 +237,11 @@ class FloatingActionButton extends StatelessWidget {
/// The default foreground color for icons and text within the button.
///
/// If this property is null, then the [Theme]'s
/// [ThemeData.floatingActionButtonTheme.foregroundColor] is used. If that
/// property is also null, then the [Theme]'s
/// [ThemeData.colorScheme.onSecondary] color is used.
/// If this property is null, then the
/// [FloatingActionButtonThemeData.foregroundColor] of
/// [ThemeData.floatingActionButtonTheme] is used. If that property is also
/// null, then the [ColorScheme.onSecondary] color of [ThemeData.colorScheme]
/// is used.
///
/// Although the color of theme's `accentIconTheme` currently provides a
/// default that supercedes the `onSecondary` color, this dependency
......@@ -250,10 +251,10 @@ class FloatingActionButton extends StatelessWidget {
/// The button's background color.
///
/// If this property is null, then the [Theme]'s
/// [ThemeData.floatingActionButtonTheme.backgroundColor] is used. If that
/// property is also null, then the [Theme]'s
/// [ThemeData.colorScheme.secondary] color is used.
/// 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.
final Color backgroundColor;
/// The color to use for filling the button when the button has input focus.
......
......@@ -160,7 +160,7 @@ abstract class FloatingActionButtonLocation {
/// Centered [FloatingActionButton], floating at the bottom of the screen.
///
/// To position a mini floating action button, use [miniCenterFloat] and
/// set [FloatingActionButtonLocation.mini] to true.
/// set [FloatingActionButton.mini] to true.
static const FloatingActionButtonLocation centerFloat = _CenterFloatFabLocation();
/// Centered [FloatingActionButton], floating at the bottom of the screen,
......
......@@ -54,12 +54,11 @@ class FlutterLogo extends StatelessWidget {
/// itself is drawn.
final FlutterLogoStyle style;
/// The length of time for the animation if the [style], [colors], or
/// [textColor] properties are changed.
/// The length of time for the animation if the [style] or [textColor]
/// properties are changed.
final Duration duration;
/// The curve for the logo animation if the [style], [colors], or [textColor]
/// change.
/// The curve for the logo animation if the [style] or [textColor] change.
final Curve curve;
@override
......
......@@ -186,8 +186,8 @@ class IconButton extends StatelessWidget {
///
/// See also:
///
/// * [ThemeData.visualDensity], which specifies the [density] for all widgets
/// within a [Theme].
/// * [ThemeData.visualDensity], which specifies the [visualDensity] for all
/// widgets within a [Theme].
final VisualDensity visualDensity;
/// The padding around the button's icon. The entire padded icon will react
......
......@@ -377,9 +377,6 @@ class InkResponse extends StatelessWidget {
/// * [MaterialState.focused].
/// * [MaterialState.disabled].
///
/// When [value] is null and [tristate] is true, [MaterialState.selected] is
/// included as a state.
///
/// If this property is null, [MaterialStateMouseCursor.clickable] will be used.
final MouseCursor mouseCursor;
......
......@@ -43,7 +43,7 @@ abstract class InputBorder extends ShapeBorder {
/// No input border.
///
/// Use this value with [InputDecoration.border] to specify that no border
/// should be drawn. The [InputDecoration.shrinkWrap] constructor sets
/// should be drawn. The [InputDecoration.collapsed] constructor sets
/// its border to this value.
static const InputBorder none = _NoInputBorder();
......
......@@ -2631,7 +2631,7 @@ class InputDecoration {
///
/// The decoration's container is the area which is filled if [filled] is
/// true and bordered per the [border]. It's the area adjacent to
/// [decoration.icon] and above the widgets that contain [helperText],
/// [icon] and above the widgets that contain [helperText],
/// [errorText], and [counterText].
///
/// See [Icon], [ImageIcon].
......@@ -2656,8 +2656,8 @@ class InputDecoration {
/// input field and the current [Theme].
final TextStyle labelStyle;
/// Text that provides context about the input [child]'s value, such as how
/// the value will be used.
/// 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
......@@ -2682,16 +2682,17 @@ class InputDecoration {
/// Text that suggests what sort of input the field accepts.
///
/// Displayed on top of the input [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.
/// 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.
final String hintText;
/// The style to use for the [hintText].
///
/// Also used for the [labelText] when the [labelText] is displayed on
/// top of the input field (i.e., at the same location on the screen where
/// text may be entered in the input [child]).
/// text may be entered in the [InputDecorator.child]).
///
/// If null, defaults to a value derived from the base [TextStyle] for the
/// input field and the current [Theme].
......@@ -2706,7 +2707,7 @@ class InputDecoration {
/// used to handle the overflow when it is limited to single line.
final int hintMaxLines;
/// Text that appears below the input [child] and the border.
/// Text that appears below the [InputDecorator.child] and the border.
///
/// If non-null, the border's color animates to red and the [helperText] is
/// not shown.
......@@ -2767,7 +2768,7 @@ class InputDecoration {
/// {@endtemplate}
final FloatingLabelBehavior floatingLabelBehavior;
/// Whether the input [child] is part of a dense form (i.e., uses less vertical
/// Whether the [InputDecorator.child] is part of a dense form (i.e., uses less vertical
/// space).
///
/// Defaults to false.
......@@ -2775,10 +2776,9 @@ class InputDecoration {
/// The padding for the input decoration's container.
///
/// The decoration's container is the area which is filled if [filled] is
/// true and bordered per the [border]. It's the area adjacent to
/// [decoration.icon] and above the widgets that contain [helperText],
/// [errorText], and [counterText].
/// The decoration's container is the area which is filled if [filled] is true
/// and bordered per the [border]. It's the area adjacent to [icon] and above
/// the widgets that contain [helperText], [errorText], and [counterText].
///
/// By default the `contentPadding` reflects [isDense] and the type of the
/// [border].
......@@ -2827,7 +2827,7 @@ class InputDecoration {
///
/// The decoration's container is the area which is filled if [filled] is
/// true and bordered per the [border]. It's the area adjacent to
/// [decoration.icon] and above the widgets that contain [helperText],
/// [icon] and above the widgets that contain [helperText],
/// [errorText], and [counterText].
///
/// See also:
......@@ -2953,7 +2953,7 @@ class InputDecoration {
///
/// The decoration's container is the area which is filled if [filled] is
/// true and bordered per the [border]. It's the area adjacent to
/// [decoration.icon] and above the widgets that contain [helperText],
/// [icon] and above the widgets that contain [helperText],
/// [errorText], and [counterText].
///
/// See also:
......@@ -3090,7 +3090,7 @@ class InputDecoration {
///
/// The decoration's container is the area which is filled if [filled] is
/// true and bordered per the [border]. It's the area adjacent to
/// [decoration.icon] and above the widgets that contain [helperText],
/// [icon] and above the widgets that contain [helperText],
/// [errorText], and [counterText].
///
/// This property is false by default.
......@@ -3104,10 +3104,9 @@ class InputDecoration {
///
/// By default the fillColor is based on the current [Theme].
///
/// The decoration's container is the area which is filled if [filled] is
/// true and bordered per the [border]. It's the area adjacent to
/// [decoration.icon] and above the widgets that contain [helperText],
/// [errorText], and [counterText].
/// The decoration's container is the area which is filled if [filled] is true
/// and bordered per the [border]. It's the area adjacent to [icon] and above
/// the widgets that contain [helperText], [errorText], and [counterText].
///
/// This color is blended with [focusColor] if the decoration is focused.
final Color fillColor;
......@@ -3122,7 +3121,7 @@ class InputDecoration {
///
/// The decoration's container is the area which is filled if [filled] is
/// true and bordered per the [border]. It's the area adjacent to
/// [decoration.icon] and above the widgets that contain [helperText],
/// [icon] and above the widgets that contain [helperText],
/// [errorText], and [counterText].
final Color focusColor;
......@@ -3140,7 +3139,7 @@ class InputDecoration {
///
/// The decoration's container is the area which is filled if [filled] is
/// true and bordered per the [border]. It's the area adjacent to
/// [decoration.icon] and above the widgets that contain [helperText],
/// [icon] and above the widgets that contain [helperText],
/// [errorText], and [counterText].
final Color hoverColor;
......@@ -3655,8 +3654,8 @@ class InputDecorationTheme with Diagnosticable {
/// The style to use for [InputDecoration.labelText] when the label is
/// above (i.e., vertically adjacent to) the input field.
///
/// When the [labelText] is on top of the input field, the text uses the
/// [hintStyle] instead.
/// When the [InputDecoration.labelText] is on top of the input field, the
/// text uses the [hintStyle] instead.
///
/// If null, defaults to a value derived from the base [TextStyle] for the
/// input field and the current [Theme].
......@@ -3665,24 +3664,25 @@ class InputDecorationTheme with Diagnosticable {
/// The style to use for [InputDecoration.helperText].
final TextStyle helperStyle;
/// The maximum number of lines the [helperText] can occupy.
/// The maximum number of lines the [InputDecorator.helperText] can occupy.
///
/// Defaults to null, which means that the [helperText] will be limited
/// to a single line with [TextOverflow.ellipsis].
/// Defaults to null, which means that the [InputDecorator.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 [errorText].
/// * [errorMaxLines], the equivalent but for the [InputDecorator.errorText].
final int helperMaxLines;
/// The style to use for the [InputDecoration.hintText].
///
/// Also used for the [labelText] when the [labelText] is displayed on
/// top of the input field (i.e., at the same location on the screen where
/// text may be entered in the input field).
/// Also used for the [InputDecoration.labelText] when the
/// [InputDecoration.labelText] is displayed on top of the input field (i.e.,
/// at the same location on the screen where text may be entered in the input
/// field).
///
/// If null, defaults to a value derived from the base [TextStyle] for the
/// input field and the current [Theme].
......@@ -3694,7 +3694,7 @@ class InputDecorationTheme with Diagnosticable {
/// input field and the current [Theme].
final TextStyle errorStyle;
/// The maximum number of lines the [errorText] can occupy.
/// 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].
......@@ -3704,7 +3704,7 @@ class InputDecorationTheme with Diagnosticable {
///
/// See also:
///
/// * [helperMaxLines], the equivalent but for the [helperText].
/// * [helperMaxLines], the equivalent but for the [InputDecoration.helperText].
final int errorMaxLines;
/// Whether the placeholder text floats to become a label on focus.
......
......@@ -115,8 +115,8 @@ class ListTileTheme extends InheritedTheme {
/// The tile's internal padding.
///
/// Insets a [ListTile]'s contents: its [leading], [title], [subtitle],
/// and [trailing] widgets.
/// Insets a [ListTile]'s contents: its [ListTile.leading], [ListTile.title],
/// [ListTile.subtitle], and [ListTile.trailing] widgets.
final EdgeInsetsGeometry contentPadding;
/// If specified, defines the background color for `ListTile` when
......@@ -734,7 +734,7 @@ class ListTile extends StatelessWidget {
///
/// To show right-aligned metadata (assuming left-to-right reading order;
/// left-aligned for right-to-left reading order), consider using a [Row] with
/// [MainAxisAlign.baseline] alignment whose first item is [Expanded] and
/// [CrossAxisAlignment.baseline] alignment whose first item is [Expanded] and
/// whose second child is the metadata text, instead of using the [trailing]
/// property.
final Widget trailing;
......@@ -764,17 +764,17 @@ class ListTile extends StatelessWidget {
///
/// See also:
///
/// * [ThemeData.visualDensity], which specifies the [density] for all widgets
/// within a [Theme].
/// * [ThemeData.visualDensity], which specifies the [visualDensity] for all
/// widgets within a [Theme].
final VisualDensity visualDensity;
/// The shape of the tile's [InkWell].
///
/// Defines the tile's [InkWell.customBorder].
///
/// If this property is null then [ThemeData.cardTheme.shape] is used.
/// If that's null then the shape will be a [RoundedRectangleBorder] with a
/// circular corner radius of 4.0.
/// If this property is null then [CardTheme.shape] of [ThemeData.cardTheme]
/// is used. If that's null then the shape will be a [RoundedRectangleBorder]
/// with a circular corner radius of 4.0.
final ShapeBorder shape;
/// The tile's internal padding.
......
......@@ -129,8 +129,9 @@ class MaterialButton extends StatelessWidget {
/// The color to use for this button's text.
///
/// The button's [Material.textStyle] will be the current theme's button
/// text style, [ThemeData.textTheme.button], configured with this color.
/// The button's [Material.textStyle] will be the current theme's button text
/// style, [TextTheme.button] of [ThemeData.textTheme], configured with this
/// color.
///
/// The default text color depends on the button theme's text theme,
/// [ButtonThemeData.textTheme].
......@@ -146,8 +147,9 @@ class MaterialButton extends StatelessWidget {
/// The color to use for this button's text when the button is disabled.
///
/// The button's [Material.textStyle] will be the current theme's button
/// text style, [ThemeData.textTheme.button], configured with this color.
/// The button's [Material.textStyle] will be the current theme's button text
/// style, [TextTheme.button] of [ThemeData.textTheme], configured with this
/// color.
///
/// The default value is the theme's disabled color,
/// [ThemeData.disabledColor].
......@@ -324,8 +326,8 @@ class MaterialButton extends StatelessWidget {
///
/// See also:
///
/// * [ThemeData.visualDensity], which specifies the [density] for all widgets
/// within a [Theme].
/// * [ThemeData.visualDensity], which specifies the [visualDensity] for all
/// widgets within a [Theme].
final VisualDensity visualDensity;
/// The shape of the button's [Material].
......
......@@ -159,7 +159,7 @@ class NavigationRail extends StatefulWidget {
///
/// The default value is [NavigationRailThemeData.backgroundColor]. If
/// [NavigationRailThemeData.backgroundColor] is null, then the default value
/// is based on [ThemeData.colorScheme.surface].
/// is based on [ColorScheme.surface] of [ThemeData.colorScheme].
final Color backgroundColor;
/// Indicates that the [NavigationRail] should be in the extended state.
......@@ -262,9 +262,8 @@ 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
/// [ThemeData.textTheme.bodyText]. The default color is based on the
/// [Theme]'s [ColorScheme.onSurface].
/// The default value is based on the [Theme]'s [TextTheme.bodyText]. The
/// default color is based on the [Theme]'s [ColorScheme.onSurface].
///
/// Properties from this text style, or
/// [NavigationRailThemeData.unselectedLabelTextStyle] if this is null, are
......@@ -276,9 +275,9 @@ class NavigationRail extends StatefulWidget {
/// When a [NavigationRailDestination] is not selected,
/// [unselectedLabelTextStyle] will be used.
///
/// The default value is based on the [Theme]'s
/// [ThemeData.textTheme.bodyText]. The default color is based on the
/// [Theme]'s [ColorScheme.primary].
/// The default value is based on the [TextTheme.bodyText] of
/// [ThemeData.textTheme]. The default color is based on the [Theme]'s
/// [ColorScheme.primary].
///
/// Properties from this text style,
/// or [NavigationRailThemeData.selectedLabelTextStyle] if this is null, are
......
......@@ -171,7 +171,7 @@ class OutlineButton extends MaterialButton {
/// By default the border's color does not change when the button
/// is pressed.
///
/// This field is ignored if [borderSide.color] is a [MaterialStateProperty<Color>].
/// This field is ignored if [BorderSide.color] is a [MaterialStateProperty<Color>].
final Color highlightedBorderColor;
/// The outline border's color when the button is not [enabled].
......@@ -179,7 +179,7 @@ class OutlineButton extends MaterialButton {
/// By default the outline border's color does not change when the
/// button is disabled.
///
/// This field is ignored if [borderSide.color] is a [MaterialStateProperty<Color>].
/// This field is ignored if [BorderSide.color] is a [MaterialStateProperty<Color>].
final Color disabledBorderColor;
/// Defines the color of the border when the button is enabled but not
......@@ -191,7 +191,7 @@ class OutlineButton extends MaterialButton {
/// If null the default border's style is [BorderStyle.solid], its
/// [BorderSide.width] is 1.0, and its color is a light shade of grey.
///
/// If [borderSide.color] is a [MaterialStateProperty<Color>], [MaterialStateProperty.resolve]
/// If [BorderSide.color] is a [MaterialStateProperty<Color>], [MaterialStateProperty.resolve]
/// is used in all states and both [highlightedBorderColor] and [disabledBorderColor]
/// are ignored.
final BorderSide borderSide;
......
......@@ -96,12 +96,12 @@ class OutlinedButton 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.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.
///
/// Similarly, the [enabledMouseCursor] and [disabledMouseCursor]
/// parameters are used to construct [ButtonStyle].mouseCursor.
......@@ -191,8 +191,8 @@ class OutlinedButton extends ButtonStyleButton {
/// value for all states, otherwise the values are as specified for
/// each state and "others" means all other states.
///
/// 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.foreground] color is used instead.
///
/// * `textStyle` - Theme.textTheme.button
/// * `backgroundColor` - transparent
......
......@@ -103,7 +103,7 @@ class OutlinedButtonTheme extends InheritedTheme {
/// The closest instance of this class that encloses the given context.
///
/// If there is no enclosing [OutlinedButtonsTheme] widget, then
/// If there is no enclosing [OutlinedButtonTheme] widget, then
/// [ThemeData.outlinedButtonTheme] is used.
///
/// Typical usage is as follows:
......
......@@ -35,8 +35,8 @@ import 'theme.dart';
class MaterialPageRoute<T> extends PageRoute<T> with MaterialRouteTransitionMixin<T> {
/// Construct a MaterialPageRoute whose contents are defined by [builder].
///
/// The values of [builder], [maintainState], and [fullScreenDialog] must not
/// be null.
/// The values of [builder], [maintainState], and [PageRoute.fullScreenDialog]
/// must not be null.
MaterialPageRoute({
@required this.builder,
RouteSettings settings,
......
......@@ -243,7 +243,8 @@ class PopupMenuItem<T> extends PopupMenuEntry<T> {
/// The text style of the popup menu item.
///
/// If this property is null, then [PopupMenuThemeData.textStyle] is used.
/// If [PopupMenuThemeData.textStyle] is also null, then [ThemeData.textTheme.subtitle1] is used.
/// If [PopupMenuThemeData.textStyle] is also null, then [TextTheme.subtitle1]
/// of [ThemeData.textTheme] is used.
final TextStyle textStyle;
/// The cursor for a mouse pointer when it enters or is hovering over the
......@@ -1062,7 +1063,7 @@ class PopupMenuButton<T> extends StatefulWidget {
final Color color;
/// If true (the default) then the menu will be wrapped with copies
/// of the [InheritedThemes], like [Theme] and [PopupMenuTheme], which
/// of the [InheritedTheme]s, like [Theme] and [PopupMenuTheme], which
/// are defined above the [BuildContext] where the menu is shown.
final bool captureInheritedThemes;
......
......@@ -71,7 +71,7 @@ abstract class ProgressIndicator extends StatefulWidget {
final Animation<Color> valueColor;
/// {@template flutter.material.progressIndicator.semanticsLabel}
/// The [Semantics.label] for this progress indicator.
/// The [SemanticsProperties.label] for this progress indicator.
///
/// This value indicates the purpose of the progress bar, and will be
/// read out by screen readers to indicate the purpose of this progress
......@@ -80,7 +80,7 @@ abstract class ProgressIndicator extends StatefulWidget {
final String semanticsLabel;
/// {@template flutter.material.progressIndicator.semanticsValue}
/// The [Semantics.value] for this progress indicator.
/// The [SemanticsProperties.value] for this progress indicator.
///
/// This will be used in conjunction with the [semanticsLabel] by
/// screen reading software to identify the widget, and is primarily
......
......@@ -258,8 +258,8 @@ class Radio<T> extends StatefulWidget {
///
/// See also:
///
/// * [ThemeData.visualDensity], which specifies the [density] for all widgets
/// within a [Theme].
/// * [ThemeData.visualDensity], which specifies the [visualDensity] for all
/// widgets within a [Theme].
final VisualDensity visualDensity;
/// The color for the radio's [Material] when it has the input focus.
......
......@@ -313,9 +313,9 @@ class RangeSlider extends StatefulWidget {
/// There are two labels: one for the start thumb and one for the end thumb.
///
/// Each label is rendered using the active [ThemeData]'s
/// [ThemeData.textTheme.bodyText1] text style, with the
/// theme data's [ThemeData.colorScheme.onPrimaryColor]. The label's text
/// style can be overridden with [SliderThemeData.valueIndicatorTextStyle].
/// [TextTheme.bodyText1] text style, with the theme data's
/// [ColorScheme.onPrimaryColor]. The label's text style can be overridden
/// with [SliderThemeData.valueIndicatorTextStyle].
///
/// If null, then the value indicator will not be displayed.
///
......
......@@ -107,8 +107,8 @@ class ScaffoldPrelayoutGeometry {
///
/// The [Scaffold.body] is laid out with respect to [minInsets] already. This
/// means that a [FloatingActionButtonLocation] does not need to factor in
/// [minInsets.bottom] when aligning a [FloatingActionButton] to
/// [contentBottom].
/// [EdgeInsets.bottom] of [minInsets] when aligning a [FloatingActionButton]
/// to [contentBottom].
final double contentBottom;
/// The vertical distance from the [Scaffold]'s origin to the top of
......@@ -120,7 +120,8 @@ class ScaffoldPrelayoutGeometry {
///
/// The [Scaffold.body] is laid out with respect to [minInsets] already. This
/// means that a [FloatingActionButtonLocation] does not need to factor in
/// [minInsets.top] when aligning a [FloatingActionButton] to [contentTop].
/// [EdgeInsets.top] of [minInsets] when aligning a [FloatingActionButton] to
/// [contentTop].
final double contentTop;
/// The minimum padding to inset the [FloatingActionButton] by for it
......@@ -131,16 +132,16 @@ class ScaffoldPrelayoutGeometry {
/// and is useful for insetting the [FloatingActionButton] to avoid features like
/// the system status bar or the keyboard.
///
/// If [Scaffold.resizeToAvoidBottomInset] is set to false, [minInsets.bottom]
/// will be 0.0.
/// If [Scaffold.resizeToAvoidBottomInset] is set to false,
/// [EdgeInsets.bottom] of [minInsets] will be 0.0.
final EdgeInsets minInsets;
/// The minimum padding to inset interactive elements to be within a safe,
/// un-obscured space.
///
/// This value reflects the [MediaQuery.viewPadding] of the [Scaffold]'s
/// This value reflects the [MediaQueryData.viewPadding] of the [Scaffold]'s
/// [BuildContext] when [Scaffold.resizeToAvoidBottomInset] is false or and
/// the [MediaQuery.viewInsets] > 0.0. This helps distinguish between
/// the [MediaQueryData.viewInsets] > 0.0. This helps distinguish between
/// different types of obstructions on the screen, such as software keyboards
/// and physical device notches.
final EdgeInsets minViewPadding;
......@@ -156,8 +157,8 @@ class ScaffoldPrelayoutGeometry {
/// up should use [minInsets] to make sure that the [FloatingActionButton] is
/// inset by enough to remain visible.
///
/// See [minInsets] and [MediaQuery.padding] for more information on the appropriate
/// insets to apply.
/// See [minInsets] and [MediaQueryData.padding] for more information on the
/// appropriate insets to apply.
final Size scaffoldSize;
/// The [Size] of the [Scaffold]'s [SnackBar].
......
......@@ -264,12 +264,14 @@ abstract class SearchDelegate<T> {
/// The hint text that is shown in the search field when it is empty.
///
/// If this value is set to null, the value of MaterialLocalizations.of(context).searchFieldLabel will be used instead.
/// If this value is set to null, the value of
/// `MaterialLocalizations.of(context).searchFieldLabel` will be used instead.
final String searchFieldLabel;
/// The style of the [searchFieldLabel].
///
/// If this value is set to null, the value of the ambient [Theme]'s [ThemeData.inputDecorationTheme.hintStyle] will be used instead.
/// If this value is set to null, the value of the ambient [Theme]'s
/// [InputDecorationTheme.hintStyle] will be used instead.
final TextStyle searchFieldStyle;
/// The type of action button to use for the keyboard.
......
......@@ -339,10 +339,10 @@ class Slider extends StatefulWidget {
/// It is used to display the value of a discrete slider, and it is displayed
/// as part of the value indicator shape.
///
/// The label is rendered using the active [ThemeData]'s
/// [ThemeData.textTheme.bodyText1] text style, with the
/// theme data's [ThemeData.colorScheme.onPrimaryColor]. The label's text style
/// can be overridden with [SliderThemeData.valueIndicatorTextStyle].
/// The label is rendered using the active [ThemeData]'s [TextTheme.bodyText1]
/// text style, with the theme data's [ColorScheme.onPrimary] color. The
/// label's text style can be overridden with
/// [SliderThemeData.valueIndicatorTextStyle].
///
/// If null, then the value indicator will not be displayed.
///
......@@ -359,7 +359,8 @@ class Slider extends StatefulWidget {
/// The "active" side of the slider is the side between the thumb and the
/// minimum value.
///
/// Defaults to [SliderTheme.activeTrackColor] of the current [SliderTheme].
/// Defaults to [SliderThemeData.activeTrackColor] of the current
/// [SliderTheme].
///
/// Using a [SliderTheme] gives much more fine-grained control over the
/// appearance of various components of the slider.
......@@ -370,7 +371,7 @@ class Slider extends StatefulWidget {
/// The "inactive" side of the slider is the side between the thumb and the
/// maximum value.
///
/// Defaults to the [SliderTheme.inactiveTrackColor] of the current
/// Defaults to the [SliderThemeData.inactiveTrackColor] of the current
/// [SliderTheme].
///
/// Using a [SliderTheme] gives much more fine-grained control over the
......
......@@ -39,9 +39,8 @@ enum FlutterLogoStyle {
class FlutterLogoDecoration extends Decoration {
/// Creates a decoration that knows how to paint Flutter's logo.
///
/// The [lightColor], [mediumColor], and [darkColor] are used to fill the
/// logo. The [style] controls whether and where to draw the "Flutter" label.
/// If one is shown, the [textColor] controls the color of the label.
/// The [style] controls whether and where to draw the "Flutter" label. If one
/// is shown, the [textColor] controls the color of the label.
///
/// The [textColor], [style], and [margin] arguments must not be null.
const FlutterLogoDecoration({
......
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