Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Fix dartdocs of dart:ui #20140

Merged
merged 1 commit into from
Jul 30, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/ui/channel_buffers.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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.
///
Expand Down
2 changes: 1 addition & 1 deletion lib/ui/compositing.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
5 changes: 3 additions & 2 deletions lib/ui/painting.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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];
Expand Down
2 changes: 1 addition & 1 deletion lib/ui/pointer.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion lib/ui/semantics.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
3 changes: 2 additions & 1 deletion lib/ui/text.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
9 changes: 5 additions & 4 deletions lib/ui/window.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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.
///
Expand Down