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. --- src/WixToolset.Core.Burn/Bundles/BurnCommon.cs | 4 ++-- src/WixToolset.Core.Burn/Bundles/BurnReader.cs | 4 ++++ src/WixToolset.Core.Burn/Bundles/BurnWriter.cs | 5 ++++- src/WixToolset.Core.Burn/RowIndexedList.cs | 10 +++++----- src/WixToolset.Core.Burn/WixToolset.Core.Burn.csproj | 5 +++-- .../WixToolsetCoreServiceProviderExtensions.cs | 8 ++++++++ 6 files changed, 26 insertions(+), 10 deletions(-) (limited to 'src/WixToolset.Core.Burn') 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 using WixToolset.Extensibility.Services; /// - /// Common functionality for Burn PE Writer & Reader for the WiX toolset. + /// Common functionality for Burn PE Writer & Reader for the WiX toolset. /// /// This class encapsulates common functionality related to /// bundled/chained setup packages. @@ -107,8 +107,8 @@ namespace WixToolset.Core.Burn.Bundles /// /// Creates a BurnCommon for re-writing a PE file. /// + /// /// File to modify in-place. - /// GUID for the bundle. public BurnCommon(IMessaging messaging, string fileExe) { 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 /// /// Creates a BurnReader for reading a PE file. /// + /// /// File to read. private BurnReader(IMessaging messaging, string fileExe) : base(messaging, fileExe) @@ -58,6 +59,7 @@ namespace WixToolset.Core.Burn.Bundles /// /// Opens a Burn reader. /// + /// /// Path to file. /// Burn reader. public static BurnReader Open(IMessaging messaging, string fileExe) @@ -77,6 +79,7 @@ namespace WixToolset.Core.Burn.Bundles /// Gets the UX container from the exe and extracts its contents to the output directory. /// /// Directory to write extracted files to. + /// Scratch directory. /// True if successful, false otherwise public bool ExtractUXContainer(string outputDirectory, string tempDirectory) { @@ -157,6 +160,7 @@ namespace WixToolset.Core.Burn.Bundles /// Gets the attached container from the exe and extracts its contents to the output directory. /// /// Directory to write extracted files to. + /// Scratch directory. /// True if successful, false otherwise public bool ExtractAttachedContainer(string outputDirectory, string tempDirectory) { 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 /// /// Creates a BurnWriter for re-writing a PE file. /// + /// /// File to modify in-place. - /// GUID for the bundle. private BurnWriter(IMessaging messaging, string fileExe) : base(messaging, fileExe) { @@ -39,6 +39,7 @@ namespace WixToolset.Core.Burn.Bundles /// /// Opens a Burn writer. /// + /// /// Path to file. /// Burn writer. public static BurnWriter Open(IMessaging messaging, string fileExe) @@ -197,7 +198,9 @@ namespace WixToolset.Core.Burn.Bundles /// Appends a container to the exe and updates the ".wixburn" section data to point to it. /// /// File stream to append to the current exe. + /// Size of the container. /// Offset of size field for this container in ".wixburn" section data. + /// Number of Burn sections. /// true if the container data is successfully appended; false otherwise private bool AppendContainer(Stream containerStream, UInt32 containerSize, UInt32 burnSectionOffsetSize, UInt32 burnSectionCount) { 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 using WixToolset.Data.WindowsInstaller; /// - /// A list of rows indexed by their primary key. Unlike a + /// A list of rows indexed by their primary key. Unlike a RowDictionary /// this indexed list will track rows in their added order and will allow rows with /// duplicate keys to be added to the list, although only the first row will be indexed. /// - public sealed class RowIndexedList : IList where T : Row + internal sealed class RowIndexedList : IList where T : Row { private Dictionary index; private List rows; private List duplicates; /// - /// Creates an empty . + /// Creates an empty . /// public RowIndexedList() { @@ -28,7 +28,7 @@ namespace WixToolset.Core.Burn } /// - /// Creates and populates a with the rows from the given enumerator. + /// Creates and populates a with the rows from the given enumerator. /// /// Rows to index. public RowIndexedList(IEnumerable rows) @@ -41,7 +41,7 @@ namespace WixToolset.Core.Burn } /// - /// Creates and populates a with the rows from the given . + /// Creates and populates a with the rows from the given . /// /// The table to index. /// 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 @@ WiX Toolset Core Burn embedded true + true @@ -28,8 +29,8 @@ - - + + 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 using WixToolset.Core.Burn.ExtensibilityServices; using WixToolset.Extensibility.Services; + /// + /// Extensions methods for adding Burn services. + /// public static class WixToolsetCoreServiceProviderExtensions { + /// + /// Adds Burn Services. + /// + /// + /// public static IWixToolsetCoreServiceProvider AddBundleBackend(this IWixToolsetCoreServiceProvider coreProvider) { AddServices(coreProvider); -- cgit v1.2.3-55-g6feb