Enable XML doc.

16 files changed, 48 insertions, 41 deletions

diff --git a/src/WixToolset.Core.WindowsInstaller/Bind/AssignMediaCommand.cs b/src/WixToolset.Core.WindowsInstaller/Bind/AssignMediaCommand.cs
index eccc97d2..301c3246 100644
--- a/src/WixToolset.Core.WindowsInstaller/Bind/AssignMediaCommand.cs
+++ b/src/WixToolset.Core.WindowsInstaller/Bind/AssignMediaCommand.cs
@@ -115,7 +115,6 @@ namespace WixToolset.Core.WindowsInstaller.Bind
         /// <summary>
         /// Assign files to cabinets based on MediaTemplate authoring.
         /// </summary>
-        /// <param name="fileFacades">FileRowCollection</param>
         private void AutoAssignFiles(List<MediaSymbol> mediaTable, Dictionary<MediaSymbol, List<FileFacade>> filesByCabinetMedia, List<FileFacade> uncompressedFiles)
         {
             const int MaxCabIndex = 999;
@@ -295,7 +294,7 @@ namespace WixToolset.Core.WindowsInstaller.Bind
         /// <summary>
         /// Adds a symbol to the section with cab name template filled in.
         /// </summary>
-        /// <param name="mediaTable"></param>
+        /// <param name="mediaTemplateSymbol"></param>
         /// <param name="cabIndex"></param>
         /// <returns></returns>
         private MediaSymbol AddMediaSymbol(WixMediaTemplateSymbol mediaTemplateSymbol, int cabIndex)
diff --git a/src/WixToolset.Core.WindowsInstaller/Bind/CabinetBuilder.cs b/src/WixToolset.Core.WindowsInstaller/Bind/CabinetBuilder.cs
index dce89f78..382e6515 100644
--- a/src/WixToolset.Core.WindowsInstaller/Bind/CabinetBuilder.cs
+++ b/src/WixToolset.Core.WindowsInstaller/Bind/CabinetBuilder.cs
@@ -28,6 +28,7 @@ namespace WixToolset.Core.WindowsInstaller.Bind
         /// <summary>
         /// Instantiate a new CabinetBuilder.
         /// </summary>
+        /// <param name="messaging"></param>
         /// <param name="threadCount">number of threads to use</param>
         /// <param name="newCabNamesCallBackAddress">Address of Binder's callback function for Cabinet Splitting</param>
         public CabinetBuilder(IMessaging messaging, int threadCount, IntPtr newCabNamesCallBackAddress)
diff --git a/src/WixToolset.Core.WindowsInstaller/Bind/CabinetResolver.cs b/src/WixToolset.Core.WindowsInstaller/Bind/CabinetResolver.cs
index 189c5f01..6dbcb1a1 100644
--- a/src/WixToolset.Core.WindowsInstaller/Bind/CabinetResolver.cs
+++ b/src/WixToolset.Core.WindowsInstaller/Bind/CabinetResolver.cs
@@ -13,7 +13,7 @@ namespace WixToolset.Core.WindowsInstaller.Bind
     using WixToolset.Extensibility.Data;
     using WixToolset.Extensibility.Services;
 
-    public class CabinetResolver
+    internal class CabinetResolver
     {
         public CabinetResolver(IWixToolsetServiceProvider serviceProvider, string cabCachePath, IEnumerable<IWindowsInstallerBackendBinderExtension> backendExtensions)
         {
diff --git a/src/WixToolset.Core.WindowsInstaller/Bind/CabinetWorkItem.cs b/src/WixToolset.Core.WindowsInstaller/Bind/CabinetWorkItem.cs
index a451229f..48f0574e 100644
--- a/src/WixToolset.Core.WindowsInstaller/Bind/CabinetWorkItem.cs
+++ b/src/WixToolset.Core.WindowsInstaller/Bind/CabinetWorkItem.cs
@@ -18,7 +18,8 @@ namespace WixToolset.Core.WindowsInstaller.Bind
         /// <param name="cabinetFile">The cabinet file.</param>
         /// <param name="maxThreshold">Maximum threshold for each cabinet.</param>
         /// <param name="compressionLevel">The compression level of the cabinet.</param>
-        /// <param name="binderFileManager">The binder file manager.</param>
+        /// <param name="modularizationSuffix">Modularization suffix used when building a Merge Module.</param>
+        /// <!--<param name="binderFileManager">The binder file manager.</param>-->
         public CabinetWorkItem(IEnumerable<FileFacade> fileFacades, string cabinetFile, int maxThreshold, CompressionLevel compressionLevel, string modularizationSuffix /*, BinderFileManager binderFileManager*/)
         {
             this.CabinetFile = cabinetFile;
@@ -52,10 +53,10 @@ namespace WixToolset.Core.WindowsInstaller.Bind
         /// <value>The collection of files in this cabinet.</value>
         public IEnumerable<FileFacade> FileFacades { get;  }
 
-        /// <summary>
-        /// Gets the binder file manager.
-        /// </summary>
-        /// <value>The binder file manager.</value>
+        // <summary>
+        // Gets the binder file manager.
+        // </summary>
+        // <value>The binder file manager.</value>
         //public BinderFileManager BinderFileManager { get; private set; }
 
         /// <summary>
diff --git a/src/WixToolset.Core.WindowsInstaller/Bind/CreateCabinetsCommand.cs b/src/WixToolset.Core.WindowsInstaller/Bind/CreateCabinetsCommand.cs
index 5c296f74..f0acd3d4 100644
--- a/src/WixToolset.Core.WindowsInstaller/Bind/CreateCabinetsCommand.cs
+++ b/src/WixToolset.Core.WindowsInstaller/Bind/CreateCabinetsCommand.cs
@@ -90,9 +90,6 @@ namespace WixToolset.Core.WindowsInstaller.Bind
 
         public IEnumerable<ITrackedFile> TrackedFiles => this.trackedFiles;
 
-        /// <param name="output">Output to generate image for.</param>
-        /// <param name="layoutDirectory">The directory in which the image should be layed out.</param>
-        /// <param name="compressed">Flag if source image should be compressed.</param>
         public void Execute()
         {
             this.lastCabinetAddedToMediaTable = new Dictionary<string, string>();
@@ -177,6 +174,7 @@ namespace WixToolset.Core.WindowsInstaller.Bind
         /// <param name="output">Output for the current database.</param>
         /// <param name="cabinetDir">Directory to create cabinet in.</param>
         /// <param name="mediaSymbol">Media symbol containing information about the cabinet.</param>
+        /// <param name="compressionLevel">Desired compression level.</param>
         /// <param name="fileFacades">Collection of files in this cabinet.</param>
         /// <returns>created CabinetWorkItem object</returns>
         private CabinetWorkItem CreateCabinetWorkItem(WindowsInstallerData output, string cabinetDir, MediaSymbol mediaSymbol, CompressionLevel compressionLevel, IEnumerable<FileFacade> fileFacades)
@@ -284,7 +282,7 @@ namespace WixToolset.Core.WindowsInstaller.Bind
         /// This callback will not be called in case there is no File splitting. i.e. MaximumCabinetSizeForLargeFileSplitting was not authored
         /// </summary>
         /// <param name="firstCabName">The name of splitting cabinet without extention e.g. "cab1".</param>
-        /// <param name="newCabName">The name of the new cabinet that would be formed by splitting e.g. "cab1b.cab"</param>
+        /// <param name="newCabinetName">The name of the new cabinet that would be formed by splitting e.g. "cab1b.cab"</param>
         /// <param name="fileToken">The file token of the first file present in the splitting cabinet</param>
         internal void NewCabNamesCallBack([MarshalAs(UnmanagedType.LPWStr)]string firstCabName, [MarshalAs(UnmanagedType.LPWStr)]string newCabinetName, [MarshalAs(UnmanagedType.LPWStr)]string fileToken)
         {
diff --git a/src/WixToolset.Core.WindowsInstaller/Bind/GenerateDatabaseCommand.cs b/src/WixToolset.Core.WindowsInstaller/Bind/GenerateDatabaseCommand.cs
index c8fa0370..d3c65b6a 100644
--- a/src/WixToolset.Core.WindowsInstaller/Bind/GenerateDatabaseCommand.cs
+++ b/src/WixToolset.Core.WindowsInstaller/Bind/GenerateDatabaseCommand.cs
@@ -55,7 +55,7 @@ namespace WixToolset.Core.WindowsInstaller.Bind
         public List<ITrackedFile> GeneratedTemporaryFiles { get; } = new List<ITrackedFile>();
 
         /// <summary>
-        /// Whether to use a subdirectory based on the <paramref name="databaseFile"/> file name for intermediate files.
+        /// Whether to use a subdirectory based on the database file name for intermediate files.
         /// </summary>
         private bool SuppressAddingValidationRows { get; }
 
diff --git a/src/WixToolset.Core.WindowsInstaller/Bind/GenerateTransformCommand.cs b/src/WixToolset.Core.WindowsInstaller/Bind/GenerateTransformCommand.cs
index 121ffb1b..6dcb1096 100644
--- a/src/WixToolset.Core.WindowsInstaller/Bind/GenerateTransformCommand.cs
+++ b/src/WixToolset.Core.WindowsInstaller/Bind/GenerateTransformCommand.cs
@@ -15,7 +15,7 @@ namespace WixToolset.Core.WindowsInstaller
     /// <summary>
     /// Creates a transform by diffing two outputs.
     /// </summary>
-    public sealed class GenerateTransformCommand
+    internal class GenerateTransformCommand
     {
         private const char sectionDelimiter = '/';
         private readonly IMessaging messaging;
@@ -62,10 +62,6 @@ namespace WixToolset.Core.WindowsInstaller
         /// <summary>
         /// Creates a transform by diffing two outputs.
         /// </summary>
-        /// <param name="targetOutput">The target output.</param>
-        /// <param name="updatedOutput">The updated output.</param>
-        /// <param name="validationFlags"></param>
-        /// <returns>The transform.</returns>
         public WindowsInstallerData Execute()
         {
             var targetOutput = this.TargetOutput;
diff --git a/src/WixToolset.Core.WindowsInstaller/Bind/UpdateTransformsWithFileFacades.cs b/src/WixToolset.Core.WindowsInstaller/Bind/UpdateTransformsWithFileFacades.cs
index 944fb224..4e716a47 100644
--- a/src/WixToolset.Core.WindowsInstaller/Bind/UpdateTransformsWithFileFacades.cs
+++ b/src/WixToolset.Core.WindowsInstaller/Bind/UpdateTransformsWithFileFacades.cs
@@ -384,7 +384,7 @@ namespace WixToolset.Core.WindowsInstaller.Bind
         /// <summary>
         /// Signal a warning if a non-keypath file was changed in a patch without also changing the keypath file of the component.
         /// </summary>
-        /// <param name="output">The output to validate.</param>
+        /// <param name="transform">The output to validate.</param>
         private void ValidateFileRowChanges(WindowsInstallerData transform)
         {
             var componentTable = transform.Tables["Component"];
diff --git a/src/WixToolset.Core.WindowsInstaller/Decompile/Decompiler.cs b/src/WixToolset.Core.WindowsInstaller/Decompile/Decompiler.cs
index 2288cedf..29e15c91 100644
--- a/src/WixToolset.Core.WindowsInstaller/Decompile/Decompiler.cs
+++ b/src/WixToolset.Core.WindowsInstaller/Decompile/Decompiler.cs
@@ -248,19 +248,20 @@ namespace WixToolset.Core.WindowsInstaller
         private XElement GetIndexedElement(string table, params string[] primaryKey) => this.IndexedElements[String.Concat(table, ':', String.Join(DecompilerConstants.PrimaryKeyDelimiterString, primaryKey))];
 
         /// <summary>
-        /// Gets the element corresponding to the primary key of the given table.
+        /// Tries to get the element corresponding to the primary key of the given table.
         /// </summary>
-        /// <param name="table">The table corresponding to the element.</param>
-        /// <param name="primaryKey">The primary key corresponding to the element.</param>
-        /// <returns>The indexed element.</returns>
+        /// <param name="row">The table corresponding to the element.</param>
+        /// <param name="xElement">The indexed element.</param>
+        /// <returns>Whether the element was found.</returns>
         private bool TryGetIndexedElement(WixToolset.Data.WindowsInstaller.Row row, out XElement xElement) => this.TryGetIndexedElement(row.TableDefinition.Name, out xElement, row.GetPrimaryKey(DecompilerConstants.PrimaryKeyDelimiter));
 
         /// <summary>
-        /// Gets the element corresponding to the primary key of the given table.
+        /// Tries to get the element corresponding to the primary key of the given table.
         /// </summary>
         /// <param name="table">The table corresponding to the element.</param>
+        /// <param name="xElement">The indexed element.</param>
         /// <param name="primaryKey">The primary key corresponding to the element.</param>
-        /// <returns>The indexed element.</returns>
+        /// <returns>Whether the element was found.</returns>
         private bool TryGetIndexedElement(string table, out XElement xElement, params string[] primaryKey) => this.IndexedElements.TryGetValue(String.Concat(table, ':', String.Join(DecompilerConstants.PrimaryKeyDelimiterString, primaryKey)), out xElement);
 
         /// <summary>
@@ -276,8 +277,9 @@ namespace WixToolset.Core.WindowsInstaller
         /// <summary>
         /// Index an element by its corresponding row.
         /// </summary>
-        /// <param name="row">The row corresponding to the element.</param>
         /// <param name="element">The element to index.</param>
+        /// <param name="table"></param>
+        /// <param name="primaryKey"></param>
         private void IndexElement(XElement element, string table, params string[] primaryKey)
         {
             this.IndexedElements.Add(String.Concat(table, ':', String.Join(DecompilerConstants.PrimaryKeyDelimiterString, primaryKey)), element);
@@ -342,7 +344,7 @@ namespace WixToolset.Core.WindowsInstaller
         /// Set the common control attributes in a control element.
         /// </summary>
         /// <param name="attributes">The control attributes.</param>
-        /// <param name="control">The control element.</param>
+        /// <param name="xControl">The control element.</param>
         private static void SetControlAttributes(int attributes, XElement xControl)
         {
             if (0 == (attributes & WindowsInstallerConstants.MsidbControlAttributesEnabled))
@@ -2424,6 +2426,7 @@ namespace WixToolset.Core.WindowsInstaller
         /// Initialize decompilation.
         /// </summary>
         /// <param name="tables">The collection of all tables.</param>
+        /// <param name="codepage"></param>
         private void InitializeDecompile(TableIndexedCollection tables, int codepage)
         {
             // reset all the state information
@@ -2983,7 +2986,7 @@ namespace WixToolset.Core.WindowsInstaller
         /// <summary>
         /// Decompile the _SummaryInformation table.
         /// </summary>
-        /// <param name="table">The table to decompile.</param>
+        /// <param name="tables">The tables to decompile.</param>
         private void FinalizeSummaryInformationStream(TableIndexedCollection tables)
         {
             var table = tables["_SummaryInformation"];
diff --git a/src/WixToolset.Core.WindowsInstaller/Msi/MsiInterop.cs b/src/WixToolset.Core.WindowsInstaller/Msi/MsiInterop.cs
index 8d195033..ae585612 100644
--- a/src/WixToolset.Core.WindowsInstaller/Msi/MsiInterop.cs
+++ b/src/WixToolset.Core.WindowsInstaller/Msi/MsiInterop.cs
@@ -177,7 +177,7 @@ namespace WixToolset.Core.WindowsInstaller.Msi
     /// <summary>
     /// Class exposing static functions and structs from MSI API.
     /// </summary>
-    public sealed class MsiInterop
+    internal sealed class MsiInterop
     {
         // Patching constants
         public const int MsiMaxStreamNameLength = 62; // http://msdn2.microsoft.com/library/aa370551.aspx
diff --git a/src/WixToolset.Core.WindowsInstaller/RowDictionary.cs b/src/WixToolset.Core.WindowsInstaller/RowDictionary.cs
index 101ebefd..bbb97c25 100644
--- a/src/WixToolset.Core.WindowsInstaller/RowDictionary.cs
+++ b/src/WixToolset.Core.WindowsInstaller/RowDictionary.cs
@@ -7,13 +7,13 @@ namespace WixToolset.Core.WindowsInstaller
     using WixToolset.Data.WindowsInstaller;
 
     /// <summary>
-    /// A dictionary of rows. Unlike the <see cref="RowIndexedCollection"/> this
+    /// A dictionary of rows. Unlike the RowIndexedList this
     /// will throw when multiple rows with the same key are added.
     /// </summary>
-    public sealed class RowDictionary<T> : Dictionary<string, T> where T : Row
+    internal sealed class RowDictionary<T> : Dictionary<string, T> where T : Row
     {
         /// <summary>
-        /// Creates an empty <see cref="RowDictionary"/>.
+        /// Creates an empty <see cref="RowDictionary{T}"/>.
         /// </summary>
         public RowDictionary()
             : base(StringComparer.InvariantCulture)
@@ -21,9 +21,9 @@ namespace WixToolset.Core.WindowsInstaller
         }
 
         /// <summary>
-        /// Creates and populates a <see cref="RowDictionary"/> with the rows from the given enumerator.
+        /// Creates and populates a <see cref="RowDictionary{T}"/> with the rows from the given enumerator.
         /// </summary>
-        /// <param name="Rows">Rows to add.</param>
+        /// <param name="rows">Rows to add.</param>
         public RowDictionary(IEnumerable<T> rows)
             : this()
         {
@@ -34,7 +34,7 @@ namespace WixToolset.Core.WindowsInstaller
         }
 
         /// <summary>
-        /// Creates and populates a <see cref="RowDictionary"/> with the rows from the given <see cref="Table"/>.
+        /// Creates and populates a <see cref="RowDictionary{T}"/> with the rows from the given <see cref="Table"/>.
         /// </summary>
         /// <param name="table">The table to index.</param>
         /// <remarks>
diff --git a/src/WixToolset.Core.WindowsInstaller/Unbinder.cs b/src/WixToolset.Core.WindowsInstaller/Unbinder.cs
index 2ca0b557..a2f02269 100644
--- a/src/WixToolset.Core.WindowsInstaller/Unbinder.cs
+++ b/src/WixToolset.Core.WindowsInstaller/Unbinder.cs
@@ -11,7 +11,7 @@ namespace WixToolset.Core
     /// <summary>
     /// Unbinder core of the WiX toolset.
     /// </summary>
-    public sealed class Unbinder
+    internal sealed class Unbinder
     {
         public IEnumerable<IBackendFactory> BackendFactories { get; }
 
diff --git a/src/WixToolset.Core.WindowsInstaller/Validator.cs b/src/WixToolset.Core.WindowsInstaller/Validator.cs
index 72b09ebc..e8117de7 100644
--- a/src/WixToolset.Core.WindowsInstaller/Validator.cs
+++ b/src/WixToolset.Core.WindowsInstaller/Validator.cs
@@ -22,7 +22,7 @@ namespace WixToolset.Core.WindowsInstaller
     /// <summary>
     /// Runs internal consistency evaluators (ICEs) from cub files against a database.
     /// </summary>
-    public sealed class Validator
+    internal sealed class Validator
     {
         private string actionName;
         private StringCollection cubeFiles;
diff --git a/src/WixToolset.Core.WindowsInstaller/ValidatorExtension.cs b/src/WixToolset.Core.WindowsInstaller/ValidatorExtension.cs
index 5ce04147..968ab387 100644
--- a/src/WixToolset.Core.WindowsInstaller/ValidatorExtension.cs
+++ b/src/WixToolset.Core.WindowsInstaller/ValidatorExtension.cs
@@ -52,7 +52,7 @@ namespace WixToolset.Extensibility
         /// Called at the beginning of the validation of a database file.
         /// </summary>
         /// <remarks>
-        /// <para>The <see cref="Validator"/> will set
+        /// <para>The Validator will set
         /// <see cref="DatabaseFile"/> before calling InitializeValidator.</para>
         /// <para><b>Notes to Inheritors:</b> When overriding
         /// <b>InitializeValidator</b> in a derived class, be sure to call
@@ -83,7 +83,7 @@ namespace WixToolset.Extensibility
         }
 
         /// <summary>
-        /// Logs a message from the <see cref="Validator"/>.
+        /// Logs a message from the Validator.
         /// </summary>
         /// <param name="message">A <see cref="String"/> of tab-delmited tokens
         /// in the validation message.</param>
@@ -93,7 +93,7 @@ namespace WixToolset.Extensibility
         }
 
         /// <summary>
-        /// Logs a message from the <see cref="Validator"/>.
+        /// Logs a message from the Validator.
         /// </summary>
         /// <param name="message">A <see cref="String"/> of tab-delmited tokens
         /// in the validation message.</param>
diff --git a/src/WixToolset.Core.WindowsInstaller/WixToolset.Core.WindowsInstaller.csproj b/src/WixToolset.Core.WindowsInstaller/WixToolset.Core.WindowsInstaller.csproj
index 9836acb8..900115ec 100644
--- a/src/WixToolset.Core.WindowsInstaller/WixToolset.Core.WindowsInstaller.csproj
+++ b/src/WixToolset.Core.WindowsInstaller/WixToolset.Core.WindowsInstaller.csproj
@@ -9,6 +9,7 @@
     <Title>WiX Toolset Core Windows Installer</Title>
     <DebugType>embedded</DebugType>
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
+    <CreateDocumentationFile>true</CreateDocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>
@@ -17,7 +18,7 @@
 
   <ItemGroup>
     <PackageReference Include="WixToolset.Core.Native" Version="4.0.*" />
-    <PackageReference Include="WixToolset.Dtf.WindowsInstaller" Version="4.0.*" NoWarn="NU1701" />
+    <PackageReference Include="WixToolset.Dtf.WindowsInstaller" Version="4.0.*" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/src/WixToolset.Core.WindowsInstaller/WixToolsetCoreServiceProviderExtensions.cs b/src/WixToolset.Core.WindowsInstaller/WixToolsetCoreServiceProviderExtensions.cs
index 15fbf679..c69f1af1 100644
--- a/src/WixToolset.Core.WindowsInstaller/WixToolsetCoreServiceProviderExtensions.cs
+++ b/src/WixToolset.Core.WindowsInstaller/WixToolsetCoreServiceProviderExtensions.cs
@@ -7,8 +7,16 @@ namespace WixToolset.Core.WindowsInstaller
     using WixToolset.Core.WindowsInstaller.ExtensibilityServices;
     using WixToolset.Extensibility.Services;
 
+    /// <summary>
+    /// Extensions methods for adding WindowsInstaller services.
+    /// </summary>
     public static class WixToolsetCoreServiceProviderExtensions
     {
+        /// <summary>
+        /// Adds WindowsInstaller services.
+        /// </summary>
+        /// <param name="coreProvider"></param>
+        /// <returns></returns>
         public static IWixToolsetCoreServiceProvider AddWindowsInstallerBackend(this IWixToolsetCoreServiceProvider coreProvider)
         {
             AddServices(coreProvider);