Skip to content

F
Front-End
Unverified Commit c6af38c7 authored by Michael Goderbauer's avatar Michael Goderbauer Committed by GitHub
Browse files
Options

Fix docs re: return value of Navigator's restorable methods (#102595)

parent d6981616
Hide whitespace changes
Inline Side-by-side
Showing with 31 additions and 22 deletions
packages/flutter/lib/src/widgets/navigator.dart
View file @ c6af38c7
...@@ -1531,15 +1531,17 @@ class Navigator extends StatefulWidget { ...@@ -1531,15 +1531,17 @@ class Navigator extends StatefulWidget {
/// Ongoing gestures within the current route are canceled when a new route is /// Ongoing gestures within the current route are canceled when a new route is
/// pushed. /// 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. /// The `T` type argument is the type of the return value of the route.
/// ///
/// To use [pushNamed], an [Navigator.onGenerateRoute] callback must be /// To use [pushNamed], an [Navigator.onGenerateRoute] callback must be
/// provided, /// provided,
/// {@endtemplate} /// {@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} /// {@template flutter.widgets.Navigator.pushNamed}
/// The provided `arguments` are passed to the pushed route via /// The provided `arguments` are passed to the pushed route via
/// [RouteSettings.arguments]. Any object can be passed as `arguments` (e.g. a /// [RouteSettings.arguments]. Any object can be passed as `arguments` (e.g. a
...@@ -1699,9 +1701,6 @@ class Navigator extends StatefulWidget { ...@@ -1699,9 +1701,6 @@ class Navigator extends StatefulWidget {
/// Ongoing gestures within the current route are canceled when a new route is /// Ongoing gestures within the current route are canceled when a new route is
/// pushed. /// 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, /// 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. /// and `TO` is the type of the return value of the old route.
/// ///
...@@ -1709,6 +1708,8 @@ class Navigator extends StatefulWidget { ...@@ -1709,6 +1708,8 @@ class Navigator extends StatefulWidget {
/// be provided. /// be provided.
/// {@endtemplate} /// {@endtemplate}
/// ///
/// {@macro flutter.widgets.navigator.pushNamed.returnValue}
///
/// {@macro flutter.widgets.Navigator.pushNamed} /// {@macro flutter.widgets.Navigator.pushNamed}
/// ///
/// {@tool snippet} /// {@tool snippet}
...@@ -1793,16 +1794,14 @@ class Navigator extends StatefulWidget { ...@@ -1793,16 +1794,14 @@ class Navigator extends StatefulWidget {
/// Ongoing gestures within the current route are canceled when a new route is /// Ongoing gestures within the current route are canceled when a new route is
/// pushed. /// 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, /// 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. /// and `TO` is the return value type of the old route.
/// ///
/// To use [popAndPushNamed], a [Navigator.onGenerateRoute] callback must be provided. /// To use [popAndPushNamed], a [Navigator.onGenerateRoute] callback must be provided.
///
/// {@endtemplate} /// {@endtemplate}
/// ///
/// {@macro flutter.widgets.navigator.pushNamed.returnValue}
///
/// {@macro flutter.widgets.Navigator.pushNamed} /// {@macro flutter.widgets.Navigator.pushNamed}
/// ///
/// {@tool snippet} /// {@tool snippet}
...@@ -1898,15 +1897,14 @@ class Navigator extends StatefulWidget { ...@@ -1898,15 +1897,14 @@ class Navigator extends StatefulWidget {
/// Ongoing gestures within the current route are canceled when a new route is /// Ongoing gestures within the current route are canceled when a new route is
/// pushed. /// 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. /// The `T` type argument is the type of the return value of the new route.
/// ///
/// To use [pushNamedAndRemoveUntil], an [Navigator.onGenerateRoute] callback /// To use [pushNamedAndRemoveUntil], an [Navigator.onGenerateRoute] callback
/// must be provided. /// must be provided.
/// {@endtemplate} /// {@endtemplate}
/// ///
/// {@macro flutter.widgets.navigator.pushNamed.returnValue}
///
/// {@macro flutter.widgets.Navigator.pushNamed} /// {@macro flutter.widgets.Navigator.pushNamed}
/// ///
/// {@tool snippet} /// {@tool snippet}
...@@ -1982,12 +1980,11 @@ class Navigator extends StatefulWidget { ...@@ -1982,12 +1980,11 @@ class Navigator extends StatefulWidget {
/// Ongoing gestures within the current route are canceled when a new route is /// Ongoing gestures within the current route are canceled when a new route is
/// pushed. /// 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. /// The `T` type argument is the type of the return value of the route.
/// {@endtemplate} /// {@endtemplate}
/// ///
/// {@macro flutter.widgets.navigator.pushNamed.returnValue}
///
/// {@tool snippet} /// {@tool snippet}
/// ///
/// Typical usage is as follows: /// Typical usage is as follows:
...@@ -2068,13 +2065,12 @@ class Navigator extends StatefulWidget { ...@@ -2068,13 +2065,12 @@ class Navigator extends StatefulWidget {
/// Ongoing gestures within the current route are canceled when a new route is /// Ongoing gestures within the current route are canceled when a new route is
/// pushed. /// 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, /// 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. /// and `TO` is the type of the return value of the old route.
/// {@endtemplate} /// {@endtemplate}
/// ///
/// {@macro flutter.widgets.navigator.pushNamed.returnValue}
///
/// {@tool snippet} /// {@tool snippet}
/// ///
/// Typical usage is as follows: /// Typical usage is as follows:
...@@ -2155,12 +2151,11 @@ class Navigator extends StatefulWidget { ...@@ -2155,12 +2151,11 @@ class Navigator extends StatefulWidget {
/// Ongoing gestures within the current route are canceled when a new route is /// Ongoing gestures within the current route are canceled when a new route is
/// pushed. /// 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. /// The `T` type argument is the type of the return value of the new route.
/// {@endtemplate} /// {@endtemplate}
/// ///
/// {@macro flutter.widgets.navigator.pushNamed.returnValue}
///
/// {@tool snippet} /// {@tool snippet}
/// ///
/// Typical usage is as follows: /// Typical usage is as follows:
...@@ -4078,6 +4073,8 @@ class NavigatorState extends State<Navigator> with TickerProviderStateMixin, Res ...@@ -4078,6 +4073,8 @@ class NavigatorState extends State<Navigator> with TickerProviderStateMixin, Res
/// ///
/// {@macro flutter.widgets.navigator.pushNamed} /// {@macro flutter.widgets.navigator.pushNamed}
/// ///
/// {@macro flutter.widgets.navigator.pushNamed.returnValue}
///
/// {@macro flutter.widgets.Navigator.pushNamed} /// {@macro flutter.widgets.Navigator.pushNamed}
/// ///
/// {@tool snippet} /// {@tool snippet}
...@@ -4145,6 +4142,8 @@ class NavigatorState extends State<Navigator> with TickerProviderStateMixin, Res ...@@ -4145,6 +4142,8 @@ class NavigatorState extends State<Navigator> with TickerProviderStateMixin, Res
/// ///
/// {@macro flutter.widgets.navigator.pushReplacementNamed} /// {@macro flutter.widgets.navigator.pushReplacementNamed}
/// ///
/// {@macro flutter.widgets.navigator.pushNamed.returnValue}
///
/// {@macro flutter.widgets.Navigator.pushNamed} /// {@macro flutter.widgets.Navigator.pushNamed}
/// ///
/// {@tool snippet} /// {@tool snippet}
...@@ -4215,6 +4214,8 @@ class NavigatorState extends State<Navigator> with TickerProviderStateMixin, Res ...@@ -4215,6 +4214,8 @@ class NavigatorState extends State<Navigator> with TickerProviderStateMixin, Res
/// ///
/// {@macro flutter.widgets.navigator.popAndPushNamed} /// {@macro flutter.widgets.navigator.popAndPushNamed}
/// ///
/// {@macro flutter.widgets.navigator.pushNamed.returnValue}
///
/// {@macro flutter.widgets.Navigator.pushNamed} /// {@macro flutter.widgets.Navigator.pushNamed}
/// ///
/// {@tool snippet} /// {@tool snippet}
...@@ -4278,6 +4279,8 @@ class NavigatorState extends State<Navigator> with TickerProviderStateMixin, Res ...@@ -4278,6 +4279,8 @@ class NavigatorState extends State<Navigator> with TickerProviderStateMixin, Res
/// ///
/// {@macro flutter.widgets.navigator.pushNamedAndRemoveUntil} /// {@macro flutter.widgets.navigator.pushNamedAndRemoveUntil}
/// ///
/// {@macro flutter.widgets.navigator.pushNamed.returnValue}
///
/// {@macro flutter.widgets.Navigator.pushNamed} /// {@macro flutter.widgets.Navigator.pushNamed}
/// ///
/// {@tool snippet} /// {@tool snippet}
...@@ -4346,6 +4349,8 @@ class NavigatorState extends State<Navigator> with TickerProviderStateMixin, Res ...@@ -4346,6 +4349,8 @@ class NavigatorState extends State<Navigator> with TickerProviderStateMixin, Res
/// ///
/// {@macro flutter.widgets.navigator.push} /// {@macro flutter.widgets.navigator.push}
/// ///
/// {@macro flutter.widgets.navigator.pushNamed.returnValue}
///
/// {@tool snippet} /// {@tool snippet}
/// ///
/// Typical usage is as follows: /// Typical usage is as follows:
...@@ -4493,6 +4498,8 @@ class NavigatorState extends State<Navigator> with TickerProviderStateMixin, Res ...@@ -4493,6 +4498,8 @@ class NavigatorState extends State<Navigator> with TickerProviderStateMixin, Res
/// ///
/// {@macro flutter.widgets.navigator.pushReplacement} /// {@macro flutter.widgets.navigator.pushReplacement}
/// ///
/// {@macro flutter.widgets.navigator.pushNamed.returnValue}
///
/// {@tool snippet} /// {@tool snippet}
/// ///
/// Typical usage is as follows: /// Typical usage is as follows:
...@@ -4578,6 +4585,8 @@ class NavigatorState extends State<Navigator> with TickerProviderStateMixin, Res ...@@ -4578,6 +4585,8 @@ class NavigatorState extends State<Navigator> with TickerProviderStateMixin, Res
/// ///
/// {@macro flutter.widgets.navigator.pushAndRemoveUntil} /// {@macro flutter.widgets.navigator.pushAndRemoveUntil}
/// ///
/// {@macro flutter.widgets.navigator.pushNamed.returnValue}
///
/// {@tool snippet} /// {@tool snippet}
/// ///
/// Typical usage is as follows: /// Typical usage is as follows:
......
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

HIAST - GitLab