diff --git a/src/Forms/Prism.Forms/Navigation/INavigationResult.cs b/src/Forms/Prism.Forms/Navigation/INavigationResult.cs index d3cf8dfb9e..1e13b93e5b 100644 --- a/src/Forms/Prism.Forms/Navigation/INavigationResult.cs +++ b/src/Forms/Prism.Forms/Navigation/INavigationResult.cs @@ -3,7 +3,7 @@ namespace Prism.Navigation { /// - /// Provides navigation results indicating whether the navigation was successful or if there was an encountered . + /// PProvides navigation results indicating if the navigation was successful and any exceptions caught. /// public interface INavigationResult { diff --git a/src/Forms/Prism.Forms/Navigation/INavigationService.cs b/src/Forms/Prism.Forms/Navigation/INavigationService.cs index bbdd3d0089..8fba6e4261 100644 --- a/src/Forms/Prism.Forms/Navigation/INavigationService.cs +++ b/src/Forms/Prism.Forms/Navigation/INavigationService.cs @@ -12,14 +12,14 @@ public interface INavigationService /// /// Navigates to the most recent entry in the back navigation history by popping the calling Page off the navigation stack. /// - /// indicating whether the request was successful or if there was an encountered . + /// indicating whether the request was successful and any encountered . Task GoBackAsync(); /// /// Navigates to the most recent entry in the back navigation history by popping the calling Page off the navigation stack. /// /// The navigation parameters - /// indicating whether the request was successful or if there was an encountered . + /// indicating whether the request was successful and any encountered . Task GoBackAsync(INavigationParameters parameters); /// @@ -28,14 +28,14 @@ public interface INavigationService /// The navigation parameters /// If true uses PopModalAsync, if false uses PopAsync /// If true the transition is animated, if false there is no animation on transition. - /// indicating whether the request was successful or if there was an encountered . + /// indicating whether the request was successful and any encountered . Task GoBackAsync(INavigationParameters parameters, bool? useModalNavigation, bool animated); /// /// When navigating inside a NavigationPage: Pops all but the root Page off the navigation stack /// /// The navigation parameters - /// indicating whether the request was successful or if there was an encountered . + /// indicating whether the request was successful and any encountered . /// Only works when called from a View within a NavigationPage Task GoBackToRootAsync(INavigationParameters parameters); @@ -79,7 +79,7 @@ public interface INavigationService /// The navigation parameters /// If true uses PushModalAsync, if false uses PushAsync /// If true the transition is animated, if false there is no animation on transition. - /// indicating whether the request was successful or if there was an encountered . + /// indicating whether the request was successful and any encountered . Task NavigateAsync(string name, INavigationParameters parameters, bool? useModalNavigation, bool animated); /// @@ -89,7 +89,7 @@ public interface INavigationService /// The navigation parameters /// If true uses PopModalAsync, if false uses PopAsync /// If true the transition is animated, if false there is no animation on transition. - /// indicating whether the request was successful or if there was an encountered . + /// indicating whether the request was successful and any encountered . /// Navigation parameters can be provided in the Uri and by using the . /// /// NavigateAsync(new Uri("MainPage?id=3&name=brian", UriKind.RelativeSource), parameters); diff --git a/src/Forms/Prism.Forms/Navigation/INavigationServiceExtensions.cs b/src/Forms/Prism.Forms/Navigation/INavigationServiceExtensions.cs index 377280317f..abac646170 100644 --- a/src/Forms/Prism.Forms/Navigation/INavigationServiceExtensions.cs +++ b/src/Forms/Prism.Forms/Navigation/INavigationServiceExtensions.cs @@ -32,7 +32,7 @@ public static void OnNavigationError(this Task navigationTask /// /// The INavigationService instance /// The navigation parameters - /// indicating whether the request was successful or if there was an encountered . + /// indicating whether the request was successful and any encountered . /// Only works when called from a View within a NavigationPage public static Task GoBackToRootAsync(this INavigationService navigationService, INavigationParameters parameters = null) { @@ -66,7 +66,7 @@ public static string GetNavigationUriPath(this INavigationService navigationServ /// The navigation parameters /// If true uses PopModalAsync, if false uses PopAsync /// If true the transition is animated, if false there is no animation on transition. - /// indicating whether the request was successful or if there was an encountered . + /// indicating whether the request was successful and any encountered . public static Task GoBackAsync(this INavigationService navigationService, INavigationParameters parameters = null, bool? useModalNavigation = null, bool animated = true) { return navigationService.GoBackAsync(parameters, useModalNavigation, animated); @@ -80,7 +80,7 @@ public static Task GoBackAsync(this INavigationService naviga /// The navigation parameters /// If true uses PushModalAsync, if false uses PushAsync /// If true the transition is animated, if false there is no animation on transition. - /// indicating whether the request was successful or if there was an encountered . + /// indicating whether the request was successful and any encountered . public static Task NavigateAsync(this INavigationService navigationService, string name, INavigationParameters parameters = null, bool? useModalNavigation = null, bool animated = true) { return navigationService.NavigateAsync(name, parameters, useModalNavigation, animated); @@ -91,7 +91,7 @@ public static Task NavigateAsync(this INavigationService navi /// /// Service for handling navigation between views /// The navigation parameters - /// indicating whether the request was successful or if there was an encountered . + /// indicating whether the request was successful and any encountered . public static Task GoBackAsync(this INavigationService navigationService, params (string Key, object Value)[] parameters) { return navigationService.GoBackAsync(GetNavigationParameters(parameters)); @@ -103,7 +103,7 @@ public static Task GoBackAsync(this INavigationService naviga /// Service for handling navigation between views /// The Uri to navigate to /// The navigation parameters - /// indicating whether the request was successful or if there was an encountered . + /// indicating whether the request was successful and any encountered . /// Navigation parameters can be provided in the Uri and by using the . /// /// NavigateAsync("MainPage?id=3&name=dan", ("person", person), ("foo", bar)); @@ -121,7 +121,7 @@ public static Task NavigateAsync(this INavigationService navi /// The navigation parameters /// If true uses PopModalAsync, if false uses PopAsync /// If true the transition is animated, if false there is no animation on transition. - /// indicating whether the request was successful or if there was an encountered . + /// indicating whether the request was successful and any encountered . /// Navigation parameters can be provided in the Uri and by using the . /// /// NavigateAsync(new Uri("MainPage?id=3&name=brian", UriKind.RelativeSource), parameters); @@ -137,7 +137,7 @@ public static Task NavigateAsync(this INavigationService navi /// Service for handling navigation between views /// The Uri to navigate to /// The navigation parameters - /// indicating whether the request was successful or if there was an encountered . + /// indicating whether the request was successful and any encountered . /// Navigation parameters can be provided in the Uri and by using the . /// /// NavigateAsync(new Uri("MainPage?id=3&name=dan", UriKind.RelativeSource), ("person", person), ("foo", bar)); diff --git a/src/Forms/Prism.Forms/Navigation/PageNavigationService.cs b/src/Forms/Prism.Forms/Navigation/PageNavigationService.cs index 86ea65b0a5..1d19f942f0 100644 --- a/src/Forms/Prism.Forms/Navigation/PageNavigationService.cs +++ b/src/Forms/Prism.Forms/Navigation/PageNavigationService.cs @@ -71,7 +71,7 @@ public virtual Task GoBackAsync(INavigationParameters paramet /// The navigation parameters /// If true uses PopModalAsync, if false uses PopAsync /// If true the transition is animated, if false there is no animation on transition. - /// indicating whether the request was successful or if there was an encountered . + /// indicating whether the request was successful and any encountered . public virtual Task GoBackAsync(INavigationParameters parameters, bool? useModalNavigation, bool animated) { return GoBackInternal(parameters, useModalNavigation, animated); @@ -182,7 +182,7 @@ private static bool IsMainPage(Page currentPage, Page mainPage) /// When navigating inside a NavigationPage: Pops all but the root Page off the navigation stack /// /// The navigation parameters - /// indicating whether the request was successful or if there was an encountered . + /// indicating whether the request was successful and any encountered . /// Only works when called from a View within a NavigationPage public virtual Task GoBackToRootAsync(INavigationParameters parameters) { @@ -264,7 +264,7 @@ public virtual Task NavigateAsync(string name, INavigationPar /// The navigation parameters /// If true uses PushModalAsync, if false uses PushAsync /// If true the transition is animated, if false there is no animation on transition. - /// indicating whether the request was successful or if there was an encountered . + /// indicating whether the request was successful and any encountered . public Task NavigateAsync(string name, INavigationParameters parameters, bool? useModalNavigation, bool animated) { return NavigateInternal(name, parameters, useModalNavigation, animated); @@ -318,7 +318,7 @@ public virtual Task NavigateAsync(Uri uri, INavigationParamet /// The navigation parameters /// If true uses PopModalAsync, if false uses PopAsync /// If true the transition is animated, if false there is no animation on transition. - /// indicating whether the request was successful or if there was an encountered . + /// indicating whether the request was successful and any encountered . /// Navigation parameters can be provided in the Uri and by using the . /// /// NavigateAsync(new Uri("MainPage?id=3&name=brian", UriKind.RelativeSource), parameters);