Skip to content

Commit 685590f

Browse files
authored
Fix even more unresolved doc references in material (flutter#62520)
* Fix even more unresolved doc references in material * ++ * ++
1 parent db2ecf4 commit 685590f

23 files changed

+136
-124
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1243,14 +1243,14 @@ class SliverAppBar extends StatefulWidget {
12431243

12441244
/// Defines the height of the app bar when it is collapsed.
12451245
///
1246-
/// By default, the collapsed height is [toolbarHeight]. If [bottom] widget
1247-
/// is specified, then its [PreferredSizeWidget.height] is added to the
1248-
/// height. If [primary] is true, then the [MediaQuery] top padding,
1249-
/// [EdgeInsets.top] of [MediaQueryData.padding], is added as well.
1246+
/// By default, the collapsed height is [toolbarHeight]. If [bottom] widget is
1247+
/// specified, then its height from [PreferredSizeWidget.preferredSize] is
1248+
/// added to the height. If [primary] is true, then the [MediaQuery] top
1249+
/// padding, [EdgeInsets.top] of [MediaQueryData.padding], is added as well.
12501250
///
12511251
/// If [pinned] and [floating] are true, with [bottom] set, the default
1252-
/// collapsed height is only [bottom.preferredSize.height] with the
1253-
/// [MediaQuery] top padding.
1252+
/// collapsed height is only the height of [PreferredSizeWidget.preferredSize]
1253+
/// with the [MediaQuery] top padding.
12541254
final double collapsedHeight;
12551255

12561256
/// The size of the app bar when it is fully expanded.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ class FloatingActionButton extends StatelessWidget {
254254
/// If this property is null, then the
255255
/// [FloatingActionButtonThemeData.backgroundColor] of
256256
/// [ThemeData.floatingActionButtonTheme] is used. If that property is also
257-
/// null, then the [Theme]'s [ThemeData.colorScheme.secondary] color is used.
257+
/// null, then the [Theme]'s [ColorScheme.secondary] color is used.
258258
final Color backgroundColor;
259259

260260
/// The color to use for filling the button when the button has input focus.

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

Lines changed: 26 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2500,11 +2500,10 @@ class InputDecoration {
25002500
/// Creates a bundle of the border, labels, icons, and styles used to
25012501
/// decorate a Material Design text field.
25022502
///
2503-
/// Unless specified by [ThemeData.inputDecorationTheme],
2504-
/// [InputDecorator] defaults [isDense] to false, and [filled] to false,
2505-
/// and [maxLines] to 1. The default border is an instance
2506-
/// of [UnderlineInputBorder]. If [border] is [InputBorder.none] then
2507-
/// no border is drawn.
2503+
/// Unless specified by [ThemeData.inputDecorationTheme], [InputDecorator]
2504+
/// defaults [isDense] to false and [filled] to false. The default border is
2505+
/// an instance of [UnderlineInputBorder]. If [border] is [InputBorder.none]
2506+
/// then no border is drawn.
25082507
///
25092508
/// The [enabled] argument must not be null.
25102509
///
@@ -2659,9 +2658,9 @@ class InputDecoration {
26592658
/// Text that provides context about the [InputDecorator.child]'s value, such
26602659
/// as how the value will be used.
26612660
///
2662-
/// If non-null, the text is displayed below the input [child], in the same
2663-
/// location as [errorText]. If a non-null [errorText] value is specified then
2664-
/// the helper text is not shown.
2661+
/// If non-null, the text is displayed below the [InputDecorator.child], in
2662+
/// the same location as [errorText]. If a non-null [errorText] value is
2663+
/// specified then the helper text is not shown.
26652664
final String helperText;
26662665

26672666
/// The style to use for the [helperText].
@@ -2683,9 +2682,9 @@ class InputDecoration {
26832682
/// Text that suggests what sort of input the field accepts.
26842683
///
26852684
/// Displayed on top of the [InputDecorator.child] (i.e., at the same location
2686-
/// on the screen where text may be entered in the input [child]) when the
2687-
/// input [isEmpty] and either (a) [labelText] is null or (b) the input has
2688-
/// the focus.
2685+
/// on the screen where text may be entered in the [InputDecorator.child])
2686+
/// when the input [isEmpty] and either (a) [labelText] is null or (b) the
2687+
/// input has the focus.
26892688
final String hintText;
26902689

26912690
/// The style to use for the [hintText].
@@ -3081,8 +3080,8 @@ class InputDecoration {
30813080

30823081
/// If true the decoration's container is filled with [fillColor].
30833082
///
3084-
/// When [isFocused] is true, the [focusColor] is also blended into the final
3085-
/// fill color. When [isHovering] is true, the [hoverColor] is also blended
3083+
/// When [InputDecorator.isFocused] is true, the [focusColor] is also blended into the final
3084+
/// fill color. When [InputDecorator.isHovering] is true, the [hoverColor] is also blended
30863085
/// into the final fill color.
30873086
///
30883087
/// Typically this field set to true if [border] is an
@@ -3098,9 +3097,9 @@ class InputDecoration {
30983097

30993098
/// The base fill color of the decoration's container color.
31003099
///
3101-
/// When [isFocused] is true, the [focusColor] is also blended into the final
3102-
/// fill color. When [isHovering] is true, the [hoverColor] is also blended
3103-
/// into the final fill color.
3100+
/// When [InputDecorator.isFocused] is true, the [focusColor] is also blended
3101+
/// into the final fill color. When [InputDecorator.isHovering] is true, the
3102+
/// [hoverColor] is also blended into the final fill color.
31043103
///
31053104
/// By default the fillColor is based on the current [Theme].
31063105
///
@@ -3114,7 +3113,7 @@ class InputDecoration {
31143113
/// The color to blend with [fillColor] and fill the decoration's container
31153114
/// with, if [filled] is true and the container has input focus.
31163115
///
3117-
/// When [isHovering] is true, the [hoverColor] is also blended into the final
3116+
/// When [InputDecorator.isHovering] is true, the [hoverColor] is also blended into the final
31183117
/// fill color.
31193118
///
31203119
/// By default the [focusColor] is based on the current [Theme].
@@ -3129,11 +3128,11 @@ class InputDecoration {
31293128
/// is being hovered over by a mouse.
31303129
///
31313130
/// If [filled] is true, the color is blended with [fillColor] and fills the
3132-
/// decoration's container. When [isFocused] is true, the [focusColor] is also
3133-
/// blended into the final fill color.
3131+
/// decoration's container. When [InputDecorator.isFocused] is true, the
3132+
/// [focusColor] is also blended into the final fill color.
31343133
///
3135-
/// If [filled] is false, and [isFocused] is false, the color is blended over
3136-
/// the [enabledBorder]'s color.
3134+
/// If [filled] is false, and [InputDecorator.isFocused] is false, the color
3135+
/// is blended over the [enabledBorder]'s color.
31373136
///
31383137
/// By default the [hoverColor] is based on the current [Theme].
31393138
///
@@ -3664,17 +3663,17 @@ class InputDecorationTheme with Diagnosticable {
36643663
/// The style to use for [InputDecoration.helperText].
36653664
final TextStyle helperStyle;
36663665

3667-
/// The maximum number of lines the [InputDecorator.helperText] can occupy.
3666+
/// The maximum number of lines the [InputDecoration.helperText] can occupy.
36683667
///
3669-
/// Defaults to null, which means that the [InputDecorator.helperText] will be
3670-
/// limited to a single line with [TextOverflow.ellipsis].
3668+
/// Defaults to null, which means that the [InputDecoration.helperText] will
3669+
/// be limited to a single line with [TextOverflow.ellipsis].
36713670
///
36723671
/// This value is passed along to the [Text.maxLines] attribute
36733672
/// of the [Text] widget used to display the helper.
36743673
///
36753674
/// See also:
36763675
///
3677-
/// * [errorMaxLines], the equivalent but for the [InputDecorator.errorText].
3676+
/// * [errorMaxLines], the equivalent but for the [InputDecoration.errorText].
36783677
final int helperMaxLines;
36793678

36803679
/// The style to use for the [InputDecoration.hintText].
@@ -3696,8 +3695,8 @@ class InputDecorationTheme with Diagnosticable {
36963695

36973696
/// The maximum number of lines the [InputDecoration.errorText] can occupy.
36983697
///
3699-
/// Defaults to null, which means that the [errorText] will be limited
3700-
/// to a single line with [TextOverflow.ellipsis].
3698+
/// Defaults to null, which means that the [InputDecoration.errorText] will be
3699+
/// limited to a single line with [TextOverflow.ellipsis].
37013700
///
37023701
/// This value is passed along to the [Text.maxLines] attribute
37033702
/// of the [Text] widget used to display the error.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ class NavigationRail extends StatefulWidget {
262262
/// When one of the [destinations] is selected the [selectedLabelTextStyle]
263263
/// will be used instead.
264264
///
265-
/// The default value is based on the [Theme]'s [TextTheme.bodyText]. The
265+
/// The default value is based on the [Theme]'s [TextTheme.bodyText1]. The
266266
/// default color is based on the [Theme]'s [ColorScheme.onSurface].
267267
///
268268
/// Properties from this text style, or
@@ -275,7 +275,7 @@ class NavigationRail extends StatefulWidget {
275275
/// When a [NavigationRailDestination] is not selected,
276276
/// [unselectedLabelTextStyle] will be used.
277277
///
278-
/// The default value is based on the [TextTheme.bodyText] of
278+
/// The default value is based on the [TextTheme.bodyText1] of
279279
/// [ThemeData.textTheme]. The default color is based on the [Theme]'s
280280
/// [ColorScheme.primary].
281281
///

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -96,15 +96,15 @@ class OutlinedButton extends ButtonStyleButton {
9696
/// [ButtonStyle] given simple values.
9797
///
9898
/// The [primary], and [onSurface] colors are used to to create a
99-
/// [MaterialStateProperty] [ButtonStyle.foreground] value in the same way
100-
/// that [defaultStyleOf] uses the [ColorScheme] colors with the same names.
101-
/// Specify a value for [primary] to specify the color of the button's text
102-
/// and icons as well as the overlay colors used to indicate the hover, focus,
103-
/// and pressed states. Use [onSurface] to specify the button's disabled text
104-
/// and icon color.
99+
/// [MaterialStateProperty] [ButtonStyle.foregroundColor] value in the same
100+
/// way that [defaultStyleOf] uses the [ColorScheme] colors with the same
101+
/// names. Specify a value for [primary] to specify the color of the button's
102+
/// text and icons as well as the overlay colors used to indicate the hover,
103+
/// focus, and pressed states. Use [onSurface] to specify the button's
104+
/// disabled text and icon color.
105105
///
106106
/// Similarly, the [enabledMouseCursor] and [disabledMouseCursor]
107-
/// parameters are used to construct [ButtonStyle].mouseCursor.
107+
/// parameters are used to construct [ButtonStyle.mouseCursor].
108108
///
109109
/// All of the other parameters are either used directly or used to
110110
/// create a [MaterialStateProperty] with a single value for all
@@ -192,7 +192,7 @@ class OutlinedButton extends ButtonStyleButton {
192192
/// each state and "others" means all other states.
193193
///
194194
/// The color of the [ButtonStyle.textStyle] is not used, the
195-
/// [ButtonStyle.foreground] color is used instead.
195+
/// [ButtonStyle.foregroundColor] is used instead.
196196
///
197197
/// * `textStyle` - Theme.textTheme.button
198198
/// * `backgroundColor` - transparent

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ import 'theme.dart';
3535
class MaterialPageRoute<T> extends PageRoute<T> with MaterialRouteTransitionMixin<T> {
3636
/// Construct a MaterialPageRoute whose contents are defined by [builder].
3737
///
38-
/// The values of [builder], [maintainState], and [PageRoute.fullScreenDialog]
38+
/// The values of [builder], [maintainState], and [PageRoute.fullscreenDialog]
3939
/// must not be null.
4040
MaterialPageRoute({
4141
@required this.builder,

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,9 @@ abstract class ProgressIndicator extends StatefulWidget {
8787
/// intended for use with determinate progress indicators to announce
8888
/// how far along they are.
8989
///
90-
/// For determinate progress indicators, this will be defaulted to [value]
91-
/// expressed as a percentage, i.e. `0.1` will become '10%'.
90+
/// For determinate progress indicators, this will be defaulted to
91+
/// [ProgressIndicator.value] expressed as a percentage, i.e. `0.1` will
92+
/// become '10%'.
9293
/// {@endtemplate}
9394
final String semanticsValue;
9495

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,7 @@ class RangeSlider extends StatefulWidget {
314314
///
315315
/// Each label is rendered using the active [ThemeData]'s
316316
/// [TextTheme.bodyText1] text style, with the theme data's
317-
/// [ColorScheme.onPrimaryColor]. The label's text style can be overridden
317+
/// [ColorScheme.onPrimary] color. The label's text style can be overridden
318318
/// with [SliderThemeData.valueIndicatorTextStyle].
319319
///
320320
/// If null, then the value indicator will not be displayed.

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1330,10 +1330,11 @@ class Scaffold extends StatefulWidget {
13301330
/// drawer.
13311331
///
13321332
/// By default, the value used is 20.0 added to the padding edge of
1333-
/// `MediaQuery.of(context).padding` that corresponds to [alignment].
1334-
/// This ensures that the drag area for notched devices is not obscured. For
1335-
/// example, if `TextDirection.of(context)` is set to [TextDirection.ltr],
1336-
/// 20.0 will be added to `MediaQuery.of(context).padding.left`.
1333+
/// `MediaQuery.of(context).padding` that corresponds to the surrounding
1334+
/// [TextDirection]. This ensures that the drag area for notched devices is
1335+
/// not obscured. For example, if `TextDirection.of(context)` is set to
1336+
/// [TextDirection.ltr], 20.0 will be added to
1337+
/// `MediaQuery.of(context).padding.left`.
13371338
final double drawerEdgeDragWidth;
13381339

13391340
/// Determines if the [Scaffold.drawer] can be opened with a drag

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -390,7 +390,8 @@ class SelectableText extends StatefulWidget {
390390
/// If not set, select all and copy will be enabled by default.
391391
final ToolbarOptions toolbarOptions;
392392

393-
/// {@macro flutter.rendering.editable.selectionEnabled}
393+
/// True if interactive selection is enabled based on the values of
394+
/// [enableInteractiveSelection].
394395
bool get selectionEnabled {
395396
return enableInteractiveSelection;
396397
}

0 commit comments

Comments
 (0)