From 19368efcc3711b5a1f14cb443b438ad412ae9085 Mon Sep 17 00:00:00 2001 From: Michael Goderbauer Date: Wed, 29 Jul 2020 23:56:02 -0700 Subject: [PATCH] Fix dartdocs of dart:ui (#20140) --- lib/ui/channel_buffers.dart | 2 +- lib/ui/compositing.dart | 2 +- lib/ui/painting.dart | 5 +++-- lib/ui/pointer.dart | 2 +- lib/ui/semantics.dart | 2 +- lib/ui/text.dart | 3 ++- lib/ui/window.dart | 9 +++++---- 7 files changed, 14 insertions(+), 11 deletions(-) diff --git a/lib/ui/channel_buffers.dart b/lib/ui/channel_buffers.dart index 39d31d271..ba67c4126 100644 --- a/lib/ui/channel_buffers.dart +++ b/lib/ui/channel_buffers.dart @@ -213,7 +213,7 @@ class ChannelBuffers { } } -/// [ChannelBuffer]s that allow the storage of messages between the +/// [ChannelBuffers] that allow the storage of messages between the /// Engine and the Framework. Typically messages that can't be delivered /// are stored here until the Framework is able to process them. /// diff --git a/lib/ui/compositing.dart b/lib/ui/compositing.dart index 4e0553936..4f8332f6e 100644 --- a/lib/ui/compositing.dart +++ b/lib/ui/compositing.dart @@ -605,7 +605,7 @@ class SceneBuilder extends NativeFieldWrapperClass2 { /// /// Therefore, when implementing a subclass of the [Layer] concept defined in /// the rendering layer of Flutter's framework, once this is called, there's - /// no need to call [addToScene] for its children layers. + /// no need to call [Layer.addToScene] for its children layers. /// /// {@macro dart.ui.sceneBuilder.oldLayerVsRetained} void addRetained(EngineLayer retainedLayer) { diff --git a/lib/ui/painting.dart b/lib/ui/painting.dart index a37478dab..454c8c34c 100644 --- a/lib/ui/painting.dart +++ b/lib/ui/painting.dart @@ -1167,8 +1167,9 @@ class Paint { /// See also: /// /// * [Canvas.saveLayer], which uses its [Paint]'s [blendMode] to composite - /// the layer when [restore] is called. - /// * [BlendMode], which discusses the user of [saveLayer] with [blendMode]. + /// the layer when [Canvas.restore] is called. + /// * [BlendMode], which discusses the user of [Canvas.saveLayer] with + /// [blendMode]. BlendMode get blendMode { final int encoded = _data.getInt32(_kBlendModeOffset, _kFakeHostEndian); return BlendMode.values[encoded ^ _kBlendModeDefault]; diff --git a/lib/ui/pointer.dart b/lib/ui/pointer.dart index 3c8ffefaf..551763f9d 100644 --- a/lib/ui/pointer.dart +++ b/lib/ui/pointer.dart @@ -56,7 +56,7 @@ enum PointerDeviceKind { unknown } -/// The kind of [PointerDeviceKind.signal]. +/// The kind of pointer signal event. enum PointerSignalKind { /// The event is not associated with a pointer signal. none, diff --git a/lib/ui/semantics.dart b/lib/ui/semantics.dart index 518a69412..7097735f2 100644 --- a/lib/ui/semantics.dart +++ b/lib/ui/semantics.dart @@ -169,7 +169,7 @@ class SemanticsAction { /// A request that the node should be dismissed. /// - /// A [Snackbar], for example, may have a dismiss action to indicate to the + /// A [SnackBar], for example, may have a dismiss action to indicate to the /// user that it can be removed after it is no longer relevant. On Android, /// (with TalkBack) special hint text is spoken when focusing the node and /// a custom action is available in the local context menu. On iOS, diff --git a/lib/ui/text.dart b/lib/ui/text.dart index c246731d8..61eaf481a 100644 --- a/lib/ui/text.dart +++ b/lib/ui/text.dart @@ -1965,7 +1965,8 @@ class Paragraph extends NativeFieldWrapperClass2 { /// Returns a list of text boxes that enclose all placeholders in the paragraph. /// - /// The order of the boxes are in the same order as passed in through [addPlaceholder]. + /// The order of the boxes are in the same order as passed in through + /// [ParagraphBuilder.addPlaceholder]. /// /// Coordinates of the [TextBox] are relative to the upper-left corner of the paragraph, /// where positive y values indicate down. diff --git a/lib/ui/window.dart b/lib/ui/window.dart index 22f9ed0c3..5d99e4278 100644 --- a/lib/ui/window.dart +++ b/lib/ui/window.dart @@ -716,10 +716,11 @@ class Window { /// This value is calculated by taking /// `max(0.0, Window.viewPadding - Window.viewInsets)`. This will treat a /// system IME that increases the bottom inset as consuming that much of the - /// bottom padding. For example, on an iPhone X, [Window.padding.bottom] is - /// the same as [Window.viewPadding.bottom] when the soft keyboard is not - /// drawn (to account for the bottom soft button area), but will be `0.0` when - /// the soft keyboard is visible. + /// bottom padding. For example, on an iPhone X, [EdgeInsets.bottom] of + /// [Window.padding] is the same as [EdgeInsets.bottom] of + /// [Window.viewPadding] when the soft keyboard is not drawn (to account for + /// the bottom soft button area), but will be `0.0` when the soft keyboard is + /// visible. /// /// When this changes, [onMetricsChanged] is called. /// -- GitLab