From 59e358df2f15d478e5bd9f48e3e0824d8a59d7f4 Mon Sep 17 00:00:00 2001
From: Rob Mensching <rob@firegiant.com>
Date: Sat, 6 Jun 2020 13:24:14 -0700
Subject: Add xmldoc

---
 .../Services/IExtensionManager.cs                  | 19 ++++++++++--------
 .../Services/IWixToolsetServiceProvider.cs         | 23 +++++++++++++++++++++-
 .../Services/IWixtoolsetCoreServiceProvider.cs     | 22 +++++++++++++++++++++
 3 files changed, 55 insertions(+), 9 deletions(-)

(limited to 'src')

diff --git a/src/WixToolset.Extensibility/Services/IExtensionManager.cs b/src/WixToolset.Extensibility/Services/IExtensionManager.cs
index 19b41e4f..a8087941 100644
--- a/src/WixToolset.Extensibility/Services/IExtensionManager.cs
+++ b/src/WixToolset.Extensibility/Services/IExtensionManager.cs
@@ -5,6 +5,9 @@ namespace WixToolset.Extensibility.Services
     using System.Collections.Generic;
     using System.Reflection;
 
+    /// <summary>
+    /// Loads extensions and uses the extensions' factories to provide services.
+    /// </summary>
     public interface IExtensionManager
     {
         /// <summary>
@@ -14,20 +17,20 @@ namespace WixToolset.Extensibility.Services
         void Add(Assembly extensionAssembly);
 
         /// <summary>
-        /// Loads an extension assembly from a type description string.
+        /// Loads an extension assembly from an extension reference string.
         /// </summary>
-        /// <param name="extension">The assembly type description string.</param>
+        /// <param name="extensionReference">Reference to the extension.</param>
         /// <returns>The loaded assembly. This assembly can be ignored since the extension manager maintains the list of loaded assemblies internally.</returns>
         /// <remarks>
-        /// <paramref name="extension"/> can be in several different forms:
+        /// <paramref name="extensionReference"/> can be in several different forms:
         /// <list type="number">
-        /// <item><term>AssemblyName (MyAssembly, Version=1.3.0.0, Culture=neutral, PublicKeyToken=b17a5c561934e089)</term></item>
-        /// <item><term>Absolute path to an assembly (C:\MyExtensions\ExtensionAssembly.dll)</term></item>
-        /// <item><term>Filename of an assembly in the application directory (ExtensionAssembly.dll)</term></item>
-        /// <item><term>Relative path to an assembly (..\..\MyExtensions\ExtensionAssembly.dll)</term></item>
+        /// <item><term>Full path to an extension file (C:\MyExtensions\MyExtension.Example.wixext.dll)</term></item>
+        /// <item><term>Reference to latest version of an extension in the cache (MyExtension.Example.wixext)</term></item>
+        /// <item><term>Versioned reference to specific extension in the cache (MyExtension.Example.wixext/1.0.2)</term></item>
+        /// <item><term>Relative path to an extension file (..\..\MyExtensions\MyExtension.Example.wixext.dll)</term></item>
         /// </list>
         /// </remarks>
-        void Load(string extensionPath);
+        void Load(string extensionReference);
 
         /// <summary>
         /// Gets extensions of specified type from factories loaded into the extension manager.
diff --git a/src/WixToolset.Extensibility/Services/IWixToolsetServiceProvider.cs b/src/WixToolset.Extensibility/Services/IWixToolsetServiceProvider.cs
index c9ef36e1..0315f7ed 100644
--- a/src/WixToolset.Extensibility/Services/IWixToolsetServiceProvider.cs
+++ b/src/WixToolset.Extensibility/Services/IWixToolsetServiceProvider.cs
@@ -4,10 +4,31 @@ namespace WixToolset.Extensibility.Services
 {
     using System;
 
+    /// <summary>
+    /// Service provider.
+    /// </summary>
     public interface IWixToolsetServiceProvider : IServiceProvider
     {
+        /// <summary>
+        /// Gets a service from the service provider.
+        /// </summary>
+        /// <typeparam name="T">Type of service to get.</typeparam>
+        T GetService<T>() where T : class;
+
+        /// <summary>
+        /// Gets a service from the service provider.
+        /// </summary>
+        /// <param name="serviceType">Type of service to get.</param>
+        /// <param name="service">Retrieved service.</param>
+        /// <returns>True if the service was found, otherwise false</returns>
         bool TryGetService(Type serviceType, out object service);
+
+        /// <summary>
+        /// Gets a service from the service provider.
+        /// </summary>
+        /// <typeparam name="T">Type of service to get.</typeparam>
+        /// <param name="service">Retrieved service.</param>
+        /// <returns>True if the service was found, otherwise false</returns>
         bool TryGetService<T>(out T service) where T : class;
-        T GetService<T>() where T : class;
     }
 }
diff --git a/src/WixToolset.Extensibility/Services/IWixtoolsetCoreServiceProvider.cs b/src/WixToolset.Extensibility/Services/IWixtoolsetCoreServiceProvider.cs
index cda725f7..3c80ddef 100644
--- a/src/WixToolset.Extensibility/Services/IWixtoolsetCoreServiceProvider.cs
+++ b/src/WixToolset.Extensibility/Services/IWixtoolsetCoreServiceProvider.cs
@@ -5,9 +5,31 @@ namespace WixToolset.Extensibility.Services
     using System;
     using System.Collections.Generic;
 
+    /// <summary>
+    /// The core of the service provider used to add services to the service provider.
+    /// </summary>
     public interface IWixToolsetCoreServiceProvider : IWixToolsetServiceProvider
     {
+        /// <summary>
+        /// Adds a service to the service locator.
+        /// </summary>
+        /// <param name="serviceType">Type of the service to add.</param>
+        /// <param name="creationFunction">
+        /// A function that creates the service. The create function is provided the service provider
+        /// itself to resolve additional services and a type dictionary that stores singleton services
+        /// the creation function can add its service to.
+        /// </param>
         void AddService(Type serviceType, Func<IWixToolsetCoreServiceProvider, Dictionary<Type, object>, object> creationFunction);
+
+        /// <summary>
+        /// Adds a service to the service locator.
+        /// </summary>
+        /// <param name="serviceType">Type of the service to add.</param>
+        /// <param name="creationFunction">
+        /// A function that creates the service. The create function is provided the service provider
+        /// itself to resolve additional services and a type dictionary that stores singleton services
+        /// the creation function can add its service to.
+        /// </param>
         void AddService<T>(Func<IWixToolsetCoreServiceProvider, Dictionary<Type, object>, T> creationFunction) where T : class;
     }
 }
-- 
cgit v1.2.3-55-g6feb