Skip to content

Commit

Permalink
Merge pull request #2356 from multinerd/master
Browse files Browse the repository at this point in the history
Fixed a bunch of typos
  • Loading branch information
dansiegel authored Feb 25, 2021
2 parents f8230bf + 7ff1d31 commit 9ab5752
Show file tree
Hide file tree
Showing 67 changed files with 116 additions and 112 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public static IContainerRegistry RegisterRegionServices(this IContainerRegistry
configureAdapters?.Invoke(regionAdapterMappings);
regionAdapterMappings.RegisterDefaultMapping<CarouselView, CarouselViewRegionAdapter>();
// TODO: CollectionView is buggy with only last View showing dispite multiple Active Views
// TODO: CollectionView is buggy with only last View showing despite multiple Active Views
// BUG: iOS Crash with CollectionView https://github.com/xamarin/Xamarin.Forms/issues/9970
//regionAdapterMappings.RegisterDefaultMapping<CollectionView, CollectionViewRegionAdapter>();
regionAdapterMappings.RegisterDefaultMapping<Layout<View>, LayoutViewRegionAdapter>();
Expand Down
2 changes: 1 addition & 1 deletion src/Forms/Prism.Forms.Regions/Regions/AllActiveRegion.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ public class AllActiveRegion : Region
public override IViewsCollection ActiveViews => Views;

/// <summary>
/// Deactive is not valid in this Region. This method will always throw <see cref="InvalidOperationException"/>.
/// Deactivate is not valid in this Region. This method will always throw <see cref="InvalidOperationException"/>.
/// </summary>
/// <param name="view">The view to deactivate.</param>
/// <exception cref="InvalidOperationException">Every time this method is called.</exception>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
namespace Prism.Regions.Behaviors
{
/// <summary>
/// Provides a Behavior to Destory the View/ViewModel when the View is removed from the Region's Views
/// Provides a Behavior to Destroy the View/ViewModel when the View is removed from the Region's Views
/// </summary>
public class DestructibleRegionBehavior : RegionBehavior
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ void AddIfMissing<TBehavior>(string behaviorKey)
bool ContainsKey(string behaviorKey);

/// <summary>
/// Creates an instance of the Behaviortype that's registered using the specified key.
/// Creates an instance of the BehaviorType that's registered using the specified key.
/// </summary>
/// <param name="key">The key that's used to register a behavior type.</param>
/// <returns>The created behavior. </returns>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ namespace Prism.Regions
internal class DefaultRegionManagerAccessor : IRegionManagerAccessor
{
/// <summary>
/// Notification used by attached behaviors to update the region managers appropriatelly if needed to.
/// Notification used by attached behaviors to update the region managers appropriately if needed to.
/// </summary>
/// <remarks>This event uses weak references to the event handler to prevent this static event of keeping the
/// target element longer than expected.</remarks>
Expand Down
4 changes: 2 additions & 2 deletions src/Forms/Prism.Forms.Regions/Regions/IRegion.cs
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ public interface IRegion : INotifyPropertyChanged
object Context { get; set; }

/// <summary>
/// Gets the name of the region that uniequely identifies the region within a <see cref="IRegionManager"/>.
/// Gets the name of the region that uniquely identifies the region within a <see cref="IRegionManager"/>.
/// </summary>
/// <value>The name of the region.</value>
string Name { get; set; }
Expand Down Expand Up @@ -84,7 +84,7 @@ public interface IRegion : INotifyPropertyChanged
/// </summary>
/// <value>The <see cref="IRegionManager"/> where this <see cref="IRegion"/> is registered.</value>
/// <remarks>This is usually used by implementations of <see cref="IRegionManager"/> and should not be
/// used by the developer explicitely.</remarks>
/// used by the developer explicitly.</remarks>
IRegionManager RegionManager { get; set; }

/// <summary>
Expand Down
4 changes: 2 additions & 2 deletions src/Forms/Prism.Forms.Regions/Regions/IRegionCollection.cs
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,10 @@ public interface IRegionCollection : IEnumerable<IRegion>, INotifyCollectionChan
bool ContainsRegionWithName(string regionName);

/// <summary>
/// Adds a region to the regionmanager with the name received as argument.
/// Adds a region to the <see cref="RegionManager"/> with the name received as argument.
/// </summary>
/// <param name="regionName">The name to be given to the region.</param>
/// <param name="region">The region to be added to the regionmanager.</param>
/// <param name="region">The region to be added to the <see cref="RegionManager"/>.</param>
/// <exception cref="ArgumentNullException">Thrown if <paramref name="region"/> is <see langword="null"/>.</exception>
/// <exception cref="ArgumentException">Thrown if <paramref name="regionName"/> and <paramref name="region"/>'s name do not match and the <paramref name="region"/> <see cref="IRegion.Name"/> is not <see langword="null"/>.</exception>
void Add(string regionName, IRegion region);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace Prism.Regions
public interface IRegionManagerAccessor
{
/// <summary>
/// Notification used by attached behaviors to update the region managers appropriatelly if needed to.
/// Notification used by attached behaviors to update the region managers appropriately if needed to.
/// </summary>
/// <remarks>This event uses weak references to the event handler to prevent this static event of keeping the
/// target element longer than expected.</remarks>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
public interface IJournalAware
{
/// <summary>
/// Determines if the current obect is going to be added to the navigation journal's backstack.
/// Determines if the current object is going to be added to the navigation journal's backstack.
/// </summary>
/// <returns>True, add to backstack. False, remove from backstack.</returns>
bool PersistInHistory();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ protected virtual string GetContractFromNavigationContext(INavigationContext nav
}

/// <summary>
/// Returns the set of candidates that may satisfiy this navigation request.
/// Returns the set of candidates that may satisfy this navigation request.
/// </summary>
/// <param name="region">The region containing items that may satisfy the navigation request.</param>
/// <param name="candidateNavigationContract">The candidate navigation target as determined by <see cref="GetContractFromNavigationContext"/></param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -214,12 +214,12 @@ private void ExecuteNavigation(INavigationContext navigationContext, object[] ac

var view = (VisualElement)_regionNavigationContentLoader.LoadContent(Region, navigationContext);

// Raise the navigating event just before activing the view.
// Raise the navigating event just before activating the view.
RaiseNavigating(navigationContext);

Region.Activate(view);

// Update the navigation journal before notifying others of navigaton
// Update the navigation journal before notifying others of navigation
IRegionNavigationJournalEntry journalEntry = _container.Resolve<IRegionNavigationJournalEntry>();
journalEntry.Uri = navigationContext.Uri;
journalEntry.Parameters = navigationContext.Parameters;
Expand Down
4 changes: 2 additions & 2 deletions src/Forms/Prism.Forms.Regions/Regions/Region.cs
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ public object Context

private string _name;
/// <summary>
/// Gets the name of the region that uniequely identifies the region within a <see cref="IRegionManager"/>.
/// Gets the name of the region that uniquely identifies the region within a <see cref="IRegionManager"/>.
/// </summary>
/// <value>The name of the region.</value>
public string Name
Expand Down Expand Up @@ -154,7 +154,7 @@ public Comparison<VisualElement> SortComparison
/// </summary>
/// <value>The <see cref="IRegionManager"/> where this <see cref="IRegion"/> is registered.</value>
/// <remarks>This is usually used by implementations of <see cref="IRegionManager"/> and should not be
/// used by the developer explicitely.</remarks>
/// used by the developer explicitly.</remarks>
public IRegionManager RegionManager
{
get => _regionManager;
Expand Down
4 changes: 2 additions & 2 deletions src/Forms/Prism.Forms.Regions/Regions/RegionCollection.cs
Original file line number Diff line number Diff line change
Expand Up @@ -98,10 +98,10 @@ public bool ContainsRegionWithName(string regionName)
}

/// <summary>
/// Adds a region to the regionmanager with the name received as argument.
/// Adds a region to the <see cref="RegionManager"/> with the name received as argument.
/// </summary>
/// <param name="regionName">The name to be given to the region.</param>
/// <param name="region">The region to be added to the regionmanager.</param>
/// <param name="region">The region to be added to the <see cref="RegionManager"/>.</param>
/// <exception cref="ArgumentNullException">Thrown if <paramref name="region"/> is <see langword="null"/>.</exception>
/// <exception cref="ArgumentException">Thrown if <paramref name="regionName"/> and <paramref name="region"/>'s name do not match and the <paramref name="region"/> <see cref="IRegion.Name"/> is not <see langword="null"/>.</exception>
public void Add(string regionName, IRegion region)
Expand Down
2 changes: 1 addition & 1 deletion src/Forms/Prism.Forms.Regions/Regions/RegionContext.cs
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public static class RegionContext
/// notify when the value is set for the first time.
/// </summary>
/// <param name="view">Any view that hold the RegionContext value. </param>
/// <returns>Wrapper around the Regioncontext value. </returns>
/// <returns>Wrapper around the <see cref="RegionContext"/> value. </returns>
public static ObservableObject<object> GetObservableContext(VisualElement view)
{
if (view == null)
Expand Down
2 changes: 1 addition & 1 deletion src/Forms/Prism.Forms.Regions/Regions/ViewsCollection.cs
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ private void RemoveAllMetadataMonitors()
}

/// <summary>
/// Adds handler to monitor the MetadatItem and adds it to our monitoring list.
/// Adds handler to monitor the MetadataItem and adds it to our monitoring list.
/// </summary>
/// <param name="itemMetadata"></param>
/// <param name="isInList"></param>
Expand Down
4 changes: 2 additions & 2 deletions src/Forms/Prism.Forms.Regions/Regions/Xaml/RegionManager.cs
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ public static void SetRegionContext(VisualElement target, object value)
}

/// <summary>
/// Notification used by attached behaviors to update the region managers appropriatelly if needed to.
/// Notification used by attached behaviors to update the region managers appropriately if needed to.
/// </summary>
/// <remarks>This event uses weak references to the event handler to prevent this static event of keeping the
/// target element longer than expected.</remarks>
Expand All @@ -193,7 +193,7 @@ public static event EventHandler UpdatingRegions
}

/// <summary>
/// Notifies attached behaviors to update the region managers appropriatelly if needed to.
/// Notifies attached behaviors to update the region managers appropriately if needed to.
/// </summary>
/// <remarks>
/// This method is normally called internally, and there is usually no need to call this from user code.
Expand Down
2 changes: 1 addition & 1 deletion src/Forms/Prism.Forms/Behaviors/EventToCommandBehavior.cs
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ public string EventArgsParameterPath
}

/// <summary>
/// Name of the event that will be forwared to <see cref="Command" />
/// Name of the event that will be forwarded to <see cref="Command" />
/// </summary>
/// <remarks>
/// An event that is invalid for the attached <see cref="View" /> will result in <see cref="ArgumentException" /> thrown.
Expand Down
2 changes: 1 addition & 1 deletion src/Forms/Prism.Forms/Ioc/ContainerProvider.cs
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
/// }
/// }
/// </code>
/// We can then simply use our ValueConveter or other class directly in XAML
/// We can then simply use our ValueConverter or other class directly in XAML
/// <![CDATA[
/// <ContentPage xmlns:prism="clr-namespace:Prism.Ioc;assembly=Prism.Forms">
/// <ContentPage.Resources>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public interface INavigationParametersInternal
void Add(string key, object value);

/// <summary>
/// Checks collection for presense of key
/// Checks collection for presence of key
/// </summary>
/// <param name="key">The key to check in the Collection</param>
/// <returns><c>true</c> if key exists; else returns <c>false</c>.</returns>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ public static void OnNavigationError(this Task<INavigationResult> navigationTask
/// <summary>
/// When navigating inside a NavigationPage: Pops all but the root Page off the navigation stack
/// </summary>
/// <param name="navigationService">The INavigatinService instance</param>
/// <param name="navigationService">The INavigationService instance</param>
/// <param name="parameters">The navigation parameters</param>
/// <returns><see cref="INavigationResult"/> indicating whether the request was successful or if there was an encountered <see cref="Exception"/>.</returns>
/// <remarks>Only works when called from a View within a NavigationPage</remarks>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ public static class KnownNavigationParameters
public const string CreateTab = "createTab";

/// <summary>
/// Used to select an existing Tab when navigating to a Tabbedpage.
/// Used to select an existing Tab when navigating to a TabbedPage.
/// </summary>
public const string SelectedTab = "selectedTab";

Expand Down
16 changes: 11 additions & 5 deletions src/Forms/Prism.Forms/Navigation/PageNavigationService.cs
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,7 @@ protected async virtual Task<INavigationResult> NavigateInternal(Uri uri, INavig
/// Processes the Navigation for the Queued navigation segments
/// </summary>
/// <param name="currentPage">The Current <see cref="Page"/> that we are navigating from.</param>
/// <param name="segments">The Navigation <see cref="Uri"/> segmenets.</param>
/// <param name="segments">The Navigation <see cref="Uri"/> segments.</param>
/// <param name="parameters">The <see cref="INavigationParameters"/>.</param>
/// <param name="useModalNavigation"><see cref="Nullable{Boolean}"/> flag if we should force Modal Navigation.</param>
/// <param name="animated">If <c>true</c>, the navigation will be animated.</param>
Expand Down Expand Up @@ -496,7 +496,13 @@ private static void RemovePagesFromNavigationPage(Page currentPage, List<Page> p
}
}

[Obsolete("Renamed to 'ProcessNavigationForAbsoluteUri'")]
protected virtual Task ProcessNavigationForAbsoulteUri(Queue<string> segments, INavigationParameters parameters, bool? useModalNavigation, bool animated)
{
return ProcessNavigationForAbsoluteUri(segments, parameters, useModalNavigation, animated);
}

protected virtual Task ProcessNavigationForAbsoluteUri(Queue<string> segments, INavigationParameters parameters, bool? useModalNavigation, bool animated)
{
return ProcessNavigation(null, segments, parameters, useModalNavigation, animated);
}
Expand Down Expand Up @@ -904,13 +910,13 @@ void ConfigureTabbedPage(TabbedPage tabbedPage, string segment)
foreach (var tabToCreate in tabsToCreate)
{
//created tab can be a single view or a view nested in a NavigationPage with the syntax "NavigationPage|ViewToCreate"
var tabSegements = tabToCreate.Split('|');
if (tabSegements.Length > 1)
var tabSegments = tabToCreate.Split('|');
if (tabSegments.Length > 1)
{
var navigationPage = CreatePageFromSegment(tabSegements[0]) as NavigationPage;
var navigationPage = CreatePageFromSegment(tabSegments[0]) as NavigationPage;
if (navigationPage != null)
{
var navigationPageChild = CreatePageFromSegment(tabSegements[1]);
var navigationPageChild = CreatePageFromSegment(tabSegments[1]);

navigationPage.PushAsync(navigationPageChild);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public interface IPageDialogService
Task DisplayAlertAsync(string title, string message, string cancelButton, FlowDirection flowDirection);

/// <summary>
/// Displays a native platform action sheet, allowing the application user to choose from serveral buttons.
/// Displays a native platform action sheet, allowing the application user to choose from several buttons.
/// </summary>
/// <param name="title">Title to display in view.</param>
/// <param name="cancelButton">Text for the cancel button.</param>
Expand All @@ -71,7 +71,7 @@ public interface IPageDialogService
Task<string> DisplayActionSheetAsync(string title, string cancelButton, string destroyButton, params string[] otherButtons);

/// <summary>
/// Displays a native platform action sheet, allowing the application user to choose from serveral buttons.
/// Displays a native platform action sheet, allowing the application user to choose from several buttons.
/// </summary>
/// <param name="title">Title to display in view.</param>
/// <param name="cancelButton">Text for the cancel button.</param>
Expand All @@ -82,7 +82,7 @@ public interface IPageDialogService
Task<string> DisplayActionSheetAsync(string title, string cancelButton, string destroyButton, FlowDirection flowDirection, params string[] otherButtons);

/// <summary>
/// Displays a native platform action sheet, allowing the application user to choose from serveral buttons.
/// Displays a native platform action sheet, allowing the application user to choose from several buttons.
/// </summary>
/// <para>
/// The text displayed in the action sheet will be the value for <see cref="IActionSheetButton.Text"/> and when pressed
Expand All @@ -94,7 +94,7 @@ public interface IPageDialogService
Task DisplayActionSheetAsync(string title, params IActionSheetButton[] buttons);

/// <summary>
/// Displays a native platform action sheet, allowing the application user to choose from serveral buttons.
/// Displays a native platform action sheet, allowing the application user to choose from several buttons.
/// </summary>
/// <para>
/// The text displayed in the action sheet will be the value for <see cref="IActionSheetButton.Text"/> and when pressed
Expand All @@ -107,7 +107,7 @@ public interface IPageDialogService
Task DisplayActionSheetAsync(string title, FlowDirection flowDirection, params IActionSheetButton[] buttons);

/// <summary>
/// Displays a native platform promt, allowing the application user to enter a string.
/// Displays a native platform prompt, allowing the application user to enter a string.
/// </summary>
/// <param name="title">Title to display</param>
/// <param name="message">Message to display</param>
Expand Down
Loading

0 comments on commit 9ab5752

Please sign in to comment.