From 41f7cd8c721e04922188c99a6c564ba6bdaeefd1 Mon Sep 17 00:00:00 2001 From: Jesus Date: Sun, 19 Apr 2020 14:25:23 -0700 Subject: [PATCH] Added Documentation to IModuleCatalogExtensions --- .../Modularity/IModuleCatalogExtensions.cs | 61 ++++++++++--------- 1 file changed, 32 insertions(+), 29 deletions(-) diff --git a/src/Wpf/Prism.Wpf/Modularity/IModuleCatalogExtensions.cs b/src/Wpf/Prism.Wpf/Modularity/IModuleCatalogExtensions.cs index de9d8f7b13..51aabb9f07 100644 --- a/src/Wpf/Prism.Wpf/Modularity/IModuleCatalogExtensions.cs +++ b/src/Wpf/Prism.Wpf/Modularity/IModuleCatalogExtensions.cs @@ -1,16 +1,19 @@ -using System; +using System; using Prism.Properties; namespace Prism.Modularity { + /// + /// extensions. + /// public static class IModuleCatalogExtensions { /// - /// Adds the module. + /// Adds the module to the . /// - /// Catalog - /// - /// Collection of module names () of the modules on which the module to be added logically depends on. + /// The catalog to add the module to. + /// Stage on which the module to be added will be initialized. + /// Collection of module names () of the modules on which the module to be added logically depends on. /// The type parameter. /// The same instance with the added module. public static IModuleCatalog AddModule(this IModuleCatalog catalog, InitializationMode mode = InitializationMode.WhenAvailable, params string[] dependsOn) @@ -20,12 +23,12 @@ public static IModuleCatalog AddModule(this IModuleCatalog catalog, Initializ } /// - /// Adds the module. + /// Adds the module to the . /// - /// Catalog. - /// Name. - /// . - /// Collection of module names () of the modules on which the module to be added logically depends on. + /// The catalog to add the module to. + /// Name of the module to be added. + /// Stage on which the module to be added will be initialized. + /// Collection of module names () of the modules on which the module to be added logically depends on. /// The type parameter. /// The same instance with the added module. public static IModuleCatalog AddModule(this IModuleCatalog catalog, string name, InitializationMode mode = InitializationMode.WhenAvailable, params string[] dependsOn) @@ -37,7 +40,7 @@ public static IModuleCatalog AddModule(this IModuleCatalog catalog, string na /// /// Adds a groupless to the catalog. /// - /// Catalog. + /// The catalog to add the module to. /// of the module to be added. /// Collection of module names () of the modules on which the module to be added logically depends on. /// The same instance with the added module. @@ -49,7 +52,7 @@ public static IModuleCatalog AddModule(this IModuleCatalog catalog, Type moduleT /// /// Adds a groupless to the catalog. /// - /// Catalog. + /// The catalog to add the module to. /// of the module to be added. /// Stage on which the module to be added will be initialized. /// Collection of module names () of the modules on which the module to be added logically depends on. @@ -63,12 +66,13 @@ public static IModuleCatalog AddModule(this IModuleCatalog catalog, Type moduleT } /// - /// Adds a groupless to the catalog. + /// Adds a groupless to the catalog. /// + /// The catalog to add the module to. /// Name of the module to be added. /// Catalog. /// of the module to be added. - /// Collection of module names () of the modules on which the module to be added logically depends on. + /// Collection of module names () of the modules on which the module to be added logically depends on. /// The same instance with the added module. public static IModuleCatalog AddModule(this IModuleCatalog catalog, string moduleName, string moduleType, params string[] dependsOn) { @@ -78,7 +82,7 @@ public static IModuleCatalog AddModule(this IModuleCatalog catalog, string modul /// /// Adds a groupless to the catalog. /// - /// Catalog. + /// The catalog to add the module to. /// Name of the module to be added. /// of the module to be added. /// Stage on which the module to be added will be initialized. @@ -92,7 +96,7 @@ public static IModuleCatalog AddModule(this IModuleCatalog catalog, string modul /// /// Adds a groupless to the catalog. /// - /// Catalog. + /// The catalog to add the module to. /// Name of the module to be added. /// of the module to be added. /// Reference to the location of the module to be added assembly. @@ -116,22 +120,21 @@ public static IModuleCatalog AddModule(this IModuleCatalog catalog, string modul } /// - /// Adds the module. + /// Adds the module to the . /// - /// Catalog - /// + /// The catalog to add the module to. + /// Stage on which the module to be added will be initialized. /// The type parameter. /// The same instance with the added module. public static IModuleCatalog AddModule(this IModuleCatalog catalog, InitializationMode mode = InitializationMode.WhenAvailable) where T : IModule => catalog.AddModule(typeof(T).Name, mode); - /// - /// Adds the module. + /// Adds the module to the . /// - /// Catalog - /// Name. + /// The catalog to add the module to. + /// Name of the module to be added. /// The type parameter. /// The same instance with the added module. public static IModuleCatalog AddModule(this IModuleCatalog catalog, string name) @@ -139,11 +142,11 @@ public static IModuleCatalog AddModule(this IModuleCatalog catalog, string na catalog.AddModule(name, InitializationMode.WhenAvailable); /// - /// Adds the module. + /// Adds the module to the . /// - /// Catalog. - /// Name. - /// . + /// The catalog to add the module to. + /// Name of the module to be added. + /// Stage on which the module to be added will be initialized. /// The type parameter. /// The same instance with the added module. public static IModuleCatalog AddModule(this IModuleCatalog catalog, string name, InitializationMode mode) @@ -153,11 +156,11 @@ public static IModuleCatalog AddModule(this IModuleCatalog catalog, string na /// /// Creates and adds a to the catalog. /// - /// Catalog. + /// The catalog to add the module to. /// Stage on which the module group to be added will be initialized. /// Reference to the location of the module group to be added. /// Collection of included in the group. - /// The same instance with the added module group. + /// The same with the added module group. public static IModuleCatalog AddGroup(this IModuleCatalog catalog, InitializationMode initializationMode, string refValue, params ModuleInfo[] moduleInfos) { if (!(catalog is IModuleGroupsCatalog groupSupport))