Fix referenes in docs (flutter/engine#39828)

This commit is contained in:
Michael Goderbauer 2023-02-23 15:12:49 -08:00 committed by GitHub
parent dafb738c0a
commit b27d0e8465
5 changed files with 19 additions and 25 deletions

View File

@ -5090,7 +5090,7 @@ class Canvas extends NativeFieldWrapperClass1 {
///
/// After executing both of those calls there is no area left in which to draw
/// because the two paths have no overlapping regions. But, in this case,
/// [getClipBounds] would return a rectangle from `10, 10` to `100, 100` because it
/// [getLocalClipBounds] would return a rectangle from `10, 10` to `100, 100` because it
/// only intersects the bounds of the two path objects to obtain its conservative
/// estimate.
///

View File

@ -48,9 +48,6 @@ typedef PlatformMessageCallback = void Function(String name, ByteData? data, Pla
// Signature for _setNeedsReportTimings.
typedef _SetNeedsReportTimingsFunc = void Function(bool value);
/// Signature for [PlatformDispatcher.onConfigurationChanged].
typedef PlatformConfigurationChangedCallback = void Function(PlatformConfiguration configuration);
/// Signature for [PlatformDispatcher.onError].
///
/// If this method returns false, the engine may use some fallback method to
@ -101,9 +98,8 @@ class RootIsolateToken {
/// It exposes the core scheduler API, the input event callback, the graphics
/// drawing API, and other such core services.
///
/// It manages the list of the application's [views] and the [screens] attached
/// to the device, as well as the [configuration] of various platform
/// attributes.
/// It manages the list of the application's [views] as well as the
/// [configuration] of various platform attributes.
///
/// Consider avoiding static references to this singleton through
/// [PlatformDispatcher.instance] and instead prefer using a binding for
@ -191,7 +187,7 @@ class PlatformDispatcher {
/// See also:
///
/// * [View.of], for accessing the current view.
/// * [PlatformDisptacher.views] for a list of all [FlutterView]s provided
/// * [PlatformDispatcher.views] for a list of all [FlutterView]s provided
/// by the platform.
FlutterView? get implicitView => _implicitViewEnabled() ? _views[0] : null;
@ -1805,7 +1801,7 @@ typedef WindowPadding = ViewPadding;
/// This is populated only on Android.
///
/// The [bounds] are measured in logical pixels. On devices with two screens the
/// coordinate system starts with [0,0] in the top-left corner of the left or top screen
/// coordinate system starts with (0,0) in the top-left corner of the left or top screen
/// and expands to include both screens and the visual space between them.
///
/// The [type] describes the behaviour and if [DisplayFeature] obstructs the display.
@ -1839,8 +1835,8 @@ class DisplayFeature {
///
/// For example, on a dual screen device in portrait mode:
///
/// * [bounds.left] gives you the size of left screen, in logical pixels.
/// * [bounds.right] gives you the size of the left screen + the hinge width.
/// * [Rect.left] gives you the size of left screen, in logical pixels.
/// * [Rect.right] gives you the size of the left screen + the hinge width.
final Rect bounds;
/// Type of display feature, e.g. hinge, fold, cutout.
@ -1885,8 +1881,7 @@ class DisplayFeature {
/// The shape formed by the screens for types [DisplayFeatureType.fold] and
/// [DisplayFeatureType.hinge] is called the posture and is exposed in
/// [DisplayFeature.state]. For example, the [DisplayFeatureState.postureFlat] posture
/// means the screens form a flat surface, while [DisplayFeatureState.postureFlipped]
/// posture means the screens are facing opposite directions.
/// means the screens form a flat surface.
///
/// ![Device with a hinge display feature](https://flutter.github.io/assets-for-api-docs/assets/hardware/display_feature_hinge.png)
///

View File

@ -340,7 +340,7 @@ class FontFeature {
/// U+2044 FRACTION SLASH () are replaced by ligatures that
/// represent the corresponding fraction.
///
/// This feature may imply the [FontFeature.numerator] and
/// This feature may imply the [FontFeature.numerators] and
/// [FontFeature.denominator] features.
///
/// {@tool sample}
@ -2818,7 +2818,7 @@ class Paragraph extends NativeFieldWrapperClass1 {
///
/// Characters not part of a word, such as spaces, symbols, and punctuation,
/// have word breaks on both sides. In such cases, this method will return
/// [offset, offset+1]. Word boundaries are defined more precisely in Unicode
/// (offset, offset+1). Word boundaries are defined more precisely in Unicode
/// Standard Annex #29 http://www.unicode.org/reports/tr29/#Word_Boundaries
///
/// The [TextPosition] is treated as caret position, its [TextPosition.affinity]

View File

@ -86,7 +86,7 @@ class FlutterView {
/// The Flutter framework operates in logical pixels, so it is rarely
/// necessary to directly deal with this property.
///
/// When this changes, [onMetricsChanged] is called.
/// When this changes, [PlatformDispatcher.onMetricsChanged] is called.
///
/// See also:
///
@ -97,7 +97,7 @@ class FlutterView {
/// The dimensions and location of the rectangle into which the scene rendered
/// in this view will be drawn on the screen, in physical pixels.
///
/// When this changes, [onMetricsChanged] is called.
/// When this changes, [PlatformDispatcher.onMetricsChanged] is called.
///
/// At startup, the size and location of the view may not be known before Dart
/// code runs. If this value is observed early in the application lifecycle,
@ -116,7 +116,7 @@ class FlutterView {
/// The dimensions of the rectangle into which the scene rendered in this view
/// will be drawn on the screen, in physical pixels.
///
/// When this changes, [onMetricsChanged] is called.
/// When this changes, [PlatformDispatcher.onMetricsChanged] is called.
///
/// At startup, the size of the view may not be known before Dart code runs.
/// If this value is observed early in the application lifecycle, it may
@ -140,7 +140,7 @@ class FlutterView {
/// which the view can render, but over which the operating system will likely
/// place system UI, such as the keyboard, that fully obscures any content.
///
/// When this property changes, [onMetricsChanged] is called.
/// When this property changes, [PlatformDispatcher.onMetricsChanged] is called.
///
/// The relationship between this [viewInsets],
/// [viewPadding], and [padding] are described in
@ -166,7 +166,7 @@ class FlutterView {
/// change in response to the soft keyboard being visible or hidden, whereas
/// [padding] will.
///
/// When this property changes, [onMetricsChanged] is called.
/// When this property changes, [PlatformDispatcher.onMetricsChanged] is called.
///
/// The relationship between this [viewInsets],
/// [viewPadding], and [padding] are described in
@ -189,7 +189,7 @@ class FlutterView {
/// screen, where swiping inwards from the edges takes users backward
/// through the history of screens they previously visited.
///
/// When this property changes, [onMetricsChanged] is called.
/// When this property changes, [PlatformDispatcher.onMetricsChanged] is called.
///
/// See also:
///
@ -212,7 +212,7 @@ class FlutterView {
/// 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.
/// When this changes, [PlatformDispatcher.onMetricsChanged] is called.
///
/// The relationship between this [viewInsets], [viewPadding], and [padding]
/// are described in more detail in the documentation for [FlutterView].
@ -228,7 +228,7 @@ class FlutterView {
/// {@macro dart.ui.ViewConfiguration.displayFeatures}
///
/// When this changes, [onMetricsChanged] is called.
/// When this changes, [PlatformDispatcher.onMetricsChanged] is called.
///
/// See also:
///
@ -943,7 +943,7 @@ class GestureSettings {
/// instead.
final double? physicalDoubleTapSlop;
/// Create a new [GestureSetting]s object from an existing value, overwriting
/// Create a new [GestureSettings] object from an existing value, overwriting
/// all of the provided fields.
GestureSettings copyWith({
double? physicalTouchSlop,

View File

@ -13,7 +13,6 @@ typedef SemanticsActionCallback = void Function(int nodeId, SemanticsAction acti
typedef PlatformMessageResponseCallback = void Function(ByteData? data);
typedef PlatformMessageCallback = void Function(
String name, ByteData? data, PlatformMessageResponseCallback? callback);
typedef PlatformConfigurationChangedCallback = void Function(PlatformConfiguration configuration);
typedef ErrorCallback = bool Function(Object exception, StackTrace stackTrace);
// ignore: avoid_classes_with_only_static_members