Enable XML doc.

7 files changed, 166 insertions, 1 deletions

diff --git a/src/WixToolset.Core.TestPackage/BundleExtractor.cs b/src/WixToolset.Core.TestPackage/BundleExtractor.cs
index 8a56f117..ad97f113 100644
--- a/src/WixToolset.Core.TestPackage/BundleExtractor.cs
+++ b/src/WixToolset.Core.TestPackage/BundleExtractor.cs
@@ -7,8 +7,19 @@ namespace WixToolset.Core.TestPackage
     using WixToolset.Core.Burn.Bundles;
     using WixToolset.Extensibility.Services;
 
+    /// <summary>
+    /// Class to extract bundle contents for testing.
+    /// </summary>
     public class BundleExtractor
     {
+        /// <summary>
+        /// Extracts the BA container.
+        /// </summary>
+        /// <param name="messaging"></param>
+        /// <param name="bundleFilePath">Path to the bundle.</param>
+        /// <param name="destinationFolderPath">Path to extract to.</param>
+        /// <param name="tempFolderPath">Temp path for extraction.</param>
+        /// <returns></returns>
         public static ExtractBAContainerResult ExtractBAContainer(IMessaging messaging, string bundleFilePath, string destinationFolderPath, string tempFolderPath)
         {
             var result = new ExtractBAContainerResult();
@@ -33,6 +44,12 @@ namespace WixToolset.Core.TestPackage
             return result;
         }
 
+        /// <summary>
+        /// Gets an <see cref="XmlNamespaceManager"/> for BootstrapperApplicationData.xml with the given prefix assigned to the root namespace.
+        /// </summary>
+        /// <param name="document"></param>
+        /// <param name="prefix"></param>
+        /// <returns></returns>
         public static XmlNamespaceManager GetBADataNamespaceManager(XmlDocument document, string prefix)
         {
             var namespaceManager = new XmlNamespaceManager(document.NameTable);
@@ -40,6 +57,12 @@ namespace WixToolset.Core.TestPackage
             return namespaceManager;
         }
 
+        /// <summary>
+        /// Gets an <see cref="XmlNamespaceManager"/> for BundleExtensionData.xml with the given prefix assigned to the root namespace.
+        /// </summary>
+        /// <param name="document"></param>
+        /// <param name="prefix"></param>
+        /// <returns></returns>
         public static XmlNamespaceManager GetBundleExtensionDataNamespaceManager(XmlDocument document, string prefix)
         {
             var namespaceManager = new XmlNamespaceManager(document.NameTable);
@@ -47,6 +70,12 @@ namespace WixToolset.Core.TestPackage
             return namespaceManager;
         }
 
+        /// <summary>
+        /// Gets an <see cref="XmlNamespaceManager"/> for the Burn manifest.xml with the given prefix assigned to the root namespace.
+        /// </summary>
+        /// <param name="document"></param>
+        /// <param name="prefix"></param>
+        /// <returns></returns>
         public static XmlNamespaceManager GetBurnNamespaceManager(XmlDocument document, string prefix)
         {
             var namespaceManager = new XmlNamespaceManager(document.NameTable);
@@ -54,6 +83,11 @@ namespace WixToolset.Core.TestPackage
             return namespaceManager;
         }
 
+        /// <summary>
+        /// Loads an XmlDocument with the BootstrapperApplicationData.xml from the given folder that contains the contents of the BA container.
+        /// </summary>
+        /// <param name="baFolderPath"></param>
+        /// <returns></returns>
         public static XmlDocument LoadBAData(string baFolderPath)
         {
             var document = new XmlDocument();
@@ -61,6 +95,11 @@ namespace WixToolset.Core.TestPackage
             return document;
         }
 
+        /// <summary>
+        /// Loads an XmlDocument with the BootstrapperApplicationData.xml from the given folder that contains the contents of the BA container.
+        /// </summary>
+        /// <param name="baFolderPath"></param>
+        /// <returns></returns>
         public static XmlDocument LoadBundleExtensionData(string baFolderPath)
         {
             var document = new XmlDocument();
@@ -68,6 +107,11 @@ namespace WixToolset.Core.TestPackage
             return document;
         }
 
+        /// <summary>
+        /// Loads an XmlDocument with the BootstrapperApplicationData.xml from the given folder that contains the contents of the BA container.
+        /// </summary>
+        /// <param name="baFolderPath"></param>
+        /// <returns></returns>
         public static XmlDocument LoadBurnManifest(string baFolderPath)
         {
             var document = new XmlDocument();
diff --git a/src/WixToolset.Core.TestPackage/ExtractBAContainerResult.cs b/src/WixToolset.Core.TestPackage/ExtractBAContainerResult.cs
index 63d7bb31..277861ff 100644
--- a/src/WixToolset.Core.TestPackage/ExtractBAContainerResult.cs
+++ b/src/WixToolset.Core.TestPackage/ExtractBAContainerResult.cs
@@ -6,22 +6,61 @@ namespace WixToolset.Core.TestPackage
     using System.Xml;
     using Xunit;
 
+    /// <summary>
+    /// The result of extracting the BA container.
+    /// </summary>
     public class ExtractBAContainerResult
     {
+        /// <summary>
+        /// <see cref="XmlDocument"/> for BundleExtensionData.xml.
+        /// </summary>
         public XmlDocument BundleExtensionDataDocument { get; set; }
+
+        /// <summary>
+        /// <see cref="XmlNamespaceManager"/> for BundleExtensionData.xml.
+        /// </summary>
         public XmlNamespaceManager BundleExtensionDataNamespaceManager { get; set; }
+
+        /// <summary>
+        /// <see cref="XmlDocument"/> for BootstrapperApplicationData.xml.
+        /// </summary>
         public XmlDocument BADataDocument { get; set; }
+
+        /// <summary>
+        /// <see cref="XmlNamespaceManager"/> for BootstrapperApplicationData.xml.
+        /// </summary>
         public XmlNamespaceManager BADataNamespaceManager { get; set; }
+
+        /// <summary>
+        /// <see cref="XmlDocument"/> for the Burn manifest.xml.
+        /// </summary>
         public XmlDocument ManifestDocument { get; set; }
+
+        /// <summary>
+        /// <see cref="XmlNamespaceManager"/> for the Burn manifest.xml.
+        /// </summary>
         public XmlNamespaceManager ManifestNamespaceManager { get; set; }
+
+        /// <summary>
+        /// Whether extraction succeeded.
+        /// </summary>
         public bool Success { get; set; }
 
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <returns></returns>
         public ExtractBAContainerResult AssertSuccess()
         {
             Assert.True(this.Success);
             return this;
         }
 
+        /// <summary>
+        /// Returns the relative path of the BA entry point dll in the given folder.
+        /// </summary>
+        /// <param name="extractedBAContainerFolderPath"></param>
+        /// <returns></returns>
         public string GetBAFilePath(string extractedBAContainerFolderPath)
         {
             var uxPayloads = this.SelectManifestNodes("/burn:BurnManifest/burn:UX/burn:Payload");
@@ -30,6 +69,12 @@ namespace WixToolset.Core.TestPackage
             return Path.Combine(extractedBAContainerFolderPath, relativeBAPath);
         }
 
+        /// <summary>
+        /// Returns the relative path of the BundleExtension entry point dll in the given folder.
+        /// </summary>
+        /// <param name="extractedBAContainerFolderPath"></param>
+        /// <param name="extensionId"></param>
+        /// <returns></returns>
         public string GetBundleExtensionFilePath(string extractedBAContainerFolderPath, string extensionId)
         {
             var uxPayloads = this.SelectManifestNodes($"/burn:BurnManifest/burn:UX/burn:Payload[@Id='{extensionId}']");
diff --git a/src/WixToolset.Core.TestPackage/TestMessageListener.cs b/src/WixToolset.Core.TestPackage/TestMessageListener.cs
index b5863869..7040fe82 100644
--- a/src/WixToolset.Core.TestPackage/TestMessageListener.cs
+++ b/src/WixToolset.Core.TestPackage/TestMessageListener.cs
@@ -5,24 +5,51 @@ using WixToolset.Extensibility.Services;
 
 namespace WixToolset.Core.TestPackage
 {
+    /// <summary>
+    /// An <see cref="IMessageListener"/> that simply stores all the messages.
+    /// </summary>
     public sealed class TestMessageListener : IMessageListener
     {
+        /// <summary>
+        /// All messages that have been received.
+        /// </summary>
         public List<Message> Messages { get; } = new List<Message>();
 
+        /// <summary>
+        /// 
+        /// </summary>
         public string ShortAppName => "TEST";
 
+        /// <summary>
+        /// 
+        /// </summary>
         public string LongAppName => "Test";
 
+        /// <summary>
+        /// Stores the message in <see cref="Messages"/>.
+        /// </summary>
+        /// <param name="message"></param>
         public void Write(Message message)
         {
             this.Messages.Add(message);
         }
 
+        /// <summary>
+        /// Stores the message in <see cref="Messages"/>.
+        /// </summary>
+        /// <param name="message"></param>
         public void Write(string message)
         {
             this.Messages.Add(new Message(null, MessageLevel.Information, 0, message));
         }
 
+        /// <summary>
+        /// Always returns defaultMessageLevel.
+        /// </summary>
+        /// <param name="messaging"></param>
+        /// <param name="message"></param>
+        /// <param name="defaultMessageLevel"></param>
+        /// <returns></returns>
         public MessageLevel CalculateMessageLevel(IMessaging messaging, Message message, MessageLevel defaultMessageLevel) => defaultMessageLevel;
     }
 }
diff --git a/src/WixToolset.Core.TestPackage/WixRunner.cs b/src/WixToolset.Core.TestPackage/WixRunner.cs
index 940b55a8..a3883cd5 100644
--- a/src/WixToolset.Core.TestPackage/WixRunner.cs
+++ b/src/WixToolset.Core.TestPackage/WixRunner.cs
@@ -9,11 +9,19 @@ namespace WixToolset.Core.TestPackage
     using WixToolset.Core.Burn;
     using WixToolset.Core.WindowsInstaller;
     using WixToolset.Data;
-    using WixToolset.Extensibility.Data;
     using WixToolset.Extensibility.Services;
 
+    /// <summary>
+    /// Utility class to emulate wix.exe with standard backends.
+    /// </summary>
     public static class WixRunner
     {
+        /// <summary>
+        /// Emulates calling wix.exe with standard backends.
+        /// </summary>
+        /// <param name="args"></param>
+        /// <param name="messages"></param>
+        /// <returns></returns>
         public static int Execute(string[] args, out List<Message> messages)
         {
             var serviceProvider = WixToolsetServiceProviderFactory.CreateServiceProvider();
@@ -21,6 +29,11 @@ namespace WixToolset.Core.TestPackage
             return task.Result;
         }
 
+        /// <summary>
+        /// Emulates calling wix.exe with standard backends.
+        /// </summary>
+        /// <param name="args"></param>
+        /// <returns></returns>
         public static WixRunnerResult Execute(params string[] args)
         {
             var serviceProvider = WixToolsetServiceProviderFactory.CreateServiceProvider();
@@ -28,6 +41,13 @@ namespace WixToolset.Core.TestPackage
             return new WixRunnerResult { ExitCode = exitCode.Result, Messages = messages.ToArray() };
         }
 
+        /// <summary>
+        /// Emulates calling wix.exe with standard backends.
+        /// </summary>
+        /// <param name="args"></param>
+        /// <param name="coreProvider"></param>
+        /// <param name="messages"></param>
+        /// <returns></returns>
         public static Task<int> Execute(string[] args, IWixToolsetCoreServiceProvider coreProvider, out List<Message> messages)
         {
             coreProvider.AddWindowsInstallerBackend()
diff --git a/src/WixToolset.Core.TestPackage/WixRunnerResult.cs b/src/WixToolset.Core.TestPackage/WixRunnerResult.cs
index 88f20158..13e3a9e0 100644
--- a/src/WixToolset.Core.TestPackage/WixRunnerResult.cs
+++ b/src/WixToolset.Core.TestPackage/WixRunnerResult.cs
@@ -7,12 +7,25 @@ namespace WixToolset.Core.TestPackage
     using WixToolset.Data;
     using Xunit;
 
+    /// <summary>
+    /// The result of an Execute method of <see cref="WixRunner"/>.
+    /// </summary>
     public class WixRunnerResult
     {
+        /// <summary>
+        /// ExitCode for the operation.
+        /// </summary>
         public int ExitCode { get; set; }
 
+        /// <summary>
+        /// Messages from the operation.
+        /// </summary>
         public Message[] Messages { get; set; }
 
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <returns></returns>
         public WixRunnerResult AssertSuccess()
         {
             Assert.True(0 == this.ExitCode, $"\r\n\r\nWixRunner failed with exit code: {this.ExitCode}\r\n   Output: {String.Join("\r\n           ", FormatMessages(this.Messages))}\r\n");
diff --git a/src/WixToolset.Core.TestPackage/WixToolset.Core.TestPackage.csproj b/src/WixToolset.Core.TestPackage/WixToolset.Core.TestPackage.csproj
index 06793ffd..b64b4075 100644
--- a/src/WixToolset.Core.TestPackage/WixToolset.Core.TestPackage.csproj
+++ b/src/WixToolset.Core.TestPackage/WixToolset.Core.TestPackage.csproj
@@ -8,6 +8,7 @@
     <Description>Internal WiX Toolset Test Package</Description>
     <DebugType>embedded</DebugType>
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
+    <CreateDocumentationFile>true</CreateDocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/src/WixToolset.Core.TestPackage/XmlNodeExtensions.cs b/src/WixToolset.Core.TestPackage/XmlNodeExtensions.cs
index a7f04508..f4966f74 100644
--- a/src/WixToolset.Core.TestPackage/XmlNodeExtensions.cs
+++ b/src/WixToolset.Core.TestPackage/XmlNodeExtensions.cs
@@ -7,13 +7,28 @@ namespace WixToolset.Core.TestPackage
     using System.Text.RegularExpressions;
     using System.Xml;
 
+    /// <summary>
+    /// Utility class to help compare XML in tests using string comparisons by using single quotes and stripping all namespaces.
+    /// </summary>
     public static class XmlNodeExtensions
     {
+        /// <summary>
+        /// Returns the node's outer XML using single quotes and stripping all namespaces.
+        /// </summary>
+        /// <param name="node"></param>
+        /// <param name="ignoredAttributesByElementName">Attributes for which the value should be set to '*'.</param>
+        /// <returns></returns>
         public static string GetTestXml(this XmlNode node, Dictionary<string, List<string>> ignoredAttributesByElementName = null)
         {
             return node.OuterXml.GetTestXml(ignoredAttributesByElementName);
         }
 
+        /// <summary>
+        /// Returns the XML using single quotes and stripping all namespaces.
+        /// </summary>
+        /// <param name="xml"></param>
+        /// <param name="ignoredAttributesByElementName">Attributes for which the value should be set to '*'.</param>
+        /// <returns></returns>
         public static string GetTestXml(this string xml, Dictionary<string, List<string>> ignoredAttributesByElementName = null)
         {
             string formattedXml;