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

Fix "unresolved doc reference" in rendering layer (#62443)

parent 064a9e57
...@@ -1262,12 +1262,12 @@ class _IntrinsicDimensionsCacheEntry { ...@@ -1262,12 +1262,12 @@ class _IntrinsicDimensionsCacheEntry {
/// ### Semantics /// ### Semantics
/// ///
/// For a render box to be accessible, implement the /// For a render box to be accessible, implement the
/// [describeApproximatePaintClip] and [visitChildrenForSemantics] methods, and /// [describeApproximatePaintClip], [visitChildrenForSemantics], and
/// the [semanticsAnnotator] getter. The default implementations are sufficient /// [describeSemanticsConfiguration] methods. The default implementations are
/// for objects that only affect layout, but nodes that represent interactive /// sufficient for objects that only affect layout, but nodes that represent
/// components or information (diagrams, text, images, etc) should provide more /// interactive components or information (diagrams, text, images, etc) should
/// complete implementations. For more information, see the documentation for /// provide more complete implementations. For more information, see the
/// these members. /// documentation for these members.
/// ///
/// ### Intrinsics and Baselines /// ### Intrinsics and Baselines
/// ///
...@@ -2199,11 +2199,11 @@ abstract class RenderBox extends RenderObject { ...@@ -2199,11 +2199,11 @@ abstract class RenderBox extends RenderObject {
/// Likewise, this [RenderBox] is responsible for transforming the position /// Likewise, this [RenderBox] is responsible for transforming the position
/// that it passes to its children when it calls [hitTest] on each child. /// that it passes to its children when it calls [hitTest] on each child.
/// ///
/// If transforming is necessary, [HitTestResult.addWithPaintTransform], /// If transforming is necessary, [BoxHitTestResult.addWithPaintTransform],
/// [HitTestResult.addWithPaintOffset], or [HitTestResult.addWithRawTransform] need /// [BoxHitTestResult.addWithPaintOffset], or
/// to be invoked by subclasses to record the required transform operations /// [BoxHitTestResult.addWithRawTransform] need to be invoked by subclasses to
/// in the [HitTestResult]. These methods will also help with applying the /// record the required transform operations in the [BoxHitTestResult]. These
/// transform to `position`. /// methods will also help with applying the transform to `position`.
/// ///
/// Used by [hitTest]. If you override [hitTest] and do not call this /// Used by [hitTest]. If you override [hitTest] and do not call this
/// function, then you don't need to implement this function. /// function, then you don't need to implement this function.
......
...@@ -194,9 +194,9 @@ abstract class CustomPainter extends Listenable { ...@@ -194,9 +194,9 @@ abstract class CustomPainter extends Listenable {
/// ///
/// If the returned function is null, this painter will not contribute new /// If the returned function is null, this painter will not contribute new
/// [SemanticsNode]s to the semantics tree and the [CustomPaint] corresponding /// [SemanticsNode]s to the semantics tree and the [CustomPaint] corresponding
/// to this painter will not create a semantics boundary. However, if /// to this painter will not create a semantics boundary. However, if the
/// [CustomPaint.child] is not null, the child may contribute [SemanticsNode]s /// child of a [CustomPaint] is not null, the child may contribute
/// to the tree. /// [SemanticsNode]s to the tree.
/// ///
/// See also: /// See also:
/// ///
......
...@@ -646,7 +646,7 @@ class PlatformViewLayer extends Layer { ...@@ -646,7 +646,7 @@ class PlatformViewLayer extends Layer {
/// The unique identifier of the UIView displayed on this layer. /// The unique identifier of the UIView displayed on this layer.
/// ///
/// A UIView with this identifier must have been created by [PlatformViewsServices.initUiKitView]. /// A UIView with this identifier must have been created by [PlatformViewsService.initUiKitView].
final int viewId; final int viewId;
@override @override
...@@ -1188,7 +1188,7 @@ class OffsetLayer extends ContainerLayer { ...@@ -1188,7 +1188,7 @@ class OffsetLayer extends ContainerLayer {
/// ///
/// The [pixelRatio] describes the scale between the logical pixels and the /// The [pixelRatio] describes the scale between the logical pixels and the
/// size of the output image. It is independent of the /// size of the output image. It is independent of the
/// [window.devicePixelRatio] for the device, so specifying 1.0 (the default) /// [Window.devicePixelRatio] for the device, so specifying 1.0 (the default)
/// will give you a 1:1 mapping between logical pixels and the output pixels /// will give you a 1:1 mapping between logical pixels and the output pixels
/// in the image. /// in the image.
/// ///
...@@ -2413,7 +2413,7 @@ class FollowerLayer extends ContainerLayer { ...@@ -2413,7 +2413,7 @@ class FollowerLayer extends ContainerLayer {
/// ///
/// When an annotation search arrives, this layer defers the same search to each /// When an annotation search arrives, this layer defers the same search to each
/// of this layer's children, respecting their opacity. Then it adds this /// of this layer's children, respecting their opacity. Then it adds this
/// layer's [annotation] if all of the following restrictions are met: /// layer's annotation if all of the following restrictions are met:
/// ///
/// {@template flutter.rendering.annotatedRegionLayer.restrictions} /// {@template flutter.rendering.annotatedRegionLayer.restrictions}
/// * The target type must be identical to the annotated type `T`. /// * The target type must be identical to the annotated type `T`.
......
...@@ -449,7 +449,7 @@ class RenderListWheelViewport ...@@ -449,7 +449,7 @@ class RenderListWheelViewport
/// If false, every child will be painted. However the [Scrollable] is still /// If false, every child will be painted. However the [Scrollable] is still
/// the size of the viewport and detects gestures inside only. /// the size of the viewport and detects gestures inside only.
/// ///
/// Defaults to [false]. Must not be null. Cannot be true if [clipBehavior] /// Defaults to false. Must not be null. Cannot be true if [clipBehavior]
/// is not [Clip.none] since children outside the viewport will be clipped, and /// is not [Clip.none] since children outside the viewport will be clipped, and
/// therefore cannot render children outside the viewport. /// therefore cannot render children outside the viewport.
/// {@endtemplate} /// {@endtemplate}
......
...@@ -160,7 +160,7 @@ abstract class MouseCursorSession { ...@@ -160,7 +160,7 @@ abstract class MouseCursorSession {
/// ///
/// A [MouseCursor] object is used by being assigned to a [MouseRegion] or /// A [MouseCursor] object is used by being assigned to a [MouseRegion] or
/// another widget that exposes the [MouseRegion] API, such as /// another widget that exposes the [MouseRegion] API, such as
/// [InkWell.mouseCursor]. /// [InkResponse.mouseCursor].
/// ///
/// {@tool snippet --template=stateless_widget_material} /// {@tool snippet --template=stateless_widget_material}
/// This sample creates a rectangular region that is wrapped by a [MouseRegion] /// This sample creates a rectangular region that is wrapped by a [MouseRegion]
...@@ -361,7 +361,7 @@ class _SystemMouseCursorSession extends MouseCursorSession { ...@@ -361,7 +361,7 @@ class _SystemMouseCursorSession extends MouseCursorSession {
/// * macOS: API name in Objective C /// * macOS: API name in Objective C
/// ///
/// If the platform that the application is running on is not listed for a cursor, /// If the platform that the application is running on is not listed for a cursor,
/// using this cursor falls back to [basic]. /// using this cursor falls back to [SystemMouseCursors.basic].
/// ///
/// [SystemMouseCursors] enumerates the complete set of system cursors supported /// [SystemMouseCursors] enumerates the complete set of system cursors supported
/// by Flutter, which are hard-coded in the engine. Therefore, manually /// by Flutter, which are hard-coded in the engine. Therefore, manually
...@@ -433,7 +433,8 @@ class SystemMouseCursors { ...@@ -433,7 +433,8 @@ class SystemMouseCursors {
/// Hide the cursor. /// Hide the cursor.
/// ///
/// Any cursor other than [none] or [uncontrolled] unhides the cursor. /// Any cursor other than [none] or [MouseCursor.uncontrolled] unhides the
/// cursor.
static const SystemMouseCursor none = SystemMouseCursor._(kind: 'none'); static const SystemMouseCursor none = SystemMouseCursor._(kind: 'none');
......
...@@ -297,8 +297,8 @@ class MouseTrackerUpdateDetails with Diagnosticable { ...@@ -297,8 +297,8 @@ class MouseTrackerUpdateDetails with Diagnosticable {
/// ///
/// * [MouseTracker], which is a subclass of [BaseMouseTracker] with definition /// * [MouseTracker], which is a subclass of [BaseMouseTracker] with definition
/// of how to process mouse event callbacks and mouse cursors. /// of how to process mouse event callbacks and mouse cursors.
/// * [MouseCursorMixin], which is a mixin for [BaseMouseTracker] that defines /// * [MouseTrackerCursorMixin], which is a mixin for [BaseMouseTracker] that
/// how to process mouse cursors. /// defines how to process mouse cursors.
class BaseMouseTracker extends ChangeNotifier { class BaseMouseTracker extends ChangeNotifier {
/// Creates a [BaseMouseTracker] to keep track of mouse locations. /// Creates a [BaseMouseTracker] to keep track of mouse locations.
/// ///
......
...@@ -2742,10 +2742,11 @@ abstract class RenderObject extends AbstractNode with DiagnosticableTreeMixin im ...@@ -2742,10 +2742,11 @@ abstract class RenderObject extends AbstractNode with DiagnosticableTreeMixin im
/// Assemble the [SemanticsNode] for this [RenderObject]. /// Assemble the [SemanticsNode] for this [RenderObject].
/// ///
/// If [isSemanticBoundary] is true, this method is called with the `node` /// If [describeSemanticsConfiguration] sets
/// created for this [RenderObject], the `config` to be applied to that node /// [SemanticsConfiguration.isSemanticBoundary] to true, this method is called
/// and the `children` [SemanticsNode]s that descendants of this RenderObject /// with the `node` created for this [RenderObject], the `config` to be
/// have generated. /// applied to that node and the `children` [SemanticsNode]s that descendants
/// of this RenderObject have generated.
/// ///
/// By default, the method will annotate `node` with `config` and add the /// By default, the method will annotate `node` with `config` and add the
/// `children` to it. /// `children` to it.
......
...@@ -68,7 +68,7 @@ Set<Type> _factoriesTypeSet<T>(Set<Factory<T>> factories) { ...@@ -68,7 +68,7 @@ Set<Type> _factoriesTypeSet<T>(Set<Factory<T>> factories) {
/// {@endtemplate} /// {@endtemplate}
/// ///
/// {@template flutter.rendering.platformView.gestures} /// {@template flutter.rendering.platformView.gestures}
/// The render object participates in Flutter's [GestureArena]s, and dispatches touch events to the /// The render object participates in Flutter's gesture arenas, and dispatches touch events to the
/// platform view iff it won the arena. Specific gestures that should be dispatched to the platform /// platform view iff it won the arena. Specific gestures that should be dispatched to the platform
/// view can be specified with factories in the `gestureRecognizers` constructor parameter or /// view can be specified with factories in the `gestureRecognizers` constructor parameter or
/// by calling `updateGestureRecognizers`. If the set of gesture recognizers is empty, the gesture /// by calling `updateGestureRecognizers`. If the set of gesture recognizers is empty, the gesture
......
...@@ -1882,7 +1882,7 @@ class RenderPhysicalModel extends _RenderPhysicalModelBase<RRect> { ...@@ -1882,7 +1882,7 @@ class RenderPhysicalModel extends _RenderPhysicalModelBase<RRect> {
class RenderPhysicalShape extends _RenderPhysicalModelBase<Path> { class RenderPhysicalShape extends _RenderPhysicalModelBase<Path> {
/// Creates an arbitrary shape clip. /// Creates an arbitrary shape clip.
/// ///
/// The [color] and [shape] parameters are required. /// The [color] and [clipper] parameters are required.
/// ///
/// The [clipper], [elevation], [color] and [shadowColor] must not be null. /// The [clipper], [elevation], [color] and [shadowColor] must not be null.
/// Additionally, the [elevation] must be non-negative. /// Additionally, the [elevation] must be non-negative.
...@@ -2149,10 +2149,10 @@ class RenderTransform extends RenderProxyBox { ...@@ -2149,10 +2149,10 @@ class RenderTransform extends RenderProxyBox {
/// This is equivalent to setting an origin based on the size of the box. /// This is equivalent to setting an origin based on the size of the box.
/// If it is specified at the same time as an offset, both are applied. /// If it is specified at the same time as an offset, both are applied.
/// ///
/// An [AlignmentDirectional.start] value is the same as an [Alignment] /// An [AlignmentDirectional.centerStart] value is the same as an [Alignment]
/// whose [Alignment.x] value is `-1.0` if [textDirection] is /// whose [Alignment.x] value is `-1.0` if [textDirection] is
/// [TextDirection.ltr], and `1.0` if [textDirection] is [TextDirection.rtl]. /// [TextDirection.ltr], and `1.0` if [textDirection] is [TextDirection.rtl].
/// Similarly [AlignmentDirectional.end] is the same as an [Alignment] /// Similarly [AlignmentDirectional.centerEnd] is the same as an [Alignment]
/// whose [Alignment.x] value is `1.0` if [textDirection] is /// whose [Alignment.x] value is `1.0` if [textDirection] is
/// [TextDirection.ltr], and `-1.0` if [textDirection] is [TextDirection.rtl]. /// [TextDirection.ltr], and `-1.0` if [textDirection] is [TextDirection.rtl].
AlignmentGeometry get alignment => _alignment; AlignmentGeometry get alignment => _alignment;
...@@ -2947,7 +2947,7 @@ class RenderRepaintBoundary extends RenderProxyBox { ...@@ -2947,7 +2947,7 @@ class RenderRepaintBoundary extends RenderProxyBox {
/// ///
/// The [pixelRatio] describes the scale between the logical pixels and the /// The [pixelRatio] describes the scale between the logical pixels and the
/// size of the output image. It is independent of the /// size of the output image. It is independent of the
/// [window.devicePixelRatio] for the device, so specifying 1.0 (the default) /// [Window.devicePixelRatio] for the device, so specifying 1.0 (the default)
/// will give you a 1:1 mapping between logical pixels and the output pixels /// will give you a 1:1 mapping between logical pixels and the output pixels
/// in the image. /// in the image.
/// ///
...@@ -3807,7 +3807,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox { ...@@ -3807,7 +3807,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox {
markNeedsSemanticsUpdate(); markNeedsSemanticsUpdate();
} }
/// If non-null, sets the [SemanticsNode.isLink] semantic to the given value. /// If non-null, sets the [SemanticsConfiguration.isLink] semantic to the
/// given value.
bool get link => _link; bool get link => _link;
bool _link; bool _link;
set link(bool value) { set link(bool value) {
...@@ -3817,7 +3818,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox { ...@@ -3817,7 +3818,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox {
markNeedsSemanticsUpdate(); markNeedsSemanticsUpdate();
} }
/// If non-null, sets the [SemanticsNode.isHeader] semantic to the given value. /// If non-null, sets the [SemanticsConfiguration.isHeader] semantic to the
/// given value.
bool get header => _header; bool get header => _header;
bool _header; bool _header;
set header(bool value) { set header(bool value) {
...@@ -3827,7 +3829,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox { ...@@ -3827,7 +3829,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox {
markNeedsSemanticsUpdate(); markNeedsSemanticsUpdate();
} }
/// If non-null, sets the [SemanticsNode.isTextField] semantic to the given value. /// If non-null, sets the [SemanticsConfiguration.isTextField] semantic to the
/// given value.
bool get textField => _textField; bool get textField => _textField;
bool _textField; bool _textField;
set textField(bool value) { set textField(bool value) {
...@@ -3837,7 +3840,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox { ...@@ -3837,7 +3840,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox {
markNeedsSemanticsUpdate(); markNeedsSemanticsUpdate();
} }
/// If non-null, sets the [SemanticsNode.isReadOnly] semantic to the given value. /// If non-null, sets the [SemanticsConfiguration.isReadOnly] semantic to the
/// given value.
bool get readOnly => _readOnly; bool get readOnly => _readOnly;
bool _readOnly; bool _readOnly;
set readOnly(bool value) { set readOnly(bool value) {
...@@ -3847,7 +3851,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox { ...@@ -3847,7 +3851,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox {
markNeedsSemanticsUpdate(); markNeedsSemanticsUpdate();
} }
/// If non-null, sets the [SemanticsNode.isFocusable] semantic to the given value. /// If non-null, sets the [SemanticsConfiguration.isFocusable] semantic to the
/// given value.
bool get focusable => _focusable; bool get focusable => _focusable;
bool _focusable; bool _focusable;
set focusable(bool value) { set focusable(bool value) {
...@@ -3857,7 +3862,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox { ...@@ -3857,7 +3862,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox {
markNeedsSemanticsUpdate(); markNeedsSemanticsUpdate();
} }
/// If non-null, sets the [SemanticsNode.isFocused] semantic to the given value. /// If non-null, sets the [SemanticsConfiguration.isFocused] semantic to the
/// given value.
bool get focused => _focused; bool get focused => _focused;
bool _focused; bool _focused;
set focused(bool value) { set focused(bool value) {
...@@ -3867,8 +3873,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox { ...@@ -3867,8 +3873,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox {
markNeedsSemanticsUpdate(); markNeedsSemanticsUpdate();
} }
/// If non-null, sets the [SemanticsNode.isInMutuallyExclusiveGroup] semantic /// If non-null, sets the [SemanticsConfiguration.isInMutuallyExclusiveGroup]
/// to the given value. /// semantic to the given value.
bool get inMutuallyExclusiveGroup => _inMutuallyExclusiveGroup; bool get inMutuallyExclusiveGroup => _inMutuallyExclusiveGroup;
bool _inMutuallyExclusiveGroup; bool _inMutuallyExclusiveGroup;
set inMutuallyExclusiveGroup(bool value) { set inMutuallyExclusiveGroup(bool value) {
...@@ -3878,8 +3884,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox { ...@@ -3878,8 +3884,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox {
markNeedsSemanticsUpdate(); markNeedsSemanticsUpdate();
} }
/// If non-null, sets the [SemanticsNode.isObscured] semantic to the given /// If non-null, sets the [SemanticsConfiguration.isObscured] semantic to the
/// value. /// given value.
bool get obscured => _obscured; bool get obscured => _obscured;
bool _obscured; bool _obscured;
set obscured(bool value) { set obscured(bool value) {
...@@ -3900,7 +3906,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox { ...@@ -3900,7 +3906,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox {
markNeedsSemanticsUpdate(); markNeedsSemanticsUpdate();
} }
/// If non-null, sets the [SemanticsNode.scopesRoute] semantic to the give value. /// If non-null, sets the [SemanticsConfiguration.scopesRoute] semantic to the
/// give value.
bool get scopesRoute => _scopesRoute; bool get scopesRoute => _scopesRoute;
bool _scopesRoute; bool _scopesRoute;
set scopesRoute(bool value) { set scopesRoute(bool value) {
...@@ -3910,7 +3917,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox { ...@@ -3910,7 +3917,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox {
markNeedsSemanticsUpdate(); markNeedsSemanticsUpdate();
} }
/// If non-null, sets the [SemanticsNode.namesRoute] semantic to the give value. /// If non-null, sets the [SemanticsConfiguration.namesRoute] semantic to the
/// give value.
bool get namesRoute => _namesRoute; bool get namesRoute => _namesRoute;
bool _namesRoute; bool _namesRoute;
set namesRoute(bool value) { set namesRoute(bool value) {
...@@ -3920,8 +3928,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox { ...@@ -3920,8 +3928,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox {
markNeedsSemanticsUpdate(); markNeedsSemanticsUpdate();
} }
/// If non-null, sets the [SemanticsNode.isHidden] semantic to the given /// If non-null, sets the [SemanticsConfiguration.isHidden] semantic to the
/// value. /// given value.
bool get hidden => _hidden; bool get hidden => _hidden;
bool _hidden; bool _hidden;
set hidden(bool value) { set hidden(bool value) {
...@@ -3931,8 +3939,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox { ...@@ -3931,8 +3939,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox {
markNeedsSemanticsUpdate(); markNeedsSemanticsUpdate();
} }
/// If non-null, sets the [SemanticsNode.isImage] semantic to the given /// If non-null, sets the [SemanticsConfiguration.isImage] semantic to the
/// value. /// given value.
bool get image => _image; bool get image => _image;
bool _image; bool _image;
set image(bool value) { set image(bool value) {
...@@ -3941,8 +3949,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox { ...@@ -3941,8 +3949,8 @@ class RenderSemanticsAnnotations extends RenderProxyBox {
_image = value; _image = value;
} }
/// If non-null, sets the [SemanticsFlag.isLiveRegion] semantic to the given /// If non-null, sets the [SemanticsConfiguration.liveRegion] semantic to
/// value. /// the given value.
bool get liveRegion => _liveRegion; bool get liveRegion => _liveRegion;
bool _liveRegion; bool _liveRegion;
set liveRegion(bool value) { set liveRegion(bool value) {
...@@ -3974,7 +3982,7 @@ class RenderSemanticsAnnotations extends RenderProxyBox { ...@@ -3974,7 +3982,7 @@ class RenderSemanticsAnnotations extends RenderProxyBox {
markNeedsSemanticsUpdate(); markNeedsSemanticsUpdate();
} }
/// If non-null, sets the [SemanticsNode.isToggled] semantic to the given /// If non-null, sets the [SemanticsConfiguration.isToggled] semantic to the given
/// value. /// value.
bool get toggled => _toggled; bool get toggled => _toggled;
bool _toggled; bool _toggled;
...@@ -4047,7 +4055,7 @@ class RenderSemanticsAnnotations extends RenderProxyBox { ...@@ -4047,7 +4055,7 @@ class RenderSemanticsAnnotations extends RenderProxyBox {
markNeedsSemanticsUpdate(); markNeedsSemanticsUpdate();
} }
/// If non-null, sets the [SemanticsNode.hintOverride] to the given value. /// If non-null, sets the [SemanticsConfiguration.hintOverrides] to the given value.
SemanticsHintOverrides get hintOverrides => _hintOverrides; SemanticsHintOverrides get hintOverrides => _hintOverrides;
SemanticsHintOverrides _hintOverrides; SemanticsHintOverrides _hintOverrides;
set hintOverrides(SemanticsHintOverrides value) { set hintOverrides(SemanticsHintOverrides value) {
...@@ -4318,7 +4326,7 @@ class RenderSemanticsAnnotations extends RenderProxyBox { ...@@ -4318,7 +4326,7 @@ class RenderSemanticsAnnotations extends RenderProxyBox {
markNeedsSemanticsUpdate(); markNeedsSemanticsUpdate();
} }
/// The handler for [SemanticsAction.onMoveCursorForwardByCharacter]. /// The handler for [SemanticsAction.moveCursorForwardByCharacter].
/// ///
/// This handler is invoked when the user wants to move the cursor in a /// This handler is invoked when the user wants to move the cursor in a
/// text field forward by one character. /// text field forward by one character.
...@@ -4336,7 +4344,7 @@ class RenderSemanticsAnnotations extends RenderProxyBox { ...@@ -4336,7 +4344,7 @@ class RenderSemanticsAnnotations extends RenderProxyBox {
markNeedsSemanticsUpdate(); markNeedsSemanticsUpdate();
} }
/// The handler for [SemanticsAction.onMoveCursorBackwardByCharacter]. /// The handler for [SemanticsAction.moveCursorBackwardByCharacter].
/// ///
/// This handler is invoked when the user wants to move the cursor in a /// This handler is invoked when the user wants to move the cursor in a
/// text field backward by one character. /// text field backward by one character.
...@@ -4354,7 +4362,7 @@ class RenderSemanticsAnnotations extends RenderProxyBox { ...@@ -4354,7 +4362,7 @@ class RenderSemanticsAnnotations extends RenderProxyBox {
markNeedsSemanticsUpdate(); markNeedsSemanticsUpdate();
} }
/// The handler for [SemanticsAction.onMoveCursorForwardByWord]. /// The handler for [SemanticsAction.moveCursorForwardByWord].
/// ///
/// This handler is invoked when the user wants to move the cursor in a /// This handler is invoked when the user wants to move the cursor in a
/// text field backward by one character. /// text field backward by one character.
...@@ -4372,7 +4380,7 @@ class RenderSemanticsAnnotations extends RenderProxyBox { ...@@ -4372,7 +4380,7 @@ class RenderSemanticsAnnotations extends RenderProxyBox {
markNeedsSemanticsUpdate(); markNeedsSemanticsUpdate();
} }
/// The handler for [SemanticsAction.onMoveCursorBackwardByWord]. /// The handler for [SemanticsAction.moveCursorBackwardByWord].
/// ///
/// This handler is invoked when the user wants to move the cursor in a /// This handler is invoked when the user wants to move the cursor in a
/// text field backward by one character. /// text field backward by one character.
...@@ -5079,7 +5087,7 @@ class RenderAnnotatedRegion<T> extends RenderProxyBox { ...@@ -5079,7 +5087,7 @@ class RenderAnnotatedRegion<T> extends RenderProxyBox {
/// layer tree. /// layer tree.
/// ///
/// If [sized] is true, the layer is provided with the size of this render /// If [sized] is true, the layer is provided with the size of this render
/// object to clip the results of [Layer.findRegion]. /// object to clip the results of [Layer.find].
/// ///
/// Neither [value] nor [sized] can be null. /// Neither [value] nor [sized] can be null.
RenderAnnotatedRegion({ RenderAnnotatedRegion({
......
...@@ -227,27 +227,27 @@ class SliverConstraints extends Constraints { ...@@ -227,27 +227,27 @@ class SliverConstraints extends Constraints {
/// contents depends on the [growthDirection]. /// contents depends on the [growthDirection].
final double scrollOffset; final double scrollOffset;
/// The scroll distance that has been consumed by all [Sliver]s that came /// The scroll distance that has been consumed by all [RenderSliver]s that
/// before this [Sliver]. /// came before this [RenderSliver].
/// ///
/// # Edge Cases /// # Edge Cases
/// ///
/// [Sliver]s often lazily create their internal content as layout occurs, /// [RenderSliver]s often lazily create their internal content as layout
/// e.g., [SliverList]. In this case, when [Sliver]s exceed the viewport, /// occurs, e.g., [SliverList]. In this case, when [RenderSliver]s exceed the
/// their children are built lazily, and the [Sliver] does not have enough /// viewport, their children are built lazily, and the [RenderSliver] does not
/// information to estimate its total extent, [precedingScrollExtent] will be /// have enough information to estimate its total extent,
/// [double.infinity] for all [Sliver]s that appear after the lazily /// [precedingScrollExtent] will be [double.infinity] for all [RenderSliver]s
/// constructed child. This is because a total [scrollExtent] cannot be /// that appear after the lazily constructed child. This is because a total
/// calculated unless all inner children have been created and sized, or the /// [SliverGeometry.scrollExtent] cannot be calculated unless all inner
/// number of children and estimated extents are provided. The infinite /// children have been created and sized, or the number of children and
/// [scrollExtent] will become finite as soon as enough information is /// estimated extents are provided. The infinite [SliverGeometry.scrollExtent]
/// available to estimate the overall extent of all children within the given /// will become finite as soon as enough information is available to estimate
/// [Sliver]. /// the overall extent of all children within the given [RenderSliver].
/// ///
/// [Sliver]s may legitimately be infinite, meaning that they can scroll /// [RenderSliver]s may legitimately be infinite, meaning that they can scroll
/// content forever without reaching the end. For any [Sliver]s that appear /// content forever without reaching the end. For any [RenderSliver]s that
/// after the infinite [Sliver], the [precedingScrollExtent] will be /// appear after the infinite [RenderSliver], the [precedingScrollExtent] will
/// [double.infinity]. /// be [double.infinity].
final double precedingScrollExtent; final double precedingScrollExtent;
/// The number of pixels from where the pixels corresponding to the /// The number of pixels from where the pixels corresponding to the
...@@ -788,7 +788,7 @@ class SliverGeometry with Diagnosticable { ...@@ -788,7 +788,7 @@ class SliverGeometry with Diagnosticable {
} }
} }
/// Method signature for hit testing a [RenderSLiver]. /// Method signature for hit testing a [RenderSliver].
/// ///
/// Used by [SliverHitTestResult.addWithAxisOffset] to hit test [RenderSliver] /// Used by [SliverHitTestResult.addWithAxisOffset] to hit test [RenderSliver]
/// children. /// children.
......
...@@ -44,10 +44,6 @@ abstract class RenderSliverBoxChildManager { ...@@ -44,10 +44,6 @@ abstract class RenderSliverBoxChildManager {
/// the [RenderSliverMultiBoxAdaptor] object if they were not created during /// the [RenderSliverMultiBoxAdaptor] object if they were not created during
/// this frame and have not yet been updated during this frame. It is not /// this frame and have not yet been updated during this frame. It is not
/// valid to add any other children to this render object. /// valid to add any other children to this render object.
///
/// If this method does not create a child for a given `index` greater than or
/// equal to zero, then [computeMaxScrollOffset] must be able to return a
/// precise value.
void createChild(int index, { @required RenderBox after }); void createChild(int index, { @required RenderBox after });
/// Remove the given child from the child list. /// Remove the given child from the child list.
......
...@@ -301,7 +301,7 @@ abstract class RenderViewportBase<ParentDataClass extends ContainerParentDataMix ...@@ -301,7 +301,7 @@ abstract class RenderViewportBase<ParentDataClass extends ContainerParentDataMix
/// {@template flutter.rendering.viewport.cacheExtentStyle} /// {@template flutter.rendering.viewport.cacheExtentStyle}
/// Controls how the [cacheExtent] is interpreted. /// Controls how the [cacheExtent] is interpreted.
/// ///
/// If set to [CacheExtentStyle.pixels], the [cacheExtent] will be treated as /// If set to [CacheExtentStyle.pixel], the [cacheExtent] will be treated as
/// a logical pixels. /// a logical pixels.
/// ///
/// If set to [CacheExtentStyle.viewport], the [cacheExtent] will be treated /// If set to [CacheExtentStyle.viewport], the [cacheExtent] will be treated
...@@ -1232,7 +1232,7 @@ class RenderViewport extends RenderViewportBase<SliverPhysicalContainerParentDat ...@@ -1232,7 +1232,7 @@ class RenderViewport extends RenderViewportBase<SliverPhysicalContainerParentDat
/// The first child in the [GrowthDirection.forward] growth direction. /// The first child in the [GrowthDirection.forward] growth direction.
/// ///
/// This child that will be at the position defined by [anchor] when the /// This child that will be at the position defined by [anchor] when the
/// [offset.pixels] is `0`. /// [ViewportOffset.pixels] of [offset] is `0`.
/// ///
/// Children after [center] will be placed in the [axisDirection] relative to /// Children after [center] will be placed in the [axisDirection] relative to
/// the [center]. Children before [center] will be placed in the opposite of /// the [center]. Children before [center] will be placed in the opposite of
......
...@@ -40,7 +40,7 @@ typedef _BucketVisitor = void Function(RestorationBucket bucket); ...@@ -40,7 +40,7 @@ typedef _BucketVisitor = void Function(RestorationBucket bucket);
/// [rootBucket] provided by this [RestorationManager]). The owner of a bucket /// [rootBucket] provided by this [RestorationManager]). The owner of a bucket
/// may store arbitrary values in the bucket as long as they can be serialized /// may store arbitrary values in the bucket as long as they can be serialized
/// with the [StandardMessageCodec]. The values are stored in the bucket under a /// with the [StandardMessageCodec]. The values are stored in the bucket under a
/// given restoration ID as key. A restoration ID is a [Sting] that must be /// given restoration ID as key. A restoration ID is a [String] that must be
/// unique within a given bucket. To access the stored value again during state /// unique within a given bucket. To access the stored value again during state
/// restoration, the same restoration ID must be provided again. The owner of /// restoration, the same restoration ID must be provided again. The owner of
/// the bucket may also make the bucket available to other entities so that they /// the bucket may also make the bucket available to other entities so that they
...@@ -458,7 +458,7 @@ class RestorationBucket extends ChangeNotifier { ...@@ -458,7 +458,7 @@ class RestorationBucket extends ChangeNotifier {
} }
/// Creates a child bucket initialized with the data that the provided /// Creates a child bucket initialized with the data that the provided
/// `parent` has stored under the provided [id]. /// `parent` has stored under the provided [restorationId].
/// ///
/// This constructor cannot be used if the `parent` does not have any child /// This constructor cannot be used if the `parent` does not have any child
/// data stored under the given ID. In that case, create an empty bucket (via /// data stored under the given ID. In that case, create an empty bucket (via
...@@ -720,9 +720,9 @@ class RestorationBucket extends ChangeNotifier { ...@@ -720,9 +720,9 @@ class RestorationBucket extends ChangeNotifier {
/// ///
/// The `child` will be dropped from its old parent, if it had one. /// The `child` will be dropped from its old parent, if it had one.
/// ///
/// The `child` is stored under its [id] in this bucket. If this bucket /// The `child` is stored under its [restorationId] in this bucket. If this
/// already contains a child bucket under the same id, the owner of that /// bucket already contains a child bucket under the same id, the owner of
/// existing bucket must give it up (e.g. by moving the child bucket to a /// that existing bucket must give it up (e.g. by moving the child bucket to a
/// different parent or by disposing it) before the end of the current frame. /// different parent or by disposing it) before the end of the current frame.
/// Otherwise an exception indicating the illegal use of duplicated /// Otherwise an exception indicating the illegal use of duplicated
/// restoration IDs will trigger in debug mode. /// restoration IDs will trigger in debug mode.
......
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