Skip to content

Commit 88a7d83

Browse files
authored
fix unresolved doc references in widgets - part 2 (flutter#62499)
1 parent 7107841 commit 88a7d83

31 files changed

+147
-153
lines changed

packages/flutter/lib/src/rendering/viewport_offset.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ abstract class ViewportOffset extends ChangeNotifier {
208208
}
209209

210210
/// The direction in which the user is trying to change [pixels], relative to
211-
/// the viewport's [RenderViewport.axisDirection].
211+
/// the viewport's [RenderViewportBase.axisDirection].
212212
///
213213
/// If the _user_ is not scrolling, this will return [ScrollDirection.idle]
214214
/// even if there is (for example) a [ScrollActivity] currently animating the

packages/flutter/lib/src/services/autofill.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -734,11 +734,11 @@ abstract class AutofillClient {
734734
/// input fields during autofill. That is, when an autofillable [TextInputClient]
735735
/// gains focus, only the [AutofillClient]s within the same [AutofillScope] will
736736
/// be visible to the autofill service, in the same order as they appear in
737-
/// [autofillClients].
737+
/// [AutofillScope.autofillClients].
738738
///
739739
/// [AutofillScope] also allows [TextInput] to redirect autofill values from the
740740
/// platform to the [AutofillClient] with the given identifier, by calling
741-
/// [getAutofillClient].
741+
/// [AutofillScope.getAutofillClient].
742742
///
743743
/// An [AutofillClient] that's not tied to any [AutofillScope] will only
744744
/// participate in autofill if the autofill is directly triggered by its own

packages/flutter/lib/src/services/text_input.dart

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1243,8 +1243,8 @@ class TextInput {
12431243
/// An autofill context is a collection of input fields that live in the
12441244
/// platform's text input plugin. The platform is encouraged to save the user
12451245
/// input stored in the current autofill context before the context is
1246-
/// destroyed, when [finishAutofillContext] is called with `shouldSave` set to
1247-
/// true.
1246+
/// destroyed, when [TextInput.finishAutofillContext] is called with
1247+
/// `shouldSave` set to true.
12481248
///
12491249
/// Currently, there can only be at most one autofill context at any given
12501250
/// time. When any input field in an [AutofillGroup] requests for autofill
@@ -1254,12 +1254,13 @@ class TextInput {
12541254
/// one will be created to hold the newly added input fields from the group.
12551255
///
12561256
/// Once added to an autofill context, an input field will stay in the context
1257-
/// until the context is destroyed. To prevent leaks, call [finishAutofillContext]
1258-
/// to signal the text input plugin that the user has finalized their input in
1259-
/// the current autofill context. The platform text input plugin either
1260-
/// encourages or discourages the platform from saving the user input based on
1261-
/// the value of the `shouldSave` parameter. The platform usually shows a
1262-
/// "Save for autofill?" prompt for user confirmation.
1257+
/// until the context is destroyed. To prevent leaks, call
1258+
/// [TextInput.finishAutofillContext] to signal the text input plugin that the
1259+
/// user has finalized their input in the current autofill context. The
1260+
/// platform text input plugin either encourages or discourages the platform
1261+
/// from saving the user input based on the value of the `shouldSave`
1262+
/// parameter. The platform usually shows a "Save for autofill?" prompt for
1263+
/// user confirmation.
12631264
/// {@endtemplate}
12641265
///
12651266
/// On many platforms, calling [finishAutofillContext] shows the save user

packages/flutter/lib/src/widgets/actions.dart

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ abstract class Action<T extends Intent> with Diagnosticable {
101101
/// [ActionDispatcher.invokeAction] directly.
102102
///
103103
/// This method is only meant to be invoked by an [ActionDispatcher], or by
104-
/// its subclasses, and only when [enabled] is true.
104+
/// its subclasses, and only when [isEnabled] is true.
105105
///
106106
/// When overriding this method, the returned value can be any Object, but
107107
/// changing the return type of the override to match the type of the returned
@@ -300,10 +300,10 @@ abstract class ContextAction<T extends Intent> extends Action<T> {
300300
/// [ActionDispatcher.invokeAction] directly.
301301
///
302302
/// This method is only meant to be invoked by an [ActionDispatcher], or by
303-
/// its subclasses, and only when [enabled] is true.
303+
/// its subclasses, and only when [isEnabled] is true.
304304
///
305305
/// The optional `context` parameter is the context of the invocation of the
306-
/// action, and in the case of an action invoked by a [ShortcutsManager], via
306+
/// action, and in the case of an action invoked by a [ShortcutManager], via
307307
/// a [Shortcuts] widget, will be the context of the [Shortcuts] widget.
308308
///
309309
/// When overriding this method, the returned value can be any Object, but
@@ -943,7 +943,7 @@ class FocusableActionDetector extends StatefulWidget {
943943
/// The cursor for a mouse pointer when it enters or is hovering over the
944944
/// widget.
945945
///
946-
/// The [cursor] defaults to [MouseCursor.defer], deferring the choice of
946+
/// The [mouseCursor] defaults to [MouseCursor.defer], deferring the choice of
947947
/// cursor to the next region behind it in hit-test order.
948948
final MouseCursor mouseCursor;
949949

packages/flutter/lib/src/widgets/autofill.dart

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -198,9 +198,9 @@ class AutofillGroup extends StatefulWidget {
198198
/// [AutofillClient] when it exits (for example, when an [EditableText] gets
199199
/// unmounted or reparented out of the [AutofillGroup]'s subtree).
200200
///
201-
/// The [AutofillGroupState] class also provides an [attach] method that can be
202-
/// called by [TextInputClient]s that support autofill, instead of
203-
/// [TextInputConnection.attach], to create a [TextInputConnection] to interact
201+
/// The [AutofillGroupState] class also provides an [AutofillGroupState.attach]
202+
/// method that can be called by [TextInputClient]s that support autofill,
203+
/// instead of [TextInput.attach], to create a [TextInputConnection] to interact
204204
/// with the platform's text input system.
205205
/// {@endtemplate}
206206
///

packages/flutter/lib/src/widgets/basic.dart

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1237,11 +1237,12 @@ class Transform extends SingleChildRenderObjectWidget {
12371237
/// If it is specified at the same time as the [origin], both are applied.
12381238
///
12391239
/// An [AlignmentDirectional.centerStart] value is the same as an [Alignment]
1240-
/// whose [Alignment.x] value is `-1.0` if [textDirection] is
1241-
/// [TextDirection.ltr], and `1.0` if [textDirection] is [TextDirection.rtl].
1242-
/// Similarly [AlignmentDirectional.centerEnd] is the same as an [Alignment]
1243-
/// whose [Alignment.x] value is `1.0` if [textDirection] is
1244-
/// [TextDirection.ltr], and `-1.0` if [textDirection] is [TextDirection.rtl].
1240+
/// whose [Alignment.x] value is `-1.0` if [Directionality.of] returns
1241+
/// [TextDirection.ltr], and `1.0` if [Directionality.of] returns
1242+
/// [TextDirection.rtl]. Similarly [AlignmentDirectional.centerEnd] is the
1243+
/// same as an [Alignment] whose [Alignment.x] value is `1.0` if
1244+
/// [Directionality.of] returns [TextDirection.ltr], and `-1.0` if
1245+
/// [Directionality.of] returns [TextDirection.rtl].
12451246
final AlignmentGeometry alignment;
12461247

12471248
/// Whether to apply the transformation when performing hit tests.
@@ -6085,12 +6086,12 @@ class MouseRegion extends StatefulWidget {
60856086
/// This means that a [MouseRegion.onExit] might not be matched by a
60866087
/// [MouseRegion.onEnter].
60876088
///
6088-
/// This restriction aims to prevent a common misuse: if [setState] is called
6089-
/// during [MouseRegion.onExit] without checking whether the widget is still
6090-
/// mounted, an exception will occur. This is because the callback is
6089+
/// This restriction aims to prevent a common misuse: if [State.setState] is
6090+
/// called during [MouseRegion.onExit] without checking whether the widget is
6091+
/// still mounted, an exception will occur. This is because the callback is
60916092
/// triggered during the post-frame phase, at which point the widget has been
6092-
/// unmounted. Since [setState] is exclusive to widgets, the restriction is
6093-
/// specific to [MouseRegion], and does not apply to its lower-level
6093+
/// unmounted. Since [State.setState] is exclusive to widgets, the restriction
6094+
/// is specific to [MouseRegion], and does not apply to its lower-level
60946095
/// counterparts, [RenderMouseRegion] and [MouseTrackerAnnotation].
60956096
///
60966097
/// There are a few ways to mitigate this restriction:
@@ -6358,10 +6359,10 @@ class _RawMouseRegion extends SingleChildRenderObjectWidget {
63586359
///
63596360
/// [RepaintBoundary] is therefore used, both while propagating the
63606361
/// `markNeedsPaint` flag up the render tree and while traversing down the
6361-
/// render tree via [RenderObject.paintChild], to strategically contain repaints
6362-
/// to the render subtree that visually changed for performance. This is done
6363-
/// because the [RepaintBoundary] widget creates a [RenderObject] that always
6364-
/// has a [Layer], decoupling ancestor render objects from the descendant
6362+
/// render tree via [PaintingContext.paintChild], to strategically contain
6363+
/// repaints to the render subtree that visually changed for performance. This
6364+
/// is done because the [RepaintBoundary] widget creates a [RenderObject] that
6365+
/// always has a [Layer], decoupling ancestor render objects from the descendant
63656366
/// render objects.
63666367
///
63676368
/// [RepaintBoundary] has the further side-effect of possibly hinting to the
@@ -7168,7 +7169,7 @@ class Builder extends StatelessWidget {
71687169

71697170
/// Signature for the builder callback used by [StatefulBuilder].
71707171
///
7171-
/// Call [setState] to schedule the [StatefulBuilder] to rebuild.
7172+
/// Call `setState` to schedule the [StatefulBuilder] to rebuild.
71727173
typedef StatefulWidgetBuilder = Widget Function(BuildContext context, StateSetter setState);
71737174

71747175
/// A platonic widget that both has state and calls a closure to obtain its child widget.

packages/flutter/lib/src/widgets/editable_text.dart

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -313,8 +313,8 @@ class ToolbarOptions {
313313
/// action button on the soft keyboard for Android and iOS. The default action
314314
/// is [TextInputAction.done].
315315
///
316-
/// Many [TextInputAction]s are common between Android and iOS. However, if an
317-
/// [inputAction] is provided that is not supported by the current
316+
/// Many [TextInputAction]s are common between Android and iOS. However, if a
317+
/// [textInputAction] is provided that is not supported by the current
318318
/// platform in debug mode, an error will be thrown when the corresponding
319319
/// EditableText receives focus. For example, providing iOS's "emergencyCall"
320320
/// action when running on an Android device will result in an error when in
@@ -976,7 +976,7 @@ class EditableText extends StatefulWidget {
976976
/// When a non-completion action is pressed, such as "next" or "previous", it
977977
/// is often desirable to move the focus to the next or previous field. To do
978978
/// this, handle it as in this example, by calling [FocusNode.focusNext] in
979-
/// the [TextFormField.onFieldSubmitted] callback ([TextFormField] wraps
979+
/// the `onFieldSubmitted` callback of [TextFormField]. ([TextFormField] wraps
980980
/// [EditableText] internally, and uses the value of `onFieldSubmitted` as its
981981
/// [onSubmitted]).
982982
///
@@ -1056,7 +1056,7 @@ class EditableText extends StatefulWidget {
10561056
final MouseCursor mouseCursor;
10571057

10581058
/// If true, the [RenderEditable] created by this widget will not handle
1059-
/// pointer events, see [renderEditable] and [RenderEditable.ignorePointer].
1059+
/// pointer events, see [RenderEditable] and [RenderEditable.ignorePointer].
10601060
///
10611061
/// This property is false by default.
10621062
final bool rendererIgnoresPointer;
@@ -2171,10 +2171,10 @@ class EditableTextState extends State<EditableText> with AutomaticKeepAliveClien
21712171
return result;
21722172
}
21732173

2174-
/// The renderer for this widget's [Editable] descendant.
2174+
/// The renderer for this widget's descendant.
21752175
///
21762176
/// This property is typically used to notify the renderer of input gestures
2177-
/// when [ignorePointer] is true. See [RenderEditable.ignorePointer].
2177+
/// when [RenderEditable.ignorePointer] is true.
21782178
RenderEditable get renderEditable => _editableKey.currentContext.findRenderObject() as RenderEditable;
21792179

21802180
@override

packages/flutter/lib/src/widgets/focus_manager.dart

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1445,10 +1445,9 @@ class FocusManager with DiagnosticableTreeMixin, ChangeNotifier {
14451445
/// interaction type.
14461446
///
14471447
/// The initial value of [highlightMode] depends upon the value of
1448-
/// [defaultTargetPlatform] and
1449-
/// [RendererBinding.instance.mouseTracker.mouseIsConnected], making a guess
1450-
/// about which interaction is most appropriate for the initial interaction
1451-
/// mode.
1448+
/// [defaultTargetPlatform] and [BaseMouseTracker.mouseIsConnected] of
1449+
/// [RendererBinding.mouseTracker], making a guess about which interaction is
1450+
/// most appropriate for the initial interaction mode.
14521451
///
14531452
/// Defaults to [FocusHighlightStrategy.automatic].
14541453
FocusHighlightStrategy get highlightStrategy => _highlightStrategy;

packages/flutter/lib/src/widgets/focus_scope.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -398,7 +398,7 @@ class Focus extends StatefulWidget {
398398
///
399399
/// See also:
400400
///
401-
/// * [DefaultFocusTraversal], a widget that sets the traversal policy for
401+
/// * [FocusTraversalGroup], a widget that sets the traversal policy for
402402
/// its descendants.
403403
/// * [FocusTraversalPolicy], a class that can be extended to describe a
404404
/// traversal policy.

packages/flutter/lib/src/widgets/form.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -348,7 +348,7 @@ class FormField<T> extends StatefulWidget {
348348
/// [TextFormField] to change if no other subtext decoration is set on the
349349
/// field. To create a field whose height is fixed regardless of whether or
350350
/// not an error is displayed, either wrap the [TextFormField] in a fixed
351-
/// height parent like [SizedBox], or set the [TextFormField.helperText]
351+
/// height parent like [SizedBox], or set the [InputDecoration.helperText]
352352
/// parameter to a space.
353353
final FormFieldValidator<T> validator;
354354

0 commit comments

Comments
 (0)