From 80df808461fca91b53e232b5b504a5c868029697 Mon Sep 17 00:00:00 2001
From: Sean Hall <r.sean.hall@gmail.com>
Date: Sat, 19 Dec 2020 19:15:11 -0600
Subject: Enable XML doc.

---
 .../BaseBootstrapperApplicationFactory.cs          | 27 ++++++++++++++++++++++
 1 file changed, 27 insertions(+)

(limited to 'src/WixToolset.Mba.Core/BaseBootstrapperApplicationFactory.cs')

diff --git a/src/WixToolset.Mba.Core/BaseBootstrapperApplicationFactory.cs b/src/WixToolset.Mba.Core/BaseBootstrapperApplicationFactory.cs
index 264733ac..ad8a5dc0 100644
--- a/src/WixToolset.Mba.Core/BaseBootstrapperApplicationFactory.cs
+++ b/src/WixToolset.Mba.Core/BaseBootstrapperApplicationFactory.cs
@@ -5,8 +5,16 @@ namespace WixToolset.Mba.Core
     using System;
     using System.Runtime.InteropServices;
 
+    /// <summary>
+    /// Default implementation of <see cref="IBootstrapperApplicationFactory"/>.
+    /// </summary>
     public abstract class BaseBootstrapperApplicationFactory : IBootstrapperApplicationFactory
     {
+        /// <summary>
+        /// Default implementation of <see cref="IBootstrapperApplicationFactory.Create(IntPtr, IntPtr)"/>
+        /// </summary>
+        /// <param name="pArgs"></param>
+        /// <param name="pResults"></param>
         public void Create(IntPtr pArgs, IntPtr pResults)
         {
             InitializeFromCreateArgs(pArgs, out var engine, out var bootstrapperCommand);
@@ -15,8 +23,21 @@ namespace WixToolset.Mba.Core
             StoreBAInCreateResults(pResults, ba);
         }
 
+        /// <summary>
+        /// Called by <see cref="BaseBootstrapperApplicationFactory.Create(IntPtr, IntPtr)"/> to get the <see cref="IBootstrapperApplication"/>.
+        /// </summary>
+        /// <param name="engine">The bundle engine.</param>
+        /// <param name="bootstrapperCommand">Command information passed from the engine for the BA to perform.</param>
+        /// <returns>The <see cref="IBootstrapperApplication"/> for the bundle.</returns>
         protected abstract IBootstrapperApplication Create(IEngine engine, IBootstrapperCommand bootstrapperCommand);
 
+        /// <summary>
+        /// Initializes the native part of <see cref="WixToolset.Mba.Core"/>.
+        /// Most users should inherit from <see cref="BaseBootstrapperApplicationFactory"/> instead of calling this method.
+        /// </summary>
+        /// <param name="pArgs">The args struct given by the engine when initially creating the BA.</param>
+        /// <param name="engine">The bundle engine interface.</param>
+        /// <param name="bootstrapperCommand">The context of the current run of the bundle.</param>
         public static void InitializeFromCreateArgs(IntPtr pArgs, out IEngine engine, out IBootstrapperCommand bootstrapperCommand)
         {
             Command pCommand = new Command
@@ -28,6 +49,12 @@ namespace WixToolset.Mba.Core
             bootstrapperCommand = pCommand.GetBootstrapperCommand();
         }
 
+        /// <summary>
+        /// Registers the BA with the engine using the default mapping between the message based interface and the COM interface.
+        /// Most users should inherit from <see cref="BaseBootstrapperApplicationFactory"/> instead of calling this method.
+        /// </summary>
+        /// <param name="pResults">The results struct given by the engine when initially creating the BA</param>
+        /// <param name="ba">The <see cref="IBootstrapperApplication"/>.</param>
         public static void StoreBAInCreateResults(IntPtr pResults, IBootstrapperApplication ba)
         {
             BalUtil.StoreBAInCreateResults(pResults, ba);
-- 
cgit v1.2.3-55-g6feb