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 +-- .../Bind/CabinetBuilder.cs | 1 + .../Bind/CabinetResolver.cs | 2 +- .../Bind/CabinetWorkItem.cs | 11 ++++++----- .../Bind/CreateCabinetsCommand.cs | 6 ++---- .../Bind/GenerateDatabaseCommand.cs | 2 +- .../Bind/GenerateTransformCommand.cs | 6 +----- .../Bind/UpdateTransformsWithFileFacades.cs | 2 +- .../Decompile/Decompiler.cs | 21 ++++++++++++--------- .../Msi/MsiInterop.cs | 2 +- .../RowDictionary.cs | 12 ++++++------ src/WixToolset.Core.WindowsInstaller/Unbinder.cs | 2 +- src/WixToolset.Core.WindowsInstaller/Validator.cs | 2 +- .../ValidatorExtension.cs | 6 +++--- .../WixToolset.Core.WindowsInstaller.csproj | 3 ++- .../WixToolsetCoreServiceProviderExtensions.cs | 8 ++++++++ 16 files changed, 48 insertions(+), 41 deletions(-) (limited to 'src/WixToolset.Core.WindowsInstaller') 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"]; 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))]; /// - /// 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. /// - /// The table corresponding to the element. - /// The primary key corresponding to the element. - /// The indexed element. + /// The table corresponding to the element. + /// The indexed element. + /// Whether the element was found. private bool TryGetIndexedElement(WixToolset.Data.WindowsInstaller.Row row, out XElement xElement) => this.TryGetIndexedElement(row.TableDefinition.Name, out xElement, row.GetPrimaryKey(DecompilerConstants.PrimaryKeyDelimiter)); /// - /// 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. /// /// The table corresponding to the element. + /// The indexed element. /// The primary key corresponding to the element. - /// The indexed element. + /// Whether the element was found. private bool TryGetIndexedElement(string table, out XElement xElement, params string[] primaryKey) => this.IndexedElements.TryGetValue(String.Concat(table, ':', String.Join(DecompilerConstants.PrimaryKeyDelimiterString, primaryKey)), out xElement); /// @@ -276,8 +277,9 @@ namespace WixToolset.Core.WindowsInstaller /// /// Index an element by its corresponding row. /// - /// The row corresponding to the element. /// The element to index. + /// + /// 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. /// /// The control attributes. - /// The control element. + /// The control element. private static void SetControlAttributes(int attributes, XElement xControl) { if (0 == (attributes & WindowsInstallerConstants.MsidbControlAttributesEnabled)) @@ -2424,6 +2426,7 @@ namespace WixToolset.Core.WindowsInstaller /// Initialize decompilation. /// /// The collection of all tables. + /// private void InitializeDecompile(TableIndexedCollection tables, int codepage) { // reset all the state information @@ -2983,7 +2986,7 @@ namespace WixToolset.Core.WindowsInstaller /// /// Decompile the _SummaryInformation table. /// - /// The table to decompile. + /// The tables to decompile. 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 /// /// Class exposing static functions and structs from MSI API. /// - 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; /// - /// A dictionary of rows. Unlike the this + /// A dictionary of rows. Unlike the RowIndexedList this /// will throw when multiple rows with the same key are added. /// - public sealed class RowDictionary : Dictionary where T : Row + internal sealed class RowDictionary : Dictionary where T : Row { /// - /// Creates an empty . + /// Creates an empty . /// public RowDictionary() : base(StringComparer.InvariantCulture) @@ -21,9 +21,9 @@ namespace WixToolset.Core.WindowsInstaller } /// - /// Creates and populates a with the rows from the given enumerator. + /// Creates and populates a with the rows from the given enumerator. /// - /// Rows to add. + /// Rows to add. public RowDictionary(IEnumerable rows) : this() { @@ -34,7 +34,7 @@ namespace WixToolset.Core.WindowsInstaller } /// - /// 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.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 /// /// Unbinder core of the WiX toolset. /// - public sealed class Unbinder + internal sealed class Unbinder { public IEnumerable 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 /// /// Runs internal consistency evaluators (ICEs) from cub files against a database. /// - 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. /// /// - /// The will set + /// The Validator will set /// before calling InitializeValidator. /// Notes to Inheritors: When overriding /// InitializeValidator in a derived class, be sure to call @@ -83,7 +83,7 @@ namespace WixToolset.Extensibility } /// - /// Logs a message from the . + /// Logs a message from the Validator. /// /// A of tab-delmited tokens /// in the validation message. @@ -93,7 +93,7 @@ namespace WixToolset.Extensibility } /// - /// Logs a message from the . + /// Logs a message from the Validator. /// /// A of tab-delmited tokens /// in the validation message. 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 @@ WiX Toolset Core Windows Installer embedded true + true @@ -17,7 +18,7 @@ - + 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; + /// + /// Extensions methods for adding WindowsInstaller services. + /// public static class WixToolsetCoreServiceProviderExtensions { + /// + /// Adds WindowsInstaller services. + /// + /// + /// public static IWixToolsetCoreServiceProvider AddWindowsInstallerBackend(this IWixToolsetCoreServiceProvider coreProvider) { AddServices(coreProvider); -- cgit v1.2.3-55-g6feb