From 2eb175ec6f526819d382e7a5f0aec950bc478e0e Mon Sep 17 00:00:00 2001 From: Geoffrey Dudics Date: Thu, 16 Apr 2020 23:50:10 -0400 Subject: [PATCH 01/16] Fixed some CS1572, 1573, 1574 and 1591 warnings --- .../INavigationServiceExtensions.cs | 6 ++ .../Navigation/PageNavigationService.cs | 1 - .../INavigationServiceExtensions.cs | 1 + .../Prism.Unity.Forms/PrismApplication.cs | 3 + src/Prism.Core/Common/ParametersBase.cs | 62 ++++++++++++++++++- src/Prism.Core/Modularity/IModuleInfo.cs | 25 +++++++- src/Prism.Core/Modularity/IModuleInfoGroup.cs | 10 +++ .../Legacy/DryIocExtensions.cs | 1 + 8 files changed, 106 insertions(+), 3 deletions(-) diff --git a/src/Forms/Prism.Forms/Navigation/INavigationServiceExtensions.cs b/src/Forms/Prism.Forms/Navigation/INavigationServiceExtensions.cs index 547c67fdf4..bb07b0fe66 100644 --- a/src/Forms/Prism.Forms/Navigation/INavigationServiceExtensions.cs +++ b/src/Forms/Prism.Forms/Navigation/INavigationServiceExtensions.cs @@ -13,6 +13,7 @@ public static class INavigationServiceExtensions /// /// Navigates to the most recent entry in the back navigation history by popping the calling Page off the navigation stack. /// + /// Service for handling navigation between views /// 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. @@ -37,6 +38,7 @@ public static Task GoBackToRootAsync(this INavigationService /// /// Initiates navigation to the target specified by the . /// + /// Service for handling navigation between views /// The name of the target to navigate to. /// The navigation parameters /// If true uses PushModalAsync, if false uses PushAsync @@ -50,6 +52,7 @@ public static Task NavigateAsync(this INavigationService navi /// /// Initiates navigation to the target specified by the . /// + /// Service for handling navigation between views /// The Uri to navigate to /// The navigation parameters /// If true uses PopModalAsync, if false uses PopAsync @@ -87,6 +90,7 @@ public static string GetNavigationUriPath(this INavigationService navigationServ /// /// Navigates to the most recent entry in the back navigation history by popping the calling Page off the navigation stack. /// + /// Service for handling navigation between views /// The navigation parameters /// indicating whether the request was successful or if there was an encountered . public static Task GoBackAsync(this INavigationService navigationService, params (string Key, object Value)[] parameters) @@ -97,6 +101,7 @@ public static Task GoBackAsync(this INavigationService naviga /// /// Initiates navigation to the target specified by the . /// + /// 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 . @@ -112,6 +117,7 @@ public static Task NavigateAsync(this INavigationService navi /// /// Initiates navigation to the target specified by the . /// + /// 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 . diff --git a/src/Forms/Prism.Forms/Navigation/PageNavigationService.cs b/src/Forms/Prism.Forms/Navigation/PageNavigationService.cs index d1cc565f09..9ad8ab8d73 100644 --- a/src/Forms/Prism.Forms/Navigation/PageNavigationService.cs +++ b/src/Forms/Prism.Forms/Navigation/PageNavigationService.cs @@ -173,7 +173,6 @@ Task IPlatformNavigationService.GoBackToRootAsync(INavigation /// /// When navigating inside a NavigationPage: Pops all but the root Page off the navigation stack /// - /// The INavigatinService instance /// The navigation parameters /// Only works when called from a View within a NavigationPage protected async virtual Task GoBackToRootInternal(INavigationParameters parameters) diff --git a/src/Forms/Prism.Forms/Navigation/TabbedPages/INavigationServiceExtensions.cs b/src/Forms/Prism.Forms/Navigation/TabbedPages/INavigationServiceExtensions.cs index 39c30d03b9..4140907809 100644 --- a/src/Forms/Prism.Forms/Navigation/TabbedPages/INavigationServiceExtensions.cs +++ b/src/Forms/Prism.Forms/Navigation/TabbedPages/INavigationServiceExtensions.cs @@ -10,6 +10,7 @@ public static class INavigationServiceExtensions /// /// Selects a Tab of the TabbedPage parent. /// + /// Service for handling navigation between views /// The name of the tab to select /// The navigation parameters public static async Task SelectTabAsync(this INavigationService navigationService, string name, INavigationParameters parameters = null) diff --git a/src/Forms/Prism.Unity.Forms/PrismApplication.cs b/src/Forms/Prism.Unity.Forms/PrismApplication.cs index fa4167ec02..ed5e7e80bd 100644 --- a/src/Forms/Prism.Unity.Forms/PrismApplication.cs +++ b/src/Forms/Prism.Unity.Forms/PrismApplication.cs @@ -4,6 +4,9 @@ [assembly: Xamarin.Forms.XmlnsDefinition("http://prismlibrary.com", "Prism.Unity")] namespace Prism.Unity { + /// + /// Base class for PrismApplication + /// public abstract class PrismApplication : PrismApplicationBase { /// diff --git a/src/Prism.Core/Common/ParametersBase.cs b/src/Prism.Core/Common/ParametersBase.cs index d2a377f515..d720aa870c 100644 --- a/src/Prism.Core/Common/ParametersBase.cs +++ b/src/Prism.Core/Common/ParametersBase.cs @@ -7,14 +7,24 @@ namespace Prism.Common { + /// + /// Base class for Navigation parameters + /// public abstract class ParametersBase : IEnumerable> { private readonly List> _entries = new List>(); + /// + /// Default constructor + /// protected ParametersBase() { } + /// + /// Constructs a list of parameters + /// + /// Query string to be parsed protected ParametersBase(string query) { if (!string.IsNullOrWhiteSpace(query)) @@ -58,6 +68,12 @@ protected ParametersBase(string query) } } + /// + /// Searches Parameter collection and returns value if Collection contains key. + /// Otherswise returns null. + /// + /// + /// public object this[string key] { get @@ -74,32 +90,72 @@ public object this[string key] } } + /// + /// The count, or number, of parameters in collection + /// public int Count => _entries.Count; + /// + /// Returns an IEnumerable of the Keys in the collection + /// public IEnumerable Keys => _entries.Select(x => x.Key); + /// + /// Adds the KeyValuePair to the Collection + /// + /// + /// public void Add(string key, object value) => _entries.Add(new KeyValuePair(key, value)); + /// + /// Checks collection for presense of key + /// + /// + /// True if key exists; else returns false. public bool ContainsKey(string key) => _entries.ContainsKey(key); + /// + /// Gets an enumerator for the KeyValuePairs in parameter collection + /// + /// Enumerator public IEnumerator> GetEnumerator() => _entries.GetEnumerator(); - + /// + /// Returns the value of the member referenced by key + /// + /// The type of object to be returned + /// + /// public T GetValue(string key) => _entries.GetValue(key); + /// + /// Returns an IEnumerable of all parameters + /// + /// + /// public IEnumerable GetValues(string key) => _entries.GetValues(key); + /// + /// Checks to see if the parameter collection contains the value + /// + /// + /// + /// Value of the returned parameter if it exists public bool TryGetValue(string key, out T value) => _entries.TryGetValue(key, out value); IEnumerator IEnumerable.GetEnumerator() => GetEnumerator(); + /// + /// Converts parameter collection to a parameter string + /// + /// public override string ToString() { var queryBuilder = new StringBuilder(); @@ -129,6 +185,10 @@ public override string ToString() return queryBuilder.ToString(); } + /// + /// Adds a collection of parameters to the local parameter list + /// + /// [EditorBrowsable(EditorBrowsableState.Never)] public void FromParameters(IEnumerable> parameters) => _entries.AddRange(parameters); diff --git a/src/Prism.Core/Modularity/IModuleInfo.cs b/src/Prism.Core/Modularity/IModuleInfo.cs index 9ade53fe96..3896b210e8 100644 --- a/src/Prism.Core/Modularity/IModuleInfo.cs +++ b/src/Prism.Core/Modularity/IModuleInfo.cs @@ -2,13 +2,36 @@ namespace Prism.Modularity { - public interface IModuleInfo : IModuleCatalogItem + /// + /// Set of properties for each Module + /// +public interface IModuleInfo : IModuleCatalogItem { + /// + /// The modules this instance depends on. + /// Collection DependsOn { get; set; } + /// + /// When Prism should Initialize the module + /// + /// InitializationMode InitializationMode { get; set; } + /// + /// The name of the module + /// string ModuleName { get; set; } + /// + /// The module's type + /// string ModuleType { get; set; } + /// + /// A string ref for the module for registration/resolution + /// string Ref { get; set; } + /// + /// An enum that lists the modules state + /// + /// ModuleState State { get; set; } } } \ No newline at end of file diff --git a/src/Prism.Core/Modularity/IModuleInfoGroup.cs b/src/Prism.Core/Modularity/IModuleInfoGroup.cs index c4395df52d..3e021d4ff1 100644 --- a/src/Prism.Core/Modularity/IModuleInfoGroup.cs +++ b/src/Prism.Core/Modularity/IModuleInfoGroup.cs @@ -4,10 +4,20 @@ namespace Prism.Modularity { // IList must be supported in Silverlight 2 to be able to add items from XAML + /// + /// A collection of for the Modules used by the application + /// public interface IModuleInfoGroup : IModuleCatalogItem, IList, IList { + /// + /// When Prism should Initialize the module + /// + /// InitializationMode InitializationMode { get; set; } + /// + /// A string ref for the module for registration/resolution + /// string Ref { get; set; } } } diff --git a/src/Wpf/Prism.DryIoc.Wpf/Legacy/DryIocExtensions.cs b/src/Wpf/Prism.DryIoc.Wpf/Legacy/DryIocExtensions.cs index 8dd46c3533..8d3fdcf147 100644 --- a/src/Wpf/Prism.DryIoc.Wpf/Legacy/DryIocExtensions.cs +++ b/src/Wpf/Prism.DryIoc.Wpf/Legacy/DryIocExtensions.cs @@ -10,6 +10,7 @@ public static class DryIocExtensions /// Registers an object for navigation. /// /// The Type of the object to register + /// The container instance /// The unique name to register with the object public static void RegisterTypeForNavigation(this IContainer container, string name = null) { From e4a525aca0fa05bb3f9f474d9d49517c3dc34fe8 Mon Sep 17 00:00:00 2001 From: d3fkn1ght Date: Fri, 17 Apr 2020 13:23:12 -0400 Subject: [PATCH 02/16] Update ParametersBase.cs Adding comments per request of Dan Siegel --- src/Prism.Core/Common/ParametersBase.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Prism.Core/Common/ParametersBase.cs b/src/Prism.Core/Common/ParametersBase.cs index d720aa870c..0343d80b8c 100644 --- a/src/Prism.Core/Common/ParametersBase.cs +++ b/src/Prism.Core/Common/ParametersBase.cs @@ -8,7 +8,7 @@ namespace Prism.Common { /// - /// Base class for Navigation parameters + /// This is a generic parameters base class used for Dialog Parameters and Navigation Parameters /// public abstract class ParametersBase : IEnumerable> { From e0e889fa88be3bf9ae448fe21ef6af58f7921566 Mon Sep 17 00:00:00 2001 From: d3fkn1ght Date: Fri, 17 Apr 2020 13:31:10 -0400 Subject: [PATCH 03/16] Update ParametersBase.cs I have changed the file in an attempt to reduce the confusion identified by Dan Siegel --- src/Prism.Core/Common/ParametersBase.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Prism.Core/Common/ParametersBase.cs b/src/Prism.Core/Common/ParametersBase.cs index 0343d80b8c..55fcd962bf 100644 --- a/src/Prism.Core/Common/ParametersBase.cs +++ b/src/Prism.Core/Common/ParametersBase.cs @@ -102,7 +102,7 @@ public object this[string key] _entries.Select(x => x.Key); /// - /// Adds the KeyValuePair to the Collection + /// Adds the and to the KeyValuePair collection /// /// /// From 8f045c27ed6d30ea0f75fdcb02db3b49c9165b43 Mon Sep 17 00:00:00 2001 From: d3fkn1ght Date: Fri, 17 Apr 2020 13:37:46 -0400 Subject: [PATCH 04/16] Update ParametersBase.cs I have added the following comment to the key parameters --- src/Prism.Core/Common/ParametersBase.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Prism.Core/Common/ParametersBase.cs b/src/Prism.Core/Common/ParametersBase.cs index 55fcd962bf..ab2b1b2290 100644 --- a/src/Prism.Core/Common/ParametersBase.cs +++ b/src/Prism.Core/Common/ParametersBase.cs @@ -72,7 +72,7 @@ protected ParametersBase(string query) /// Searches Parameter collection and returns value if Collection contains key. /// Otherswise returns null. /// - /// + /// This parameter represents the key that represents the value to be returned /// public object this[string key] { @@ -102,7 +102,7 @@ public object this[string key] _entries.Select(x => x.Key); /// - /// Adds the and to the KeyValuePair collection + /// Adds the and to the KeyValuePair collection /// /// /// From 0c9d30cc567a12d6dbdd3ba05df45853a8e37488 Mon Sep 17 00:00:00 2001 From: d3fkn1ght Date: Fri, 17 Apr 2020 13:43:50 -0400 Subject: [PATCH 05/16] Update ParametersBase.cs Added comment to the tag for method documentation:: The key for the value to be returned Added following comment tot he tag for method documentation: Returns a matching parameter of if one exists in the Collection --- src/Prism.Core/Common/ParametersBase.cs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/Prism.Core/Common/ParametersBase.cs b/src/Prism.Core/Common/ParametersBase.cs index ab2b1b2290..5a42728f32 100644 --- a/src/Prism.Core/Common/ParametersBase.cs +++ b/src/Prism.Core/Common/ParametersBase.cs @@ -72,7 +72,7 @@ protected ParametersBase(string query) /// Searches Parameter collection and returns value if Collection contains key. /// Otherswise returns null. /// - /// This parameter represents the key that represents the value to be returned + /// The key for the value to be returned /// public object this[string key] { @@ -127,8 +127,8 @@ public IEnumerator> GetEnumerator() => /// Returns the value of the member referenced by key /// /// The type of object to be returned - /// - /// + /// The key for the value to be returned + /// Returns a matching parameter of if one exists in the Collection public T GetValue(string key) => _entries.GetValue(key); From b58f2752126fd5097a704457edc83c4b9c1e775b Mon Sep 17 00:00:00 2001 From: d3fkn1ght Date: Fri, 17 Apr 2020 13:47:16 -0400 Subject: [PATCH 06/16] Update ParametersBase.cs Modified tags on a few methods that check existence of keys/values or return values --- src/Prism.Core/Common/ParametersBase.cs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/Prism.Core/Common/ParametersBase.cs b/src/Prism.Core/Common/ParametersBase.cs index 5a42728f32..cd1b037a58 100644 --- a/src/Prism.Core/Common/ParametersBase.cs +++ b/src/Prism.Core/Common/ParametersBase.cs @@ -104,15 +104,15 @@ public object this[string key] /// /// Adds the and to the KeyValuePair collection /// - /// - /// + /// The key to reference this value in the KeyValuePair + /// The value of the parameter to store public void Add(string key, object value) => _entries.Add(new KeyValuePair(key, value)); /// /// Checks collection for presense of key /// - /// + /// The key to check in the collection /// True if key exists; else returns false. public bool ContainsKey(string key) => _entries.ContainsKey(key); From cb32be06d96e22630bbc78643682be39ed49d9ba Mon Sep 17 00:00:00 2001 From: d3fkn1ght Date: Fri, 17 Apr 2020 14:45:04 -0400 Subject: [PATCH 07/16] Update IModuleInfo.cs Fixed Indentation --- src/Prism.Core/Modularity/IModuleInfo.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Prism.Core/Modularity/IModuleInfo.cs b/src/Prism.Core/Modularity/IModuleInfo.cs index 3896b210e8..71c0c855c9 100644 --- a/src/Prism.Core/Modularity/IModuleInfo.cs +++ b/src/Prism.Core/Modularity/IModuleInfo.cs @@ -5,7 +5,7 @@ namespace Prism.Modularity /// /// Set of properties for each Module /// -public interface IModuleInfo : IModuleCatalogItem + public interface IModuleInfo : IModuleCatalogItem { /// /// The modules this instance depends on. @@ -34,4 +34,4 @@ public interface IModuleInfo : IModuleCatalogItem /// ModuleState State { get; set; } } -} \ No newline at end of file +} From d23846c01bf4985b45b5a2fbb8da1a3affb57591 Mon Sep 17 00:00:00 2001 From: d3fkn1ght Date: Fri, 17 Apr 2020 14:48:04 -0400 Subject: [PATCH 08/16] Update IModuleInfo.cs --- src/Prism.Core/Modularity/IModuleInfo.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Prism.Core/Modularity/IModuleInfo.cs b/src/Prism.Core/Modularity/IModuleInfo.cs index 71c0c855c9..e2ec7f71fe 100644 --- a/src/Prism.Core/Modularity/IModuleInfo.cs +++ b/src/Prism.Core/Modularity/IModuleInfo.cs @@ -8,7 +8,7 @@ namespace Prism.Modularity public interface IModuleInfo : IModuleCatalogItem { /// - /// The modules this instance depends on. + /// The module names this instance depends on. /// Collection DependsOn { get; set; } /// From 534891b98a66a284cdcfa2cee1a0bc9104353bf8 Mon Sep 17 00:00:00 2001 From: d3fkn1ght Date: Fri, 17 Apr 2020 14:54:01 -0400 Subject: [PATCH 09/16] Update IModuleInfo.cs Updated comment for InitializationMode --- src/Prism.Core/Modularity/IModuleInfo.cs | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/Prism.Core/Modularity/IModuleInfo.cs b/src/Prism.Core/Modularity/IModuleInfo.cs index e2ec7f71fe..437ba4f38e 100644 --- a/src/Prism.Core/Modularity/IModuleInfo.cs +++ b/src/Prism.Core/Modularity/IModuleInfo.cs @@ -12,8 +12,7 @@ public interface IModuleInfo : IModuleCatalogItem /// Collection DependsOn { get; set; } /// - /// When Prism should Initialize the module - /// + /// Gets or Sets the /// InitializationMode InitializationMode { get; set; } /// From 79c621169c82cbbef6df391df4231b60be6117bd Mon Sep 17 00:00:00 2001 From: d3fkn1ght Date: Fri, 17 Apr 2020 14:56:57 -0400 Subject: [PATCH 10/16] Update IModuleInfo.cs Added clarification and tag as requested by Dan Siegel --- src/Prism.Core/Modularity/IModuleInfo.cs | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/src/Prism.Core/Modularity/IModuleInfo.cs b/src/Prism.Core/Modularity/IModuleInfo.cs index 437ba4f38e..062d0dcf5b 100644 --- a/src/Prism.Core/Modularity/IModuleInfo.cs +++ b/src/Prism.Core/Modularity/IModuleInfo.cs @@ -11,22 +11,30 @@ public interface IModuleInfo : IModuleCatalogItem /// The module names this instance depends on. /// Collection DependsOn { get; set; } + /// /// Gets or Sets the /// InitializationMode InitializationMode { get; set; } + /// /// The name of the module /// string ModuleName { get; set; } + /// /// The module's type /// string ModuleType { get; set; } + /// - /// A string ref for the module for registration/resolution + /// A string ref is a location reference to load the module as it may not be already loaded in the Appdomain in some cases may need to be downloaded. /// + /// + /// This is only used for WPF + /// string Ref { get; set; } + /// /// An enum that lists the modules state /// From c5f9a387c5e345ad6f24eaca40fce166c5896404 Mon Sep 17 00:00:00 2001 From: d3fkn1ght Date: Fri, 17 Apr 2020 14:57:54 -0400 Subject: [PATCH 11/16] Update IModuleInfo.cs Update comment on ModuleState --- src/Prism.Core/Modularity/IModuleInfo.cs | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/Prism.Core/Modularity/IModuleInfo.cs b/src/Prism.Core/Modularity/IModuleInfo.cs index 062d0dcf5b..7ef81c2f27 100644 --- a/src/Prism.Core/Modularity/IModuleInfo.cs +++ b/src/Prism.Core/Modularity/IModuleInfo.cs @@ -36,8 +36,7 @@ public interface IModuleInfo : IModuleCatalogItem string Ref { get; set; } /// - /// An enum that lists the modules state - /// + /// Gets or Sets the current /// ModuleState State { get; set; } } From 1d817a7fbd8925c6230f9e1663e78e2896b92183 Mon Sep 17 00:00:00 2001 From: d3fkn1ght Date: Fri, 17 Apr 2020 15:00:41 -0400 Subject: [PATCH 12/16] Update IModuleInfoGroup.cs Add ref summary info as reqeusted --- src/Prism.Core/Modularity/IModuleInfoGroup.cs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/Prism.Core/Modularity/IModuleInfoGroup.cs b/src/Prism.Core/Modularity/IModuleInfoGroup.cs index 3e021d4ff1..c12ebf1fc0 100644 --- a/src/Prism.Core/Modularity/IModuleInfoGroup.cs +++ b/src/Prism.Core/Modularity/IModuleInfoGroup.cs @@ -16,8 +16,11 @@ public interface IModuleInfoGroup : IModuleCatalogItem, IList, ILis InitializationMode InitializationMode { get; set; } /// - /// A string ref for the module for registration/resolution + /// A string ref is a location reference to load the module as it may not be already loaded in the Appdomain in some cases may need to be downloaded. /// + /// + /// This is only used for WPF + /// string Ref { get; set; } } } From bc394334a254939d10c1565fc4f950d5a55aedb4 Mon Sep 17 00:00:00 2001 From: d3fkn1ght Date: Sat, 18 Apr 2020 23:10:26 -0400 Subject: [PATCH 13/16] Update ParametersBase.cs I have added text to some of the tags as requested by Dan Siegel --- src/Prism.Core/Common/ParametersBase.cs | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/src/Prism.Core/Common/ParametersBase.cs b/src/Prism.Core/Common/ParametersBase.cs index cd1b037a58..4df3eb0e2d 100644 --- a/src/Prism.Core/Common/ParametersBase.cs +++ b/src/Prism.Core/Common/ParametersBase.cs @@ -113,7 +113,7 @@ public void Add(string key, object value) => /// Checks collection for presense of key /// /// The key to check in the collection - /// True if key exists; else returns false. + /// true if key exists; else returns false. public bool ContainsKey(string key) => _entries.ContainsKey(key); @@ -123,19 +123,20 @@ public bool ContainsKey(string key) => /// Enumerator public IEnumerator> GetEnumerator() => _entries.GetEnumerator(); + /// /// Returns the value of the member referenced by key /// /// The type of object to be returned /// The key for the value to be returned - /// Returns a matching parameter of if one exists in the Collection + /// Returns a matching parameter of if one exists in the Collection public T GetValue(string key) => _entries.GetValue(key); /// /// Returns an IEnumerable of all parameters /// - /// + /// The type for the values to be returned /// public IEnumerable GetValues(string key) => _entries.GetValues(key); @@ -143,7 +144,7 @@ public IEnumerable GetValues(string key) => /// /// Checks to see if the parameter collection contains the value /// - /// + /// The type for the values to be returned /// /// Value of the returned parameter if it exists public bool TryGetValue(string key, out T value) => @@ -155,7 +156,7 @@ IEnumerator IEnumerable.GetEnumerator() => /// /// Converts parameter collection to a parameter string /// - /// + /// A string representation of the parameters public override string ToString() { var queryBuilder = new StringBuilder(); @@ -188,7 +189,7 @@ public override string ToString() /// /// Adds a collection of parameters to the local parameter list /// - /// + /// An IEnumberable of KeyValuePairs to add to the current parameter list [EditorBrowsable(EditorBrowsableState.Never)] public void FromParameters(IEnumerable> parameters) => _entries.AddRange(parameters); From aad61dd671618775639e5d29335c407853811396 Mon Sep 17 00:00:00 2001 From: d3fkn1ght Date: Mon, 20 Apr 2020 11:33:57 -0400 Subject: [PATCH 14/16] Update ParametersBase.cs I have added text to all the empty tags I found --- src/Prism.Core/Common/ParametersBase.cs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/Prism.Core/Common/ParametersBase.cs b/src/Prism.Core/Common/ParametersBase.cs index 4df3eb0e2d..ff81e8fc7b 100644 --- a/src/Prism.Core/Common/ParametersBase.cs +++ b/src/Prism.Core/Common/ParametersBase.cs @@ -73,7 +73,7 @@ protected ParametersBase(string query) /// Otherswise returns null. /// /// The key for the value to be returned - /// + /// The value of the parameter referenced by the key; otherwise null public object this[string key] { get @@ -137,7 +137,7 @@ public T GetValue(string key) => /// Returns an IEnumerable of all parameters /// /// The type for the values to be returned - /// + /// Returns a IEnumberable of all the instances of type public IEnumerable GetValues(string key) => _entries.GetValues(key); @@ -145,7 +145,7 @@ public IEnumerable GetValues(string key) => /// Checks to see if the parameter collection contains the value /// /// The type for the values to be returned - /// + /// The key for the value to be returned /// Value of the returned parameter if it exists public bool TryGetValue(string key, out T value) => _entries.TryGetValue(key, out value); From c9d0ef4c22cb7e736578bac32f5f336e2a7e7c4b Mon Sep 17 00:00:00 2001 From: d3fkn1ght Date: Mon, 20 Apr 2020 11:35:57 -0400 Subject: [PATCH 15/16] Update ParametersBase.cs Fixed a typo --- src/Prism.Core/Common/ParametersBase.cs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/Prism.Core/Common/ParametersBase.cs b/src/Prism.Core/Common/ParametersBase.cs index ff81e8fc7b..94d7949abd 100644 --- a/src/Prism.Core/Common/ParametersBase.cs +++ b/src/Prism.Core/Common/ParametersBase.cs @@ -137,7 +137,8 @@ public T GetValue(string key) => /// Returns an IEnumerable of all parameters /// /// The type for the values to be returned - /// Returns a IEnumberable of all the instances of type + /// The key for the values to be returned + ///Returns a IEnumberable of all the instances of type public IEnumerable GetValues(string key) => _entries.GetValues(key); From f92701b2da28422e666a86489c57186365fbb858 Mon Sep 17 00:00:00 2001 From: d3fkn1ght Date: Tue, 21 Apr 2020 09:21:30 -0400 Subject: [PATCH 16/16] Update ParametersBase.cs Removed paramref --- src/Prism.Core/Common/ParametersBase.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Prism.Core/Common/ParametersBase.cs b/src/Prism.Core/Common/ParametersBase.cs index 94d7949abd..9d9ce57a23 100644 --- a/src/Prism.Core/Common/ParametersBase.cs +++ b/src/Prism.Core/Common/ParametersBase.cs @@ -102,7 +102,7 @@ public object this[string key] _entries.Select(x => x.Key); /// - /// Adds the and to the KeyValuePair collection + /// Adds the key and value to the KeyValuePair collection /// /// The key to reference this value in the KeyValuePair /// The value of the parameter to store