Skip to content

Commit

Permalink
Added and updated comments
Browse files Browse the repository at this point in the history
  • Loading branch information
d3fkn1ght committed Mar 10, 2020
1 parent f06761e commit 9f73977
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 12 deletions.
2 changes: 1 addition & 1 deletion Source/Prism/Events/BackgroundEventSubscription.cs
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ public BackgroundEventSubscription(IDelegateReference actionReference, IDelegate
}

/// <summary>
/// Invokes the specified <see cref="System.Action{TPayload}"/> in an asynchronous thread by using a <see cref="ThreadPool"/>.
/// Invokes the specified <see cref="System.Action{TPayload}"/> in an asynchronous thread by using a <see cref="System.Threading.ThreadPool"/>.
/// </summary>
/// <param name="action">The action to execute.</param>
/// <param name="argument">The payload to pass <paramref name="action"/> while invoking it.</param>
Expand Down
2 changes: 1 addition & 1 deletion Source/Prism/Events/EventSubscription.cs
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public Action Action
/// <remarks>
/// If <see cref="Action"/>is no longer valid because it was
/// garbage collected, this method will return <see langword="null" />.
/// Otherwise it will return a delegate that evaluates the <see cref="Filter"/> and if it
/// Otherwise it will return a delegate that evaluates the <see cref="EventSubscription{TPayload}.Filter"/> and if it
/// returns <see langword="true" /> will then call <see cref="InvokeAction"/>. The returned
/// delegate holds a hard reference to the <see cref="Action"/> target
/// <see cref="Delegate">delegates</see>. As long as the returned delegate is not garbage collected,
Expand Down
6 changes: 3 additions & 3 deletions Source/Xamarin/Prism.Forms/Navigation/INavigationService.cs
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ public interface INavigationService
/// Initiates navigation to the target specified by the <paramref name="uri"/>.
/// </summary>
/// <param name="uri">The Uri to navigate to</param>
/// <remarks>Navigation parameters can be provided in the Uri and by using the <paramref name="parameters"/>.</remarks>
/// <remarks>Navigation parameters can be provided in the Uri and by using the <paramf name="parameters"/>.</remarks>
/// <example>
/// Navigate(new Uri("MainPage?id=3&name=brian", UriKind.RelativeSource), parameters);
/// Navigate(new Uri("MainPage?id=3&amp;name=brian", UriKind.RelativeSource), parameters);
/// </example>
Task<INavigationResult> NavigateAsync(Uri uri);

Expand All @@ -39,7 +39,7 @@ public interface INavigationService
/// <param name="parameters">The navigation parameters</param>
/// <remarks>Navigation parameters can be provided in the Uri and by using the <paramref name="parameters"/>.</remarks>
/// <example>
/// Navigate(new Uri("MainPage?id=3&name=brian", UriKind.RelativeSource), parameters);
/// Navigate(new Uri("MainPage?id=3&amp;name=brian", UriKind.RelativeSource), parameters);
/// </example>
Task<INavigationResult> NavigateAsync(Uri uri, INavigationParameters parameters);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public static Task<INavigationResult> NavigateAsync(this INavigationService navi
/// <returns><see cref="INavigationResult"/> indicating whether the request was successful or if there was an encountered <see cref="Exception"/>.</returns>
/// <remarks>Navigation parameters can be provided in the Uri and by using the <paramref name="parameters"/>.</remarks>
/// <example>
/// NavigateAsync(new Uri("MainPage?id=3&name=brian", UriKind.RelativeSource), parameters);
/// NavigateAsync(new Uri("MainPage?id=3&amp;name=brian", UriKind.RelativeSource), parameters);
/// </example>
public static Task<INavigationResult> NavigateAsync(this INavigationService navigationService, Uri uri, INavigationParameters parameters = null, bool? useModalNavigation = null, bool animated = true)
{
Expand Down Expand Up @@ -102,7 +102,7 @@ public static Task<INavigationResult> GoBackAsync(this INavigationService naviga
/// <returns><see cref="INavigationResult"/> indicating whether the request was successful or if there was an encountered <see cref="Exception"/>.</returns>
/// <remarks>Navigation parameters can be provided in the Uri and by using the <paramref name="parameters"/>.</remarks>
/// <example>
/// NavigateAsync("MainPage?id=3&name=dan", ("person", person), ("foo", bar));
/// NavigateAsync("MainPage?id=3&amp;name=dan", ("person", person), ("foo", bar));
/// </example>
public static Task<INavigationResult> NavigateAsync(this INavigationService navigationService, string name, params (string Key, object Value)[] parameters)
{
Expand All @@ -117,7 +117,7 @@ public static Task<INavigationResult> NavigateAsync(this INavigationService navi
/// <returns><see cref="INavigationResult"/> indicating whether the request was successful or if there was an encountered <see cref="Exception"/>.</returns>
/// <remarks>Navigation parameters can be provided in the Uri and by using the <paramref name="parameters"/>.</remarks>
/// <example>
/// NavigateAsync(new Uri("MainPage?id=3&name=dan", UriKind.RelativeSource), ("person", person), ("foo", bar));
/// NavigateAsync(new Uri("MainPage?id=3&amp;name=dan", UriKind.RelativeSource), ("person", person), ("foo", bar));
/// </example>
public static Task<INavigationResult> NavigateAsync(this INavigationService navigationService, Uri uri, params (string Key, object Value)[] parameters)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -263,9 +263,8 @@ protected virtual Task<INavigationResult> NavigateInternal(string name, INavigat
/// Initiates navigation to the target specified by the <paramref name="uri"/>.
/// </summary>
/// <param name="uri">The Uri to navigate to</param>
/// <remarks>Navigation parameters can be provided in the Uri and by using the <paramref name="parameters"/>.</remarks>
/// <example>
/// Navigate(new Uri("MainPage?id=3&name=brian", UriKind.RelativeSource), parameters);
/// NavigateAsync(new Uri("MainPage?id=3&amp;name=brian", UriKind.RelativeSource));
/// </example>
public virtual Task<INavigationResult> NavigateAsync(Uri uri)
{
Expand All @@ -279,7 +278,7 @@ public virtual Task<INavigationResult> NavigateAsync(Uri uri)
/// <param name="parameters">The navigation parameters</param>
/// <remarks>Navigation parameters can be provided in the Uri and by using the <paramref name="parameters"/>.</remarks>
/// <example>
/// Navigate(new Uri("MainPage?id=3&name=brian", UriKind.RelativeSource), parameters);
/// Navigate(new Uri("MainPage?id=3&amp;name=brian", UriKind.RelativeSource), parameters);
/// </example>
public virtual Task<INavigationResult> NavigateAsync(Uri uri, INavigationParameters parameters)
{
Expand All @@ -300,7 +299,7 @@ Task<INavigationResult> IPlatformNavigationService.NavigateAsync(Uri uri, INavig
/// <param name="animated">If <c>true</c> the transition is animated, if <c>false</c> there is no animation on transition.</param>
/// <remarks>Navigation parameters can be provided in the Uri and by using the <paramref name="parameters"/>.</remarks>
/// <example>
/// Navigate(new Uri("MainPage?id=3&name=brian", UriKind.RelativeSource), parameters);
/// Navigate(new Uri("MainPage?id=3&amp;name=brian", UriKind.RelativeSource), parameters);
/// </example>
protected async virtual Task<INavigationResult> NavigateInternal(Uri uri, INavigationParameters parameters, bool? useModalNavigation, bool animated)
{
Expand Down

0 comments on commit 9f73977

Please sign in to comment.