aboutsummaryrefslogtreecommitdiff
path: root/src/WixToolset.Core.WindowsInstaller/Bind
diff options
context:
space:
mode:
authorSean Hall <r.sean.hall@gmail.com>2020-12-18 22:04:48 -0600
committerSean Hall <r.sean.hall@gmail.com>2020-12-18 23:58:30 -0600
commit0e71bdd637a6b3c34f18d4b3630d55fa4cdfd2a3 (patch)
tree697466ea42c21f6d996cf324eb191f2182300697 /src/WixToolset.Core.WindowsInstaller/Bind
parent4e9b8c43ec5870d6aee75a95acd8a0de4ff4c1db (diff)
downloadwix-0e71bdd637a6b3c34f18d4b3630d55fa4cdfd2a3.tar.gz
wix-0e71bdd637a6b3c34f18d4b3630d55fa4cdfd2a3.tar.bz2
wix-0e71bdd637a6b3c34f18d4b3630d55fa4cdfd2a3.zip
Enable XML doc.
Diffstat (limited to 'src/WixToolset.Core.WindowsInstaller/Bind')
-rw-r--r--src/WixToolset.Core.WindowsInstaller/Bind/AssignMediaCommand.cs3
-rw-r--r--src/WixToolset.Core.WindowsInstaller/Bind/CabinetBuilder.cs1
-rw-r--r--src/WixToolset.Core.WindowsInstaller/Bind/CabinetResolver.cs2
-rw-r--r--src/WixToolset.Core.WindowsInstaller/Bind/CabinetWorkItem.cs11
-rw-r--r--src/WixToolset.Core.WindowsInstaller/Bind/CreateCabinetsCommand.cs6
-rw-r--r--src/WixToolset.Core.WindowsInstaller/Bind/GenerateDatabaseCommand.cs2
-rw-r--r--src/WixToolset.Core.WindowsInstaller/Bind/GenerateTransformCommand.cs6
-rw-r--r--src/WixToolset.Core.WindowsInstaller/Bind/UpdateTransformsWithFileFacades.cs2
8 files changed, 14 insertions, 19 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
115 /// <summary> 115 /// <summary>
116 /// Assign files to cabinets based on MediaTemplate authoring. 116 /// Assign files to cabinets based on MediaTemplate authoring.
117 /// </summary> 117 /// </summary>
118 /// <param name="fileFacades">FileRowCollection</param>
119 private void AutoAssignFiles(List<MediaSymbol> mediaTable, Dictionary<MediaSymbol, List<FileFacade>> filesByCabinetMedia, List<FileFacade> uncompressedFiles) 118 private void AutoAssignFiles(List<MediaSymbol> mediaTable, Dictionary<MediaSymbol, List<FileFacade>> filesByCabinetMedia, List<FileFacade> uncompressedFiles)
120 { 119 {
121 const int MaxCabIndex = 999; 120 const int MaxCabIndex = 999;
@@ -295,7 +294,7 @@ namespace WixToolset.Core.WindowsInstaller.Bind
295 /// <summary> 294 /// <summary>
296 /// Adds a symbol to the section with cab name template filled in. 295 /// Adds a symbol to the section with cab name template filled in.
297 /// </summary> 296 /// </summary>
298 /// <param name="mediaTable"></param> 297 /// <param name="mediaTemplateSymbol"></param>
299 /// <param name="cabIndex"></param> 298 /// <param name="cabIndex"></param>
300 /// <returns></returns> 299 /// <returns></returns>
301 private MediaSymbol AddMediaSymbol(WixMediaTemplateSymbol mediaTemplateSymbol, int cabIndex) 300 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
28 /// <summary> 28 /// <summary>
29 /// Instantiate a new CabinetBuilder. 29 /// Instantiate a new CabinetBuilder.
30 /// </summary> 30 /// </summary>
31 /// <param name="messaging"></param>
31 /// <param name="threadCount">number of threads to use</param> 32 /// <param name="threadCount">number of threads to use</param>
32 /// <param name="newCabNamesCallBackAddress">Address of Binder's callback function for Cabinet Splitting</param> 33 /// <param name="newCabNamesCallBackAddress">Address of Binder's callback function for Cabinet Splitting</param>
33 public CabinetBuilder(IMessaging messaging, int threadCount, IntPtr newCabNamesCallBackAddress) 34 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
13 using WixToolset.Extensibility.Data; 13 using WixToolset.Extensibility.Data;
14 using WixToolset.Extensibility.Services; 14 using WixToolset.Extensibility.Services;
15 15
16 public class CabinetResolver 16 internal class CabinetResolver
17 { 17 {
18 public CabinetResolver(IWixToolsetServiceProvider serviceProvider, string cabCachePath, IEnumerable<IWindowsInstallerBackendBinderExtension> backendExtensions) 18 public CabinetResolver(IWixToolsetServiceProvider serviceProvider, string cabCachePath, IEnumerable<IWindowsInstallerBackendBinderExtension> backendExtensions)
19 { 19 {
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
18 /// <param name="cabinetFile">The cabinet file.</param> 18 /// <param name="cabinetFile">The cabinet file.</param>
19 /// <param name="maxThreshold">Maximum threshold for each cabinet.</param> 19 /// <param name="maxThreshold">Maximum threshold for each cabinet.</param>
20 /// <param name="compressionLevel">The compression level of the cabinet.</param> 20 /// <param name="compressionLevel">The compression level of the cabinet.</param>
21 /// <param name="binderFileManager">The binder file manager.</param> 21 /// <param name="modularizationSuffix">Modularization suffix used when building a Merge Module.</param>
22 /// <!--<param name="binderFileManager">The binder file manager.</param>-->
22 public CabinetWorkItem(IEnumerable<FileFacade> fileFacades, string cabinetFile, int maxThreshold, CompressionLevel compressionLevel, string modularizationSuffix /*, BinderFileManager binderFileManager*/) 23 public CabinetWorkItem(IEnumerable<FileFacade> fileFacades, string cabinetFile, int maxThreshold, CompressionLevel compressionLevel, string modularizationSuffix /*, BinderFileManager binderFileManager*/)
23 { 24 {
24 this.CabinetFile = cabinetFile; 25 this.CabinetFile = cabinetFile;
@@ -52,10 +53,10 @@ namespace WixToolset.Core.WindowsInstaller.Bind
52 /// <value>The collection of files in this cabinet.</value> 53 /// <value>The collection of files in this cabinet.</value>
53 public IEnumerable<FileFacade> FileFacades { get; } 54 public IEnumerable<FileFacade> FileFacades { get; }
54 55
55 /// <summary> 56 // <summary>
56 /// Gets the binder file manager. 57 // Gets the binder file manager.
57 /// </summary> 58 // </summary>
58 /// <value>The binder file manager.</value> 59 // <value>The binder file manager.</value>
59 //public BinderFileManager BinderFileManager { get; private set; } 60 //public BinderFileManager BinderFileManager { get; private set; }
60 61
61 /// <summary> 62 /// <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
90 90
91 public IEnumerable<ITrackedFile> TrackedFiles => this.trackedFiles; 91 public IEnumerable<ITrackedFile> TrackedFiles => this.trackedFiles;
92 92
93 /// <param name="output">Output to generate image for.</param>
94 /// <param name="layoutDirectory">The directory in which the image should be layed out.</param>
95 /// <param name="compressed">Flag if source image should be compressed.</param>
96 public void Execute() 93 public void Execute()
97 { 94 {
98 this.lastCabinetAddedToMediaTable = new Dictionary<string, string>(); 95 this.lastCabinetAddedToMediaTable = new Dictionary<string, string>();
@@ -177,6 +174,7 @@ namespace WixToolset.Core.WindowsInstaller.Bind
177 /// <param name="output">Output for the current database.</param> 174 /// <param name="output">Output for the current database.</param>
178 /// <param name="cabinetDir">Directory to create cabinet in.</param> 175 /// <param name="cabinetDir">Directory to create cabinet in.</param>
179 /// <param name="mediaSymbol">Media symbol containing information about the cabinet.</param> 176 /// <param name="mediaSymbol">Media symbol containing information about the cabinet.</param>
177 /// <param name="compressionLevel">Desired compression level.</param>
180 /// <param name="fileFacades">Collection of files in this cabinet.</param> 178 /// <param name="fileFacades">Collection of files in this cabinet.</param>
181 /// <returns>created CabinetWorkItem object</returns> 179 /// <returns>created CabinetWorkItem object</returns>
182 private CabinetWorkItem CreateCabinetWorkItem(WindowsInstallerData output, string cabinetDir, MediaSymbol mediaSymbol, CompressionLevel compressionLevel, IEnumerable<FileFacade> fileFacades) 180 private CabinetWorkItem CreateCabinetWorkItem(WindowsInstallerData output, string cabinetDir, MediaSymbol mediaSymbol, CompressionLevel compressionLevel, IEnumerable<FileFacade> fileFacades)
@@ -284,7 +282,7 @@ namespace WixToolset.Core.WindowsInstaller.Bind
284 /// This callback will not be called in case there is no File splitting. i.e. MaximumCabinetSizeForLargeFileSplitting was not authored 282 /// This callback will not be called in case there is no File splitting. i.e. MaximumCabinetSizeForLargeFileSplitting was not authored
285 /// </summary> 283 /// </summary>
286 /// <param name="firstCabName">The name of splitting cabinet without extention e.g. "cab1".</param> 284 /// <param name="firstCabName">The name of splitting cabinet without extention e.g. "cab1".</param>
287 /// <param name="newCabName">The name of the new cabinet that would be formed by splitting e.g. "cab1b.cab"</param> 285 /// <param name="newCabinetName">The name of the new cabinet that would be formed by splitting e.g. "cab1b.cab"</param>
288 /// <param name="fileToken">The file token of the first file present in the splitting cabinet</param> 286 /// <param name="fileToken">The file token of the first file present in the splitting cabinet</param>
289 internal void NewCabNamesCallBack([MarshalAs(UnmanagedType.LPWStr)]string firstCabName, [MarshalAs(UnmanagedType.LPWStr)]string newCabinetName, [MarshalAs(UnmanagedType.LPWStr)]string fileToken) 287 internal void NewCabNamesCallBack([MarshalAs(UnmanagedType.LPWStr)]string firstCabName, [MarshalAs(UnmanagedType.LPWStr)]string newCabinetName, [MarshalAs(UnmanagedType.LPWStr)]string fileToken)
290 { 288 {
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
55 public List<ITrackedFile> GeneratedTemporaryFiles { get; } = new List<ITrackedFile>(); 55 public List<ITrackedFile> GeneratedTemporaryFiles { get; } = new List<ITrackedFile>();
56 56
57 /// <summary> 57 /// <summary>
58 /// Whether to use a subdirectory based on the <paramref name="databaseFile"/> file name for intermediate files. 58 /// Whether to use a subdirectory based on the database file name for intermediate files.
59 /// </summary> 59 /// </summary>
60 private bool SuppressAddingValidationRows { get; } 60 private bool SuppressAddingValidationRows { get; }
61 61
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
15 /// <summary> 15 /// <summary>
16 /// Creates a transform by diffing two outputs. 16 /// Creates a transform by diffing two outputs.
17 /// </summary> 17 /// </summary>
18 public sealed class GenerateTransformCommand 18 internal class GenerateTransformCommand
19 { 19 {
20 private const char sectionDelimiter = '/'; 20 private const char sectionDelimiter = '/';
21 private readonly IMessaging messaging; 21 private readonly IMessaging messaging;
@@ -62,10 +62,6 @@ namespace WixToolset.Core.WindowsInstaller
62 /// <summary> 62 /// <summary>
63 /// Creates a transform by diffing two outputs. 63 /// Creates a transform by diffing two outputs.
64 /// </summary> 64 /// </summary>
65 /// <param name="targetOutput">The target output.</param>
66 /// <param name="updatedOutput">The updated output.</param>
67 /// <param name="validationFlags"></param>
68 /// <returns>The transform.</returns>
69 public WindowsInstallerData Execute() 65 public WindowsInstallerData Execute()
70 { 66 {
71 var targetOutput = this.TargetOutput; 67 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
384 /// <summary> 384 /// <summary>
385 /// Signal a warning if a non-keypath file was changed in a patch without also changing the keypath file of the component. 385 /// Signal a warning if a non-keypath file was changed in a patch without also changing the keypath file of the component.
386 /// </summary> 386 /// </summary>
387 /// <param name="output">The output to validate.</param> 387 /// <param name="transform">The output to validate.</param>
388 private void ValidateFileRowChanges(WindowsInstallerData transform) 388 private void ValidateFileRowChanges(WindowsInstallerData transform)
389 { 389 {
390 var componentTable = transform.Tables["Component"]; 390 var componentTable = transform.Tables["Component"];