From 6b4d50dcb28c309c10686d474e9ce58666b994c0 Mon Sep 17 00:00:00 2001 From: Christian Oleson Date: Thu, 9 Sep 2021 21:59:38 -0500 Subject: [PATCH 1/2] #1978 - Add a few XML docs and correct class names --- .gitignore | 3 +++ src/Forms/Prism.Forms/AppModel/IPageLifecycleAware.cs | 5 ++++- ...gistryExtensions.cs => ContainerRegistryExtensions.cs} | 5 ++++- ...uleCatalogExtensions.cs => ModuleCatalogExtensions.cs} | 2 +- src/Forms/Prism.Forms/Navigation/IInitialize.cs | 8 ++++++++ src/Forms/Prism.Forms/Navigation/IInitializeAsync.cs | 8 ++++++++ 6 files changed, 28 insertions(+), 3 deletions(-) rename src/Forms/Prism.Forms/Ioc/{IContainerRegistryExtensions.cs => ContainerRegistryExtensions.cs} (98%) rename src/Forms/Prism.Forms/Modularity/{IModuleCatalogExtensions.cs => ModuleCatalogExtensions.cs} (99%) diff --git a/.gitignore b/.gitignore index 087681b67f..487c1c28dc 100644 --- a/.gitignore +++ b/.gitignore @@ -202,3 +202,6 @@ FakesAssemblies/ # MFractor .mfractor/ + +# Jetbrains files +.idea* \ No newline at end of file diff --git a/src/Forms/Prism.Forms/AppModel/IPageLifecycleAware.cs b/src/Forms/Prism.Forms/AppModel/IPageLifecycleAware.cs index 517997972a..a98efba324 100644 --- a/src/Forms/Prism.Forms/AppModel/IPageLifecycleAware.cs +++ b/src/Forms/Prism.Forms/AppModel/IPageLifecycleAware.cs @@ -1,6 +1,9 @@ -using System; +using System; namespace Prism.AppModel { + /// + /// An interface for using the page lifecycle events + /// public interface IPageLifecycleAware { void OnAppearing(); diff --git a/src/Forms/Prism.Forms/Ioc/IContainerRegistryExtensions.cs b/src/Forms/Prism.Forms/Ioc/ContainerRegistryExtensions.cs similarity index 98% rename from src/Forms/Prism.Forms/Ioc/IContainerRegistryExtensions.cs rename to src/Forms/Prism.Forms/Ioc/ContainerRegistryExtensions.cs index 529d5ed4db..12d442b807 100644 --- a/src/Forms/Prism.Forms/Ioc/IContainerRegistryExtensions.cs +++ b/src/Forms/Prism.Forms/Ioc/ContainerRegistryExtensions.cs @@ -6,7 +6,10 @@ namespace Prism.Ioc { - public static class IContainerRegistryExtensions + /// + /// Extension methods for registering containers such as pages for navigation, dialog, etc. + /// + public static class ContainerRegistryExtensions { /// /// Registers a Page for navigation. diff --git a/src/Forms/Prism.Forms/Modularity/IModuleCatalogExtensions.cs b/src/Forms/Prism.Forms/Modularity/ModuleCatalogExtensions.cs similarity index 99% rename from src/Forms/Prism.Forms/Modularity/IModuleCatalogExtensions.cs rename to src/Forms/Prism.Forms/Modularity/ModuleCatalogExtensions.cs index b69be43547..8038fc5163 100644 --- a/src/Forms/Prism.Forms/Modularity/IModuleCatalogExtensions.cs +++ b/src/Forms/Prism.Forms/Modularity/ModuleCatalogExtensions.cs @@ -7,7 +7,7 @@ namespace Prism.Modularity /// /// extensions. /// - public static class IModuleCatalogExtensions + public static class ModuleCatalogExtensions { /// /// Adds the module. diff --git a/src/Forms/Prism.Forms/Navigation/IInitialize.cs b/src/Forms/Prism.Forms/Navigation/IInitialize.cs index cb9f98b55c..fe14c5cd74 100644 --- a/src/Forms/Prism.Forms/Navigation/IInitialize.cs +++ b/src/Forms/Prism.Forms/Navigation/IInitialize.cs @@ -1,7 +1,15 @@ namespace Prism.Navigation { + /// + /// Synchronous initialization of navigation + /// public interface IInitialize { + /// + /// Synchronously initialize method which initializes the navigation. + /// + /// + /// void Initialize(INavigationParameters parameters); } } diff --git a/src/Forms/Prism.Forms/Navigation/IInitializeAsync.cs b/src/Forms/Prism.Forms/Navigation/IInitializeAsync.cs index 1724c76dd1..db4ef33caf 100644 --- a/src/Forms/Prism.Forms/Navigation/IInitializeAsync.cs +++ b/src/Forms/Prism.Forms/Navigation/IInitializeAsync.cs @@ -2,8 +2,16 @@ namespace Prism.Navigation { + /// + /// Asynchronous initialization of navigation + /// public interface IInitializeAsync { + /// + /// Asynchronously initialize method which initializes the navigation. + /// + /// + /// Task InitializeAsync(INavigationParameters parameters); } } From dd5c1a4a41085bcd067ae3eaa22f9d50dfa237bf Mon Sep 17 00:00:00 2001 From: Christian Oleson Date: Fri, 10 Sep 2021 09:20:12 -0500 Subject: [PATCH 2/2] #1978 - PR Concerns 2 More Concerns #1978 - 2 More Concerns --- ...rRegistryExtensions.cs => IContainerRegistryExtensions.cs} | 4 ++-- ...ModuleCatalogExtensions.cs => IModuleCatalogExtensions.cs} | 4 ++-- src/Forms/Prism.Forms/Navigation/IInitialize.cs | 4 ++-- src/Forms/Prism.Forms/Navigation/IInitializeAsync.cs | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) rename src/Forms/Prism.Forms/Ioc/{ContainerRegistryExtensions.cs => IContainerRegistryExtensions.cs} (98%) rename src/Forms/Prism.Forms/Modularity/{ModuleCatalogExtensions.cs => IModuleCatalogExtensions.cs} (98%) diff --git a/src/Forms/Prism.Forms/Ioc/ContainerRegistryExtensions.cs b/src/Forms/Prism.Forms/Ioc/IContainerRegistryExtensions.cs similarity index 98% rename from src/Forms/Prism.Forms/Ioc/ContainerRegistryExtensions.cs rename to src/Forms/Prism.Forms/Ioc/IContainerRegistryExtensions.cs index 12d442b807..f77ab51916 100644 --- a/src/Forms/Prism.Forms/Ioc/ContainerRegistryExtensions.cs +++ b/src/Forms/Prism.Forms/Ioc/IContainerRegistryExtensions.cs @@ -7,9 +7,9 @@ namespace Prism.Ioc { /// - /// Extension methods for registering containers such as pages for navigation, dialog, etc. + /// Extension methods for registering views and dialogs for navigation. /// - public static class ContainerRegistryExtensions + public static class IContainerRegistryExtensions { /// /// Registers a Page for navigation. diff --git a/src/Forms/Prism.Forms/Modularity/ModuleCatalogExtensions.cs b/src/Forms/Prism.Forms/Modularity/IModuleCatalogExtensions.cs similarity index 98% rename from src/Forms/Prism.Forms/Modularity/ModuleCatalogExtensions.cs rename to src/Forms/Prism.Forms/Modularity/IModuleCatalogExtensions.cs index 8038fc5163..38c424ea20 100644 --- a/src/Forms/Prism.Forms/Modularity/ModuleCatalogExtensions.cs +++ b/src/Forms/Prism.Forms/Modularity/IModuleCatalogExtensions.cs @@ -1,4 +1,4 @@ -using System; +using System; using System.Collections.Generic; using System.Text; @@ -7,7 +7,7 @@ namespace Prism.Modularity /// /// extensions. /// - public static class ModuleCatalogExtensions + public static class IModuleCatalogExtensions { /// /// Adds the module. diff --git a/src/Forms/Prism.Forms/Navigation/IInitialize.cs b/src/Forms/Prism.Forms/Navigation/IInitialize.cs index fe14c5cd74..556b76ee27 100644 --- a/src/Forms/Prism.Forms/Navigation/IInitialize.cs +++ b/src/Forms/Prism.Forms/Navigation/IInitialize.cs @@ -1,12 +1,12 @@ namespace Prism.Navigation { /// - /// Synchronous initialization of navigation + /// This class is used to initialize views and viewmodels during the navigation process. /// public interface IInitialize { /// - /// Synchronously initialize method which initializes the navigation. + /// Invoked when the View or ViewModel is first created during the navigation process. /// /// /// diff --git a/src/Forms/Prism.Forms/Navigation/IInitializeAsync.cs b/src/Forms/Prism.Forms/Navigation/IInitializeAsync.cs index db4ef33caf..4e1775bdb5 100644 --- a/src/Forms/Prism.Forms/Navigation/IInitializeAsync.cs +++ b/src/Forms/Prism.Forms/Navigation/IInitializeAsync.cs @@ -3,12 +3,12 @@ namespace Prism.Navigation { /// - /// Asynchronous initialization of navigation + /// This class is used to initialize views and viewmodels during the navigation process. /// public interface IInitializeAsync { /// - /// Asynchronously initialize method which initializes the navigation. + /// Invoked when the View or ViewModel is first created during the navigation process. /// /// ///