aboutsummaryrefslogtreecommitdiff
path: root/src/WixToolset.Core.Burn
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.Burn
parent4e9b8c43ec5870d6aee75a95acd8a0de4ff4c1db (diff)
downloadwix-0e71bdd637a6b3c34f18d4b3630d55fa4cdfd2a3.tar.gz
wix-0e71bdd637a6b3c34f18d4b3630d55fa4cdfd2a3.tar.bz2
wix-0e71bdd637a6b3c34f18d4b3630d55fa4cdfd2a3.zip
Enable XML doc.
Diffstat (limited to 'src/WixToolset.Core.Burn')
-rw-r--r--src/WixToolset.Core.Burn/Bundles/BurnCommon.cs4
-rw-r--r--src/WixToolset.Core.Burn/Bundles/BurnReader.cs4
-rw-r--r--src/WixToolset.Core.Burn/Bundles/BurnWriter.cs5
-rw-r--r--src/WixToolset.Core.Burn/RowIndexedList.cs10
-rw-r--r--src/WixToolset.Core.Burn/WixToolset.Core.Burn.csproj5
-rw-r--r--src/WixToolset.Core.Burn/WixToolsetCoreServiceProviderExtensions.cs8
6 files changed, 26 insertions, 10 deletions
diff --git a/src/WixToolset.Core.Burn/Bundles/BurnCommon.cs b/src/WixToolset.Core.Burn/Bundles/BurnCommon.cs
index 01c9f9ca..bca1be72 100644
--- a/src/WixToolset.Core.Burn/Bundles/BurnCommon.cs
+++ b/src/WixToolset.Core.Burn/Bundles/BurnCommon.cs
@@ -9,7 +9,7 @@ namespace WixToolset.Core.Burn.Bundles
9 using WixToolset.Extensibility.Services; 9 using WixToolset.Extensibility.Services;
10 10
11 /// <summary> 11 /// <summary>
12 /// Common functionality for Burn PE Writer & Reader for the WiX toolset. 12 /// Common functionality for Burn PE Writer &amp; Reader for the WiX toolset.
13 /// </summary> 13 /// </summary>
14 /// <remarks>This class encapsulates common functionality related to 14 /// <remarks>This class encapsulates common functionality related to
15 /// bundled/chained setup packages.</remarks> 15 /// bundled/chained setup packages.</remarks>
@@ -107,8 +107,8 @@ namespace WixToolset.Core.Burn.Bundles
107 /// <summary> 107 /// <summary>
108 /// Creates a BurnCommon for re-writing a PE file. 108 /// Creates a BurnCommon for re-writing a PE file.
109 /// </summary> 109 /// </summary>
110 /// <param name="messaging"></param>
110 /// <param name="fileExe">File to modify in-place.</param> 111 /// <param name="fileExe">File to modify in-place.</param>
111 /// <param name="bundleGuid">GUID for the bundle.</param>
112 public BurnCommon(IMessaging messaging, string fileExe) 112 public BurnCommon(IMessaging messaging, string fileExe)
113 { 113 {
114 this.messaging = messaging; 114 this.messaging = messaging;
diff --git a/src/WixToolset.Core.Burn/Bundles/BurnReader.cs b/src/WixToolset.Core.Burn/Bundles/BurnReader.cs
index b4e23623..68fdea1c 100644
--- a/src/WixToolset.Core.Burn/Bundles/BurnReader.cs
+++ b/src/WixToolset.Core.Burn/Bundles/BurnReader.cs
@@ -32,6 +32,7 @@ namespace WixToolset.Core.Burn.Bundles
32 /// <summary> 32 /// <summary>
33 /// Creates a BurnReader for reading a PE file. 33 /// Creates a BurnReader for reading a PE file.
34 /// </summary> 34 /// </summary>
35 /// <param name="messaging"></param>
35 /// <param name="fileExe">File to read.</param> 36 /// <param name="fileExe">File to read.</param>
36 private BurnReader(IMessaging messaging, string fileExe) 37 private BurnReader(IMessaging messaging, string fileExe)
37 : base(messaging, fileExe) 38 : base(messaging, fileExe)
@@ -58,6 +59,7 @@ namespace WixToolset.Core.Burn.Bundles
58 /// <summary> 59 /// <summary>
59 /// Opens a Burn reader. 60 /// Opens a Burn reader.
60 /// </summary> 61 /// </summary>
62 /// <param name="messaging"></param>
61 /// <param name="fileExe">Path to file.</param> 63 /// <param name="fileExe">Path to file.</param>
62 /// <returns>Burn reader.</returns> 64 /// <returns>Burn reader.</returns>
63 public static BurnReader Open(IMessaging messaging, string fileExe) 65 public static BurnReader Open(IMessaging messaging, string fileExe)
@@ -77,6 +79,7 @@ namespace WixToolset.Core.Burn.Bundles
77 /// Gets the UX container from the exe and extracts its contents to the output directory. 79 /// Gets the UX container from the exe and extracts its contents to the output directory.
78 /// </summary> 80 /// </summary>
79 /// <param name="outputDirectory">Directory to write extracted files to.</param> 81 /// <param name="outputDirectory">Directory to write extracted files to.</param>
82 /// <param name="tempDirectory">Scratch directory.</param>
80 /// <returns>True if successful, false otherwise</returns> 83 /// <returns>True if successful, false otherwise</returns>
81 public bool ExtractUXContainer(string outputDirectory, string tempDirectory) 84 public bool ExtractUXContainer(string outputDirectory, string tempDirectory)
82 { 85 {
@@ -157,6 +160,7 @@ namespace WixToolset.Core.Burn.Bundles
157 /// Gets the attached container from the exe and extracts its contents to the output directory. 160 /// Gets the attached container from the exe and extracts its contents to the output directory.
158 /// </summary> 161 /// </summary>
159 /// <param name="outputDirectory">Directory to write extracted files to.</param> 162 /// <param name="outputDirectory">Directory to write extracted files to.</param>
163 /// <param name="tempDirectory">Scratch directory.</param>
160 /// <returns>True if successful, false otherwise</returns> 164 /// <returns>True if successful, false otherwise</returns>
161 public bool ExtractAttachedContainer(string outputDirectory, string tempDirectory) 165 public bool ExtractAttachedContainer(string outputDirectory, string tempDirectory)
162 { 166 {
diff --git a/src/WixToolset.Core.Burn/Bundles/BurnWriter.cs b/src/WixToolset.Core.Burn/Bundles/BurnWriter.cs
index 83b73a61..be9b8eaa 100644
--- a/src/WixToolset.Core.Burn/Bundles/BurnWriter.cs
+++ b/src/WixToolset.Core.Burn/Bundles/BurnWriter.cs
@@ -29,8 +29,8 @@ namespace WixToolset.Core.Burn.Bundles
29 /// <summary> 29 /// <summary>
30 /// Creates a BurnWriter for re-writing a PE file. 30 /// Creates a BurnWriter for re-writing a PE file.
31 /// </summary> 31 /// </summary>
32 /// <param name="messaging"></param>
32 /// <param name="fileExe">File to modify in-place.</param> 33 /// <param name="fileExe">File to modify in-place.</param>
33 /// <param name="bundleGuid">GUID for the bundle.</param>
34 private BurnWriter(IMessaging messaging, string fileExe) 34 private BurnWriter(IMessaging messaging, string fileExe)
35 : base(messaging, fileExe) 35 : base(messaging, fileExe)
36 { 36 {
@@ -39,6 +39,7 @@ namespace WixToolset.Core.Burn.Bundles
39 /// <summary> 39 /// <summary>
40 /// Opens a Burn writer. 40 /// Opens a Burn writer.
41 /// </summary> 41 /// </summary>
42 /// <param name="messaging"></param>
42 /// <param name="fileExe">Path to file.</param> 43 /// <param name="fileExe">Path to file.</param>
43 /// <returns>Burn writer.</returns> 44 /// <returns>Burn writer.</returns>
44 public static BurnWriter Open(IMessaging messaging, string fileExe) 45 public static BurnWriter Open(IMessaging messaging, string fileExe)
@@ -197,7 +198,9 @@ namespace WixToolset.Core.Burn.Bundles
197 /// Appends a container to the exe and updates the ".wixburn" section data to point to it. 198 /// Appends a container to the exe and updates the ".wixburn" section data to point to it.
198 /// </summary> 199 /// </summary>
199 /// <param name="containerStream">File stream to append to the current exe.</param> 200 /// <param name="containerStream">File stream to append to the current exe.</param>
201 /// <param name="containerSize">Size of the container.</param>
200 /// <param name="burnSectionOffsetSize">Offset of size field for this container in ".wixburn" section data.</param> 202 /// <param name="burnSectionOffsetSize">Offset of size field for this container in ".wixburn" section data.</param>
203 /// <param name="burnSectionCount">Number of Burn sections.</param>
201 /// <returns>true if the container data is successfully appended; false otherwise</returns> 204 /// <returns>true if the container data is successfully appended; false otherwise</returns>
202 private bool AppendContainer(Stream containerStream, UInt32 containerSize, UInt32 burnSectionOffsetSize, UInt32 burnSectionCount) 205 private bool AppendContainer(Stream containerStream, UInt32 containerSize, UInt32 burnSectionOffsetSize, UInt32 burnSectionCount)
203 { 206 {
diff --git a/src/WixToolset.Core.Burn/RowIndexedList.cs b/src/WixToolset.Core.Burn/RowIndexedList.cs
index 3a4dad38..73172dc2 100644
--- a/src/WixToolset.Core.Burn/RowIndexedList.cs
+++ b/src/WixToolset.Core.Burn/RowIndexedList.cs
@@ -7,18 +7,18 @@ namespace WixToolset.Core.Burn
7 using WixToolset.Data.WindowsInstaller; 7 using WixToolset.Data.WindowsInstaller;
8 8
9 /// <summary> 9 /// <summary>
10 /// A list of rows indexed by their primary key. Unlike a <see cref="RowDictionary"/> 10 /// A list of rows indexed by their primary key. Unlike a RowDictionary
11 /// this indexed list will track rows in their added order and will allow rows with 11 /// this indexed list will track rows in their added order and will allow rows with
12 /// duplicate keys to be added to the list, although only the first row will be indexed. 12 /// duplicate keys to be added to the list, although only the first row will be indexed.
13 /// </summary> 13 /// </summary>
14 public sealed class RowIndexedList<T> : IList<T> where T : Row 14 internal sealed class RowIndexedList<T> : IList<T> where T : Row
15 { 15 {
16 private Dictionary<string, T> index; 16 private Dictionary<string, T> index;
17 private List<T> rows; 17 private List<T> rows;
18 private List<T> duplicates; 18 private List<T> duplicates;
19 19
20 /// <summary> 20 /// <summary>
21 /// Creates an empty <see cref="RowIndexedList"/>. 21 /// Creates an empty <see cref="RowIndexedList{T}"/>.
22 /// </summary> 22 /// </summary>
23 public RowIndexedList() 23 public RowIndexedList()
24 { 24 {
@@ -28,7 +28,7 @@ namespace WixToolset.Core.Burn
28 } 28 }
29 29
30 /// <summary> 30 /// <summary>
31 /// Creates and populates a <see cref="RowDictionary"/> with the rows from the given enumerator. 31 /// Creates and populates a <see cref="RowIndexedList{T}"/> with the rows from the given enumerator.
32 /// </summary> 32 /// </summary>
33 /// <param name="rows">Rows to index.</param> 33 /// <param name="rows">Rows to index.</param>
34 public RowIndexedList(IEnumerable<T> rows) 34 public RowIndexedList(IEnumerable<T> rows)
@@ -41,7 +41,7 @@ namespace WixToolset.Core.Burn
41 } 41 }
42 42
43 /// <summary> 43 /// <summary>
44 /// Creates and populates a <see cref="RowDictionary"/> with the rows from the given <see cref="Table"/>. 44 /// Creates and populates a <see cref="RowIndexedList{T}"/> with the rows from the given <see cref="Table"/>.
45 /// </summary> 45 /// </summary>
46 /// <param name="table">The table to index.</param> 46 /// <param name="table">The table to index.</param>
47 /// <remarks> 47 /// <remarks>
diff --git a/src/WixToolset.Core.Burn/WixToolset.Core.Burn.csproj b/src/WixToolset.Core.Burn/WixToolset.Core.Burn.csproj
index b0be1d3b..8b989569 100644
--- a/src/WixToolset.Core.Burn/WixToolset.Core.Burn.csproj
+++ b/src/WixToolset.Core.Burn/WixToolset.Core.Burn.csproj
@@ -9,6 +9,7 @@
9 <Title>WiX Toolset Core Burn</Title> 9 <Title>WiX Toolset Core Burn</Title>
10 <DebugType>embedded</DebugType> 10 <DebugType>embedded</DebugType>
11 <PublishRepositoryUrl>true</PublishRepositoryUrl> 11 <PublishRepositoryUrl>true</PublishRepositoryUrl>
12 <CreateDocumentationFile>true</CreateDocumentationFile>
12 </PropertyGroup> 13 </PropertyGroup>
13 14
14 <ItemGroup> 15 <ItemGroup>
@@ -28,8 +29,8 @@
28 <PackageReference Include="System.Security.Permissions" Version="4.6.0" /> 29 <PackageReference Include="System.Security.Permissions" Version="4.6.0" />
29 <PackageReference Include="WixToolset.Burn" Version="4.0.*" /> 30 <PackageReference Include="WixToolset.Burn" Version="4.0.*" />
30 <PackageReference Include="WixToolset.Core.Native" Version="4.0.*" /> 31 <PackageReference Include="WixToolset.Core.Native" Version="4.0.*" />
31 <PackageReference Include="WixToolset.Dtf.Resources" Version="4.0.*" NoWarn="NU1701" /> 32 <PackageReference Include="WixToolset.Dtf.Resources" Version="4.0.*" />
32 <PackageReference Include="WixToolset.Dtf.WindowsInstaller" Version="4.0.*" NoWarn="NU1701" /> 33 <PackageReference Include="WixToolset.Dtf.WindowsInstaller" Version="4.0.*" />
33 </ItemGroup> 34 </ItemGroup>
34 35
35 <ItemGroup> 36 <ItemGroup>
diff --git a/src/WixToolset.Core.Burn/WixToolsetCoreServiceProviderExtensions.cs b/src/WixToolset.Core.Burn/WixToolsetCoreServiceProviderExtensions.cs
index 04fa4daf..5303899f 100644
--- a/src/WixToolset.Core.Burn/WixToolsetCoreServiceProviderExtensions.cs
+++ b/src/WixToolset.Core.Burn/WixToolsetCoreServiceProviderExtensions.cs
@@ -7,8 +7,16 @@ namespace WixToolset.Core.Burn
7 using WixToolset.Core.Burn.ExtensibilityServices; 7 using WixToolset.Core.Burn.ExtensibilityServices;
8 using WixToolset.Extensibility.Services; 8 using WixToolset.Extensibility.Services;
9 9
10 /// <summary>
11 /// Extensions methods for adding Burn services.
12 /// </summary>
10 public static class WixToolsetCoreServiceProviderExtensions 13 public static class WixToolsetCoreServiceProviderExtensions
11 { 14 {
15 /// <summary>
16 /// Adds Burn Services.
17 /// </summary>
18 /// <param name="coreProvider"></param>
19 /// <returns></returns>
12 public static IWixToolsetCoreServiceProvider AddBundleBackend(this IWixToolsetCoreServiceProvider coreProvider) 20 public static IWixToolsetCoreServiceProvider AddBundleBackend(this IWixToolsetCoreServiceProvider coreProvider)
13 { 21 {
14 AddServices(coreProvider); 22 AddServices(coreProvider);