Fix docs re: return value of Navigator's restorable methods (#102595)
diff --git a/packages/flutter/lib/src/widgets/navigator.dart b/packages/flutter/lib/src/widgets/navigator.dart
index 93d0bc5..c64eac5 100644
--- a/packages/flutter/lib/src/widgets/navigator.dart
+++ b/packages/flutter/lib/src/widgets/navigator.dart
@@ -1531,15 +1531,17 @@
/// Ongoing gestures within the current route are canceled when a new route is
/// pushed.
///
- /// Returns a [Future] that completes to the `result` value passed to [pop]
- /// when the pushed route is popped off the navigator.
- ///
/// The `T` type argument is the type of the return value of the route.
///
/// To use [pushNamed], an [Navigator.onGenerateRoute] callback must be
/// provided,
/// {@endtemplate}
///
+ /// {@template flutter.widgets.navigator.pushNamed.returnValue}
+ /// Returns a [Future] that completes to the `result` value passed to [pop]
+ /// when the pushed route is popped off the navigator.
+ /// {@endtemplate}
+ ///
/// {@template flutter.widgets.Navigator.pushNamed}
/// The provided `arguments` are passed to the pushed route via
/// [RouteSettings.arguments]. Any object can be passed as `arguments` (e.g. a
@@ -1699,9 +1701,6 @@
/// Ongoing gestures within the current route are canceled when a new route is
/// pushed.
///
- /// Returns a [Future] that completes to the `result` value passed to [pop]
- /// when the pushed route is popped off the navigator.
- ///
/// The `T` type argument is the type of the return value of the new route,
/// and `TO` is the type of the return value of the old route.
///
@@ -1709,6 +1708,8 @@
/// be provided.
/// {@endtemplate}
///
+ /// {@macro flutter.widgets.navigator.pushNamed.returnValue}
+ ///
/// {@macro flutter.widgets.Navigator.pushNamed}
///
/// {@tool snippet}
@@ -1793,16 +1794,14 @@
/// Ongoing gestures within the current route are canceled when a new route is
/// pushed.
///
- /// Returns a [Future] that completes to the `result` value passed to [pop]
- /// when the pushed route is popped off the navigator.
- ///
/// The `T` type argument is the type of the return value of the new route,
/// and `TO` is the return value type of the old route.
///
/// To use [popAndPushNamed], a [Navigator.onGenerateRoute] callback must be provided.
- ///
/// {@endtemplate}
///
+ /// {@macro flutter.widgets.navigator.pushNamed.returnValue}
+ ///
/// {@macro flutter.widgets.Navigator.pushNamed}
///
/// {@tool snippet}
@@ -1898,15 +1897,14 @@
/// Ongoing gestures within the current route are canceled when a new route is
/// pushed.
///
- /// Returns a [Future] that completes to the `result` value passed to [pop]
- /// when the pushed route is popped off the navigator.
- ///
/// The `T` type argument is the type of the return value of the new route.
///
/// To use [pushNamedAndRemoveUntil], an [Navigator.onGenerateRoute] callback
/// must be provided.
/// {@endtemplate}
///
+ /// {@macro flutter.widgets.navigator.pushNamed.returnValue}
+ ///
/// {@macro flutter.widgets.Navigator.pushNamed}
///
/// {@tool snippet}
@@ -1982,12 +1980,11 @@
/// Ongoing gestures within the current route are canceled when a new route is
/// pushed.
///
- /// Returns a [Future] that completes to the `result` value passed to [pop]
- /// when the pushed route is popped off the navigator.
- ///
/// The `T` type argument is the type of the return value of the route.
/// {@endtemplate}
///
+ /// {@macro flutter.widgets.navigator.pushNamed.returnValue}
+ ///
/// {@tool snippet}
///
/// Typical usage is as follows:
@@ -2068,13 +2065,12 @@
/// Ongoing gestures within the current route are canceled when a new route is
/// pushed.
///
- /// Returns a [Future] that completes to the `result` value passed to [pop]
- /// when the pushed route is popped off the navigator.
- ///
/// The `T` type argument is the type of the return value of the new route,
/// and `TO` is the type of the return value of the old route.
/// {@endtemplate}
///
+ /// {@macro flutter.widgets.navigator.pushNamed.returnValue}
+ ///
/// {@tool snippet}
///
/// Typical usage is as follows:
@@ -2155,12 +2151,11 @@
/// Ongoing gestures within the current route are canceled when a new route is
/// pushed.
///
- /// Returns a [Future] that completes to the `result` value passed to [pop]
- /// when the pushed route is popped off the navigator.
- ///
/// The `T` type argument is the type of the return value of the new route.
/// {@endtemplate}
///
+ /// {@macro flutter.widgets.navigator.pushNamed.returnValue}
+ ///
/// {@tool snippet}
///
/// Typical usage is as follows:
@@ -4078,6 +4073,8 @@
///
/// {@macro flutter.widgets.navigator.pushNamed}
///
+ /// {@macro flutter.widgets.navigator.pushNamed.returnValue}
+ ///
/// {@macro flutter.widgets.Navigator.pushNamed}
///
/// {@tool snippet}
@@ -4145,6 +4142,8 @@
///
/// {@macro flutter.widgets.navigator.pushReplacementNamed}
///
+ /// {@macro flutter.widgets.navigator.pushNamed.returnValue}
+ ///
/// {@macro flutter.widgets.Navigator.pushNamed}
///
/// {@tool snippet}
@@ -4215,6 +4214,8 @@
///
/// {@macro flutter.widgets.navigator.popAndPushNamed}
///
+ /// {@macro flutter.widgets.navigator.pushNamed.returnValue}
+ ///
/// {@macro flutter.widgets.Navigator.pushNamed}
///
/// {@tool snippet}
@@ -4278,6 +4279,8 @@
///
/// {@macro flutter.widgets.navigator.pushNamedAndRemoveUntil}
///
+ /// {@macro flutter.widgets.navigator.pushNamed.returnValue}
+ ///
/// {@macro flutter.widgets.Navigator.pushNamed}
///
/// {@tool snippet}
@@ -4346,6 +4349,8 @@
///
/// {@macro flutter.widgets.navigator.push}
///
+ /// {@macro flutter.widgets.navigator.pushNamed.returnValue}
+ ///
/// {@tool snippet}
///
/// Typical usage is as follows:
@@ -4493,6 +4498,8 @@
///
/// {@macro flutter.widgets.navigator.pushReplacement}
///
+ /// {@macro flutter.widgets.navigator.pushNamed.returnValue}
+ ///
/// {@tool snippet}
///
/// Typical usage is as follows:
@@ -4578,6 +4585,8 @@
///
/// {@macro flutter.widgets.navigator.pushAndRemoveUntil}
///
+ /// {@macro flutter.widgets.navigator.pushNamed.returnValue}
+ ///
/// {@tool snippet}
///
/// Typical usage is as follows:
