From 0e71bdd637a6b3c34f18d4b3630d55fa4cdfd2a3 Mon Sep 17 00:00:00 2001
From: Sean Hall <r.sean.hall@gmail.com>
Date: Fri, 18 Dec 2020 22:04:48 -0600
Subject: Enable XML doc.

---
 src/WixToolset.Core.TestPackage/BundleExtractor.cs | 44 ++++++++++++++++++++++
 1 file changed, 44 insertions(+)

(limited to 'src/WixToolset.Core.TestPackage/BundleExtractor.cs')

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();
-- 
cgit v1.2.3-55-g6feb