From 0e71bdd637a6b3c34f18d4b3630d55fa4cdfd2a3 Mon Sep 17 00:00:00 2001 From: Sean Hall Date: Fri, 18 Dec 2020 22:04:48 -0600 Subject: Enable XML doc. --- .../Bind/AssignMediaCommand.cs | 3 +-- src/WixToolset.Core.WindowsInstaller/Bind/CabinetBuilder.cs | 1 + src/WixToolset.Core.WindowsInstaller/Bind/CabinetResolver.cs | 2 +- src/WixToolset.Core.WindowsInstaller/Bind/CabinetWorkItem.cs | 11 ++++++----- .../Bind/CreateCabinetsCommand.cs | 6 ++---- .../Bind/GenerateDatabaseCommand.cs | 2 +- .../Bind/GenerateTransformCommand.cs | 6 +----- .../Bind/UpdateTransformsWithFileFacades.cs | 2 +- 8 files changed, 14 insertions(+), 19 deletions(-) (limited to 'src/WixToolset.Core.WindowsInstaller/Bind') 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 /// /// Assign files to cabinets based on MediaTemplate authoring. /// - /// FileRowCollection private void AutoAssignFiles(List mediaTable, Dictionary> filesByCabinetMedia, List uncompressedFiles) { const int MaxCabIndex = 999; @@ -295,7 +294,7 @@ namespace WixToolset.Core.WindowsInstaller.Bind /// /// Adds a symbol to the section with cab name template filled in. /// - /// + /// /// /// 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 /// /// Instantiate a new CabinetBuilder. /// + /// /// number of threads to use /// Address of Binder's callback function for Cabinet Splitting 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 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 /// The cabinet file. /// Maximum threshold for each cabinet. /// The compression level of the cabinet. - /// The binder file manager. + /// Modularization suffix used when building a Merge Module. + /// public CabinetWorkItem(IEnumerable fileFacades, string cabinetFile, int maxThreshold, CompressionLevel compressionLevel, string modularizationSuffix /*, BinderFileManager binderFileManager*/) { this.CabinetFile = cabinetFile; @@ -52,10 +53,10 @@ namespace WixToolset.Core.WindowsInstaller.Bind /// The collection of files in this cabinet. public IEnumerable FileFacades { get; } - /// - /// Gets the binder file manager. - /// - /// The binder file manager. + // + // Gets the binder file manager. + // + // The binder file manager. //public BinderFileManager BinderFileManager { get; private set; } /// 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 TrackedFiles => this.trackedFiles; - /// Output to generate image for. - /// The directory in which the image should be layed out. - /// Flag if source image should be compressed. public void Execute() { this.lastCabinetAddedToMediaTable = new Dictionary(); @@ -177,6 +174,7 @@ namespace WixToolset.Core.WindowsInstaller.Bind /// Output for the current database. /// Directory to create cabinet in. /// Media symbol containing information about the cabinet. + /// Desired compression level. /// Collection of files in this cabinet. /// created CabinetWorkItem object private CabinetWorkItem CreateCabinetWorkItem(WindowsInstallerData output, string cabinetDir, MediaSymbol mediaSymbol, CompressionLevel compressionLevel, IEnumerable 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 /// /// The name of splitting cabinet without extention e.g. "cab1". - /// The name of the new cabinet that would be formed by splitting e.g. "cab1b.cab" + /// The name of the new cabinet that would be formed by splitting e.g. "cab1b.cab" /// The file token of the first file present in the splitting cabinet 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 GeneratedTemporaryFiles { get; } = new List(); /// - /// Whether to use a subdirectory based on the file name for intermediate files. + /// Whether to use a subdirectory based on the database file name for intermediate files. /// 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 /// /// Creates a transform by diffing two outputs. /// - public sealed class GenerateTransformCommand + internal class GenerateTransformCommand { private const char sectionDelimiter = '/'; private readonly IMessaging messaging; @@ -62,10 +62,6 @@ namespace WixToolset.Core.WindowsInstaller /// /// Creates a transform by diffing two outputs. /// - /// The target output. - /// The updated output. - /// - /// The transform. 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 /// /// Signal a warning if a non-keypath file was changed in a patch without also changing the keypath file of the component. /// - /// The output to validate. + /// The output to validate. private void ValidateFileRowChanges(WindowsInstallerData transform) { var componentTable = transform.Tables["Component"]; -- cgit v1.2.3-55-g6feb