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/ExtractEmbeddedFilesCommand.cs | 1 + src/WixToolset.Core/Bind/FileFacade.cs | 1 + src/WixToolset.Core/Bind/FileResolver.cs | 2 +- .../Bind/ResolveDelayedFieldsCommand.cs | 2 ++ .../CommandLine/CommandLineParser.cs | 1 - src/WixToolset.Core/Common.cs | 37 +++++++++++++++++++--- src/WixToolset.Core/Compiler.cs | 10 ++++-- src/WixToolset.Core/CompilerCore.cs | 10 ++++-- src/WixToolset.Core/Compiler_2.cs | 8 +++-- src/WixToolset.Core/Compiler_Bundle.cs | 35 +++++++++++++++++--- src/WixToolset.Core/Compiler_EmbeddedUI.cs | 1 - src/WixToolset.Core/Compiler_Patch.cs | 4 +++ src/WixToolset.Core/Compiler_UI.cs | 3 +- .../ExtensibilityServices/ParseHelper.cs | 32 ------------------- src/WixToolset.Core/ExtensibilityServices/Uuid.cs | 1 - src/WixToolset.Core/IBinder.cs | 2 +- src/WixToolset.Core/ICompiler.cs | 4 +-- src/WixToolset.Core/IDecompiler.cs | 2 +- src/WixToolset.Core/ILayoutCreator.cs | 4 +-- src/WixToolset.Core/ILibrarian.cs | 4 +-- src/WixToolset.Core/ILinker.cs | 3 +- src/WixToolset.Core/IPreprocessor.cs | 1 + src/WixToolset.Core/IResolver.cs | 2 +- src/WixToolset.Core/Inscriber.cs | 8 ++--- src/WixToolset.Core/LayoutCreator.cs | 6 ++-- src/WixToolset.Core/Link/SymbolWithSection.cs | 1 + .../Link/WixComplexReferenceSymbolExtensions.cs | 6 ++-- src/WixToolset.Core/Link/WixGroupingOrdering.cs | 6 ++-- src/WixToolset.Core/Linker.cs | 2 +- src/WixToolset.Core/LocalizationParser.cs | 5 +++ src/WixToolset.Core/PatchSymbolFlagsType.cs | 31 +++++++++++++----- .../Preprocess/IfDefEventHandler.cs | 4 +-- .../Preprocess/IncludedFileEventHandler.cs | 6 ++-- .../Preprocess/ProcessedStreamEventHandler.cs | 6 ++-- .../Preprocess/ResolvedVariableEventHandler.cs | 4 +-- src/WixToolset.Core/PreprocessResult.cs | 2 +- src/WixToolset.Core/Preprocessor.cs | 30 +++++++++++++++--- src/WixToolset.Core/ResolveFileResult.cs | 2 +- src/WixToolset.Core/WixToolset.Core.csproj | 2 ++ .../WixToolsetServiceProviderFactory.cs | 7 ++++ 40 files changed, 195 insertions(+), 103 deletions(-) (limited to 'src/WixToolset.Core') diff --git a/src/WixToolset.Core/Bind/ExtractEmbeddedFilesCommand.cs b/src/WixToolset.Core/Bind/ExtractEmbeddedFilesCommand.cs index bb9ab844..29fba6b2 100644 --- a/src/WixToolset.Core/Bind/ExtractEmbeddedFilesCommand.cs +++ b/src/WixToolset.Core/Bind/ExtractEmbeddedFilesCommand.cs @@ -9,6 +9,7 @@ namespace WixToolset.Core.Bind using WixToolset.Extensibility.Data; using WixToolset.Extensibility.Services; +#pragma warning disable 1591 // TODO: this shouldn't be public, need interface in Extensibility public class ExtractEmbeddedFilesCommand { public ExtractEmbeddedFilesCommand(IBackendHelper backendHelper, IEnumerable embeddedFiles) diff --git a/src/WixToolset.Core/Bind/FileFacade.cs b/src/WixToolset.Core/Bind/FileFacade.cs index 075d3d34..ec4e9725 100644 --- a/src/WixToolset.Core/Bind/FileFacade.cs +++ b/src/WixToolset.Core/Bind/FileFacade.cs @@ -9,6 +9,7 @@ namespace WixToolset.Core.Bind using WixToolset.Data.WindowsInstaller; using WixToolset.Data.WindowsInstaller.Rows; +#pragma warning disable 1591 // TODO: this shouldn't be public, need interface in Extensibility public class FileFacade { public FileFacade(FileSymbol file, AssemblySymbol assembly) diff --git a/src/WixToolset.Core/Bind/FileResolver.cs b/src/WixToolset.Core/Bind/FileResolver.cs index ba71c6c9..eb878239 100644 --- a/src/WixToolset.Core/Bind/FileResolver.cs +++ b/src/WixToolset.Core/Bind/FileResolver.cs @@ -67,7 +67,7 @@ namespace WixToolset.Core.Bind /// Resolves the source path of a file using binder extensions. /// /// Original source value. - /// Optional type of source file being resolved. + /// Optional type of source file being resolved. /// Optional source line of source file being resolved. /// The binding stage used to determine what collection of bind paths will be used /// Optional collection of paths already checked. diff --git a/src/WixToolset.Core/Bind/ResolveDelayedFieldsCommand.cs b/src/WixToolset.Core/Bind/ResolveDelayedFieldsCommand.cs index ebabed47..14b6d011 100644 --- a/src/WixToolset.Core/Bind/ResolveDelayedFieldsCommand.cs +++ b/src/WixToolset.Core/Bind/ResolveDelayedFieldsCommand.cs @@ -10,6 +10,7 @@ namespace WixToolset.Core.Bind using WixToolset.Extensibility.Data; using WixToolset.Extensibility.Services; +#pragma warning disable 1591 // TODO: this shouldn't be public, need interface in Extensibility /// /// Resolves the fields which had variables that needed to be resolved after the file information /// was loaded. @@ -19,6 +20,7 @@ namespace WixToolset.Core.Bind /// /// Resolve delayed fields. /// + /// /// The fields which had resolution delayed. /// The file information to use when resolving variables. public ResolveDelayedFieldsCommand(IMessaging messaging, IEnumerable delayedFields, Dictionary variableCache) diff --git a/src/WixToolset.Core/CommandLine/CommandLineParser.cs b/src/WixToolset.Core/CommandLine/CommandLineParser.cs index 2ee1e9ae..1438d820 100644 --- a/src/WixToolset.Core/CommandLine/CommandLineParser.cs +++ b/src/WixToolset.Core/CommandLine/CommandLineParser.cs @@ -192,7 +192,6 @@ namespace WixToolset.Core.CommandLine /// or DirectoryInfo.GetFiles. The only way to get this directory path is manually since /// Path.GetDirectoryName does not support ".." in the path. /// - /// Throws WixFileNotFoundException if no file matching the pattern can be found. private string[] GetFiles(string searchPath, string fileType) { if (null == searchPath) diff --git a/src/WixToolset.Core/Common.cs b/src/WixToolset.Core/Common.cs index 1bb895be..79f06135 100644 --- a/src/WixToolset.Core/Common.cs +++ b/src/WixToolset.Core/Common.cs @@ -21,9 +21,21 @@ namespace WixToolset.Core public static class Common { // TODO: Find a place to put all of these so they doesn't have to be public and exposed by WixToolset.Core.dll + /// + /// + /// public const string UpgradeDetectedProperty = "WIX_UPGRADE_DETECTED"; + /// + /// + /// public const string UpgradePreventedCondition = "NOT WIX_UPGRADE_DETECTED"; + /// + /// + /// public const string DowngradeDetectedProperty = "WIX_DOWNGRADE_DETECTED"; + /// + /// + /// public const string DowngradePreventedCondition = "NOT WIX_DOWNGRADE_DETECTED"; //------------------------------------------------------------------------------------------------- @@ -51,6 +63,9 @@ namespace WixToolset.Core // GENERIC_WRITE (0x40000000L) // GENERIC_READ (0x80000000L) // TODO: Find a place to put this that it doesn't have to be public and exposed by WixToolset.Core.dll + /// + /// + /// public static readonly string[] GenericPermissions = { "GenericAll", "GenericExecute", "GenericWrite", "GenericRead" }; // Standard Access Rights (per WinNT.h) @@ -61,6 +76,9 @@ namespace WixToolset.Core // WRITE_OWNER (0x00080000L) // SYNCHRONIZE (0x00100000L) // TODO: Find a place to put this that it doesn't have to be public and exposed by WixToolset.Core.dll + /// + /// + /// public static readonly string[] StandardPermissions = { "Delete", "ReadPermission", "ChangePermission", "TakeOwnership", "Synchronize" }; // Object-Specific Access Rights @@ -77,11 +95,17 @@ namespace WixToolset.Core // FILE_READ_ATTRIBUTES ( 0x0080 ) // FILE_WRITE_ATTRIBUTES ( 0x0100 ) // TODO: Find a place to put this that it doesn't have to be public and exposed by WixToolset.Core.dll + /// + /// + /// public static readonly string[] FolderPermissions = { "Read", "CreateFile", "CreateChild", "ReadExtendedAttributes", "WriteExtendedAttributes", "Traverse", "DeleteChild", "ReadAttributes", "WriteAttributes" }; // Registry Access Rights (per TODO) // ---------------------- // TODO: Find a place to put this that it doesn't have to be public and exposed by WixToolset.Core.dll + /// + /// + /// public static readonly string[] RegistryPermissions = { "Read", "Write", "CreateSubkeys", "EnumerateSubkeys", "Notify", "CreateLink" }; // File Access Rights (per WinNT.h) @@ -99,6 +123,9 @@ namespace WixToolset.Core // STANDARD_RIGHTS_REQUIRED (0x000F0000L) // FILE_ALL_ACCESS (STANDARD_RIGHTS_REQUIRED | SYNCHRONIZE | 0x1FF) // TODO: Find a place to put this that it doesn't have to be public and exposed by WixToolset.Core.dll + /// + /// + /// public static readonly string[] FilePermissions = { "Read", "Write", "Append", "ReadExtendedAttributes", "WriteExtendedAttributes", "Execute", "FileAllRights", "ReadAttributes", "WriteAttributes" }; internal static readonly char[] IllegalLongFilenameCharacters = new[] { '\\', '/', '?', '*', '|', '>', '<', ':', '\"' }; // illegal: \ / ? | > < : / * " @@ -596,10 +623,10 @@ namespace WixToolset.Core /// /// Get an attribute value. /// + /// /// Source line information about the owner element. /// The attribute containing the value to get. /// A rule for the contents of the value. If the contents do not follow the rule, an error is thrown. - /// A delegate that receives error messages. /// The attribute's value. internal static string GetAttributeValue(IMessaging messaging, SourceLineNumber sourceLineNumbers, XAttribute attribute, EmptyRule emptyRule) { @@ -641,9 +668,9 @@ namespace WixToolset.Core /// /// Get an identifier attribute value and displays an error for an illegal identifier value. /// + /// /// Source line information about the owner element. /// The attribute containing the value to get. - /// A delegate that receives error messages. /// The attribute's identifier value or a special value if an error occurred. internal static string GetAttributeIdentifierValue(IMessaging messaging, SourceLineNumber sourceLineNumbers, XAttribute attribute) { @@ -676,11 +703,11 @@ namespace WixToolset.Core /// /// Get an integer attribute value and displays an error for an illegal integer value. /// + /// /// Source line information about the owner element. /// The attribute containing the value to get. /// The minimum legal value. /// The maximum legal value. - /// A delegate that receives error messages. /// The attribute's integer value or a special value if an error occurred during conversion. public static int GetAttributeIntegerValue(IMessaging messaging, SourceLineNumber sourceLineNumbers, XAttribute attribute, int minimum, int maximum) { @@ -715,9 +742,9 @@ namespace WixToolset.Core /// /// Gets a yes/no value and displays an error for an illegal yes/no value. /// + /// /// Source line information about the owner element. /// The attribute containing the value to get. - /// A delegate that receives error messages. /// The attribute's YesNoType value. internal static YesNoType GetAttributeYesNoValue(IMessaging messaging, SourceLineNumber sourceLineNumbers, XAttribute attribute) { @@ -833,6 +860,7 @@ namespace WixToolset.Core /// /// Display an unexpected attribute error. /// + /// /// Source line information about the owner element. /// The attribute. public static void UnexpectedAttribute(IMessaging messaging, SourceLineNumber sourceLineNumbers, XAttribute attribute) @@ -848,6 +876,7 @@ namespace WixToolset.Core /// /// Display an unsupported extension attribute error. /// + /// /// Source line information about the owner element. /// The extension attribute. internal static void UnsupportedExtensionAttribute(IMessaging messaging, SourceLineNumber sourceLineNumbers, XAttribute extensionAttribute) diff --git a/src/WixToolset.Core/Compiler.cs b/src/WixToolset.Core/Compiler.cs index addb9750..62ea8aaf 100644 --- a/src/WixToolset.Core/Compiler.cs +++ b/src/WixToolset.Core/Compiler.cs @@ -886,7 +886,7 @@ namespace WixToolset.Core /// Parses an instance element. /// /// Element to parse. - /// Identifier of instance property. + /// Identifier of instance property. private void ParseInstanceElement(XElement node, string propertyId) { var sourceLineNumbers = Preprocessor.GetSourceLineNumbers(node); @@ -1641,6 +1641,7 @@ namespace WixToolset.Core /// Parses a product search element. /// /// Element to parse. + /// /// Signature for search element. private void ParseProductSearchElement(XElement node, string propertyId) { @@ -2570,6 +2571,8 @@ namespace WixToolset.Core /// Parses a component group element. /// /// Element to parse. + /// + /// [SuppressMessage("Microsoft.Performance", "CA1800:DoNotCastUnnecessarily")] private void ParseComponentGroupElement(XElement node, ComplexReferenceParentType parentType, string parentId) { @@ -5024,6 +5027,8 @@ namespace WixToolset.Core /// Parses a feature group element. /// /// Element to parse. + /// + /// [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1800:DoNotCastUnnecessarily")] private void ParseFeatureGroupElement(XElement node, ComplexReferenceParentType parentType, string parentId) { @@ -5477,6 +5482,7 @@ namespace WixToolset.Core /// Default source path of parent directory. /// This will be set with the possible keyPath for the parent component. /// true if the component is 64-bit. + /// /// Yes if this element was marked as the parent component's key path, No if explicitly marked as not being a key path, or NotSet otherwise. [SuppressMessage("Microsoft.Performance", "CA1800:DoNotCastUnnecessarily")] private YesNoType ParseFileElement(XElement node, string componentId, string directoryId, int diskId, string sourcePath, out string possibleKeyPath, bool win64Component, string componentGuid) @@ -6934,7 +6940,7 @@ namespace WixToolset.Core /// Parses a MajorUpgrade element. /// /// The element to parse. - /// The parent element. + /// The current context. private void ParseMajorUpgradeElement(XElement node, IDictionary contextValues) { var sourceLineNumbers = Preprocessor.GetSourceLineNumbers(node); diff --git a/src/WixToolset.Core/CompilerCore.cs b/src/WixToolset.Core/CompilerCore.cs index 721eae6b..50b88e51 100644 --- a/src/WixToolset.Core/CompilerCore.cs +++ b/src/WixToolset.Core/CompilerCore.cs @@ -127,6 +127,8 @@ namespace WixToolset.Core /// Constructor for all compiler core. /// /// The Intermediate object representing compiled source document. + /// + /// /// The WiX extensions collection. internal CompilerCore(Intermediate intermediate, IMessaging messaging, IParseHelper parseHelper, Dictionary extensions) { @@ -531,7 +533,7 @@ namespace WixToolset.Core /// /// Source line information about the owner element. /// The attribute containing the value to get. - /// Whether to allow Unicode (UCS) or UTF code pages. + /// Whether to allow Unicode (UCS) or UTF code pages. /// A valid code page integer value or variable expression. [SuppressMessage("Microsoft.Design", "CA1059:MembersShouldNotExposeCertainConcreteTypes")] public string GetAttributeLocalizableCodePageValue(SourceLineNumber sourceLineNumbers, XAttribute attribute, bool onlyAnsi = false) @@ -892,7 +894,7 @@ namespace WixToolset.Core /// /// Create an identifier based on passed file name /// - /// File name to generate identifer from + /// File name to generate identifer from /// public Identifier CreateIdentifierFromFilename(string filename) { @@ -935,7 +937,7 @@ namespace WixToolset.Core /// /// Element containing element to be parsed. /// Element to be parsed. - /// Extra information about the context in which this element is being parsed. + /// Extra information about the context in which this element is being parsed. public IComponentKeyPath ParsePossibleKeyPathExtensionElement(XElement parentElement, XElement element, IDictionary context) { return this.parseHelper.ParsePossibleKeyPathExtensionElement(this.extensions.Values, this.intermediate, this.ActiveSection, parentElement, element, context); @@ -1017,6 +1019,7 @@ namespace WixToolset.Core /// Unique identifier for the section. /// Type of section to create. /// Codepage for the resulting database for this ection. + /// /// New section. internal IntermediateSection CreateActiveSection(string id, SectionType type, int codepage, string compilationId) { @@ -1034,6 +1037,7 @@ namespace WixToolset.Core /// Unique identifier for the section. /// Type of section to create. /// Codepage for the resulting database for this ection. + /// /// New section. internal IntermediateSection CreateSection(string id, SectionType type, int codepage, string compilationId) { diff --git a/src/WixToolset.Core/Compiler_2.cs b/src/WixToolset.Core/Compiler_2.cs index 1922a70b..6fd1b3c8 100644 --- a/src/WixToolset.Core/Compiler_2.cs +++ b/src/WixToolset.Core/Compiler_2.cs @@ -770,8 +770,10 @@ namespace WixToolset.Core /// Parses a package element. /// /// Element to parse. - /// Default package author. - /// The module guid - this is necessary until Module/@Guid is removed. + /// + /// + /// + /// private void ParseSummaryInformationElement(XElement node, ref bool isCodepageSet, ref bool isPackageNameSet, ref bool isKeywordsSet, ref bool isPackageAuthorSet) { var sourceLineNumbers = Preprocessor.GetSourceLineNumbers(node); @@ -3433,6 +3435,7 @@ namespace WixToolset.Core /// /// Element to parse. /// Identifier of parent component. + /// private void ParseServiceInstallElement(XElement node, string componentId, bool win64Component) { var sourceLineNumbers = Preprocessor.GetSourceLineNumbers(node); @@ -4266,6 +4269,7 @@ namespace WixToolset.Core /// Parses a shortcut property element. /// /// Element to parse. + /// private void ParseShortcutPropertyElement(XElement node, string shortcutId) { var sourceLineNumbers = Preprocessor.GetSourceLineNumbers(node); diff --git a/src/WixToolset.Core/Compiler_Bundle.cs b/src/WixToolset.Core/Compiler_Bundle.cs index 00f88c1f..0817aef3 100644 --- a/src/WixToolset.Core/Compiler_Bundle.cs +++ b/src/WixToolset.Core/Compiler_Bundle.cs @@ -436,6 +436,7 @@ namespace WixToolset.Core /// Parse a Container element. /// /// Element to parse + /// private string ParseLogElement(XElement node, string fileSystemSafeBundleName) { var sourceLineNumbers = Preprocessor.GetSourceLineNumbers(node); @@ -706,6 +707,8 @@ namespace WixToolset.Core /// Parse the BoostrapperApplication element. /// /// Element to parse + /// + /// private Identifier ParseBootstrapperApplicationDllElement(XElement node, ComplexReferenceChildType previousType, Identifier previousId) { var sourceLineNumbers = Preprocessor.GetSourceLineNumbers(node); @@ -1308,6 +1311,8 @@ namespace WixToolset.Core /// Element to parse /// ComplexReferenceParentType of parent element. (BA or PayloadGroup) /// Identifier of parent element. + /// + /// private Identifier ParsePayloadElement(XElement node, ComplexReferenceParentType parentType, Identifier parentId, ComplexReferenceChildType previousType, Identifier previousId) { Debug.Assert(ComplexReferenceParentType.PayloadGroup == parentType || ComplexReferenceParentType.Package == parentType || ComplexReferenceParentType.Container == parentType); @@ -1345,6 +1350,10 @@ namespace WixToolset.Core /// Element to parse /// ComplexReferenceParentType of parent element. /// Identifier of parent element. + /// + /// + /// + /// /// Whether SourceFile was specified. private bool ParsePayloadElementContent(XElement node, ComplexReferenceParentType parentType, Identifier parentId, ComplexReferenceChildType previousType, Identifier previousId, bool required, out Identifier id) { @@ -1519,9 +1528,21 @@ namespace WixToolset.Core /// /// Creates the row for a Payload. /// - /// Element to parse + /// + /// + /// + /// + /// /// ComplexReferenceParentType of parent element /// Identifier of parent element. + /// + /// + /// + /// + /// + /// + /// + /// private WixBundlePayloadSymbol CreatePayloadRow(SourceLineNumber sourceLineNumbers, Identifier id, string name, string sourceFile, string downloadUrl, ComplexReferenceParentType parentType, Identifier parentId, ComplexReferenceChildType previousType, Identifier previousId, YesNoDefaultType compressed, YesNoType enableSignatureVerification, string displayName, string description, RemotePayload remotePayload) @@ -1640,6 +1661,8 @@ namespace WixToolset.Core /// Element to parse. /// ComplexReferenceParentType of parent element (BA or PayloadGroup). /// Identifier of parent element. + /// + /// private Identifier ParsePayloadGroupRefElement(XElement node, ComplexReferenceParentType parentType, Identifier parentId, ComplexReferenceChildType previousType, Identifier previousId) { Debug.Assert(ComplexReferenceParentType.Layout == parentType || ComplexReferenceParentType.PayloadGroup == parentType || ComplexReferenceParentType.Package == parentType || ComplexReferenceParentType.Container == parentType); @@ -2513,6 +2536,7 @@ namespace WixToolset.Core /// Parse CommandLine element. /// /// Element to parse + /// Parent packageId private void ParseCommandLineElement(XElement node, string packageId) { var sourceLineNumbers = Preprocessor.GetSourceLineNumbers(node); @@ -2661,7 +2685,7 @@ namespace WixToolset.Core /// Element to parse. /// ComplexReferenceParentType of parent element (Unknown or PackageGroup). /// Identifier of parent element. - /// Identifier for package group element. + /// Identifier for package group element. private string ParsePackageGroupRefElement(XElement node, ComplexReferenceParentType parentType, string parentId) { return this.ParsePackageGroupRefElement(node, parentType, parentId, ComplexReferenceChildType.Unknown, null); @@ -2673,9 +2697,9 @@ namespace WixToolset.Core /// Element to parse. /// ComplexReferenceParentType of parent element (Unknown or PackageGroup). /// Identifier of parent element. - /// ComplexReferenceParentType of previous element (Unknown, Package, or PackageGroup). - /// Identifier of parent element. - /// Identifier for package group element. + /// + /// + /// Identifier for package group element. private string ParsePackageGroupRefElement(XElement node, ComplexReferenceParentType parentType, string parentId, ComplexReferenceChildType previousType, string previousId) { Debug.Assert(ComplexReferenceParentType.Unknown == parentType || ComplexReferenceParentType.PackageGroup == parentType || ComplexReferenceParentType.Container == parentType); @@ -2740,6 +2764,7 @@ namespace WixToolset.Core /// Source line numbers. /// Identifier for the rollback boundary. /// Indicates whether the rollback boundary is vital or not. + /// Indicates whether the rollback boundary will use an MSI transaction. /// Type of parent group. /// Identifier of parent group. /// Type of previous item, if any. diff --git a/src/WixToolset.Core/Compiler_EmbeddedUI.cs b/src/WixToolset.Core/Compiler_EmbeddedUI.cs index d71bb09a..ca658962 100644 --- a/src/WixToolset.Core/Compiler_EmbeddedUI.cs +++ b/src/WixToolset.Core/Compiler_EmbeddedUI.cs @@ -335,7 +335,6 @@ namespace WixToolset.Core /// Parses a embedded UI resource element. /// /// Element to parse. - /// Identifier of parent EmbeddedUI element. private void ParseEmbeddedUIResourceElement(XElement node) { var sourceLineNumbers = Preprocessor.GetSourceLineNumbers(node); diff --git a/src/WixToolset.Core/Compiler_Patch.cs b/src/WixToolset.Core/Compiler_Patch.cs index 73e7f521..eb99d5c4 100644 --- a/src/WixToolset.Core/Compiler_Patch.cs +++ b/src/WixToolset.Core/Compiler_Patch.cs @@ -319,6 +319,8 @@ namespace WixToolset.Core /// Parses a PatchFamily element. /// /// The element to parse. + /// + /// private void ParsePatchFamilyElement(XElement node, ComplexReferenceParentType parentType, string parentId) { var sourceLineNumbers = Preprocessor.GetSourceLineNumbers(node); @@ -444,6 +446,8 @@ namespace WixToolset.Core /// Parses a PatchFamilyGroup element. /// /// Element to parse. + /// + /// [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1800:DoNotCastUnnecessarily")] private void ParsePatchFamilyGroupElement(XElement node, ComplexReferenceParentType parentType, string parentId) { diff --git a/src/WixToolset.Core/Compiler_UI.cs b/src/WixToolset.Core/Compiler_UI.cs index cb1d34ac..5cc9b5a0 100644 --- a/src/WixToolset.Core/Compiler_UI.cs +++ b/src/WixToolset.Core/Compiler_UI.cs @@ -1049,12 +1049,11 @@ namespace WixToolset.Core /// /// Element to parse. /// Identifier for parent dialog. - /// Table control belongs in. + /// Table control belongs in. /// Last control in the tab order. /// Name of the first control in the tab order. /// Name of the default control. /// Name of the candle control. - /// True if the containing dialog tracks disk space. private void ParseControlElement(XElement node, string dialog, SymbolDefinitionType symbolType, ref ControlSymbol lastTabSymbol, ref string firstControl, ref string defaultControl, ref string cancelControl) { var sourceLineNumbers = Preprocessor.GetSourceLineNumbers(node); diff --git a/src/WixToolset.Core/ExtensibilityServices/ParseHelper.cs b/src/WixToolset.Core/ExtensibilityServices/ParseHelper.cs index de5595e1..6a71c4e9 100644 --- a/src/WixToolset.Core/ExtensibilityServices/ParseHelper.cs +++ b/src/WixToolset.Core/ExtensibilityServices/ParseHelper.cs @@ -149,12 +149,6 @@ namespace WixToolset.Core.ExtensibilityServices return suffix == null ? null : name + suffix; } - [Obsolete] - public Identifier CreateRegistryRow(IntermediateSection section, SourceLineNumber sourceLineNumbers, RegistryRootType root, string key, string name, string value, string componentId, bool escapeLeadingHash) - { - return this.CreateRegistrySymbol(section, sourceLineNumbers, root, key, name, value, componentId, escapeLeadingHash); - } - public Identifier CreateRegistrySymbol(IntermediateSection section, SourceLineNumber sourceLineNumbers, RegistryRootType root, string key, string name, string value, string componentId, bool escapeLeadingHash) { if (RegistryRootType.Unknown == root) @@ -220,12 +214,6 @@ namespace WixToolset.Core.ExtensibilityServices this.CreateSimpleReference(section, sourceLineNumbers, symbolDefinition.Name, primaryKeys); } - [Obsolete] - public void CreateWixGroupRow(IntermediateSection section, SourceLineNumber sourceLineNumbers, ComplexReferenceParentType parentType, string parentId, ComplexReferenceChildType childType, string childId) - { - this.CreateWixGroupSymbol(section, sourceLineNumbers, parentType, parentId, childType, childId); - } - public void CreateWixGroupSymbol(IntermediateSection section, SourceLineNumber sourceLineNumbers, ComplexReferenceParentType parentType, string parentId, ComplexReferenceChildType childType, string childId) { if (null == parentId || ComplexReferenceParentType.Unknown == parentType) @@ -284,18 +272,6 @@ namespace WixToolset.Core.ExtensibilityServices }); } - [Obsolete] - public IntermediateSymbol CreateRow(IntermediateSection section, SourceLineNumber sourceLineNumbers, string tableName, Identifier identifier = null) - { - return this.CreateSymbol(section, sourceLineNumbers, tableName, identifier); - } - - [Obsolete] - public IntermediateSymbol CreateRow(IntermediateSection section, SourceLineNumber sourceLineNumbers, SymbolDefinitionType symbolType, Identifier identifier = null) - { - return this.CreateSymbol(section, sourceLineNumbers, symbolType, identifier); - } - public IntermediateSymbol CreateSymbol(IntermediateSection section, SourceLineNumber sourceLineNumbers, string symbolName, Identifier identifier = null) { if (this.Creator == null) @@ -311,14 +287,6 @@ namespace WixToolset.Core.ExtensibilityServices return this.CreateSymbol(section, sourceLineNumbers, symbolDefinition, identifier); } - [Obsolete] - public IntermediateSymbol CreateSymbol(IntermediateSection section, SourceLineNumber sourceLineNumbers, SymbolDefinitionType symbolType, Identifier identifier = null) - { - var symbolDefinition = SymbolDefinitions.ByType(symbolType); - - return this.CreateSymbol(section, sourceLineNumbers, symbolDefinition, identifier); - } - public IntermediateSymbol CreateSymbol(IntermediateSection section, SourceLineNumber sourceLineNumbers, IntermediateSymbolDefinition symbolDefinition, Identifier identifier = null) { return section.AddSymbol(symbolDefinition.CreateSymbol(sourceLineNumbers, identifier)); diff --git a/src/WixToolset.Core/ExtensibilityServices/Uuid.cs b/src/WixToolset.Core/ExtensibilityServices/Uuid.cs index a5692b71..ad9eea26 100644 --- a/src/WixToolset.Core/ExtensibilityServices/Uuid.cs +++ b/src/WixToolset.Core/ExtensibilityServices/Uuid.cs @@ -17,7 +17,6 @@ namespace WixToolset.Core.ExtensibilityServices /// /// The namespace UUID. /// The value. - /// Flag to say to use MD5 instead of better SHA1. /// The UUID for the given namespace and value. public static Guid NewUuid(Guid namespaceGuid, string value) { diff --git a/src/WixToolset.Core/IBinder.cs b/src/WixToolset.Core/IBinder.cs index c2ebc2a0..ec7ca4f5 100644 --- a/src/WixToolset.Core/IBinder.cs +++ b/src/WixToolset.Core/IBinder.cs @@ -4,7 +4,7 @@ namespace WixToolset.Core { using WixToolset.Extensibility.Data; - public interface IBinder + internal interface IBinder { IBindResult Bind(IBindContext context); } diff --git a/src/WixToolset.Core/ICompiler.cs b/src/WixToolset.Core/ICompiler.cs index a2c4a6e8..34a9a94a 100644 --- a/src/WixToolset.Core/ICompiler.cs +++ b/src/WixToolset.Core/ICompiler.cs @@ -1,11 +1,11 @@ -// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. +// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. namespace WixToolset.Core { using WixToolset.Data; using WixToolset.Extensibility.Data; - public interface ICompiler + internal interface ICompiler { Intermediate Compile(ICompileContext context); } diff --git a/src/WixToolset.Core/IDecompiler.cs b/src/WixToolset.Core/IDecompiler.cs index 05b04be2..fdb8c2d0 100644 --- a/src/WixToolset.Core/IDecompiler.cs +++ b/src/WixToolset.Core/IDecompiler.cs @@ -4,7 +4,7 @@ namespace WixToolset.Core { using WixToolset.Extensibility.Data; - public interface IDecompiler + internal interface IDecompiler { IDecompileResult Decompile(IDecompileContext context); } diff --git a/src/WixToolset.Core/ILayoutCreator.cs b/src/WixToolset.Core/ILayoutCreator.cs index f58d0aad..6b65e60f 100644 --- a/src/WixToolset.Core/ILayoutCreator.cs +++ b/src/WixToolset.Core/ILayoutCreator.cs @@ -1,10 +1,10 @@ -// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. +// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. namespace WixToolset.Core { using WixToolset.Extensibility.Data; - public interface ILayoutCreator + internal interface ILayoutCreator { void Layout(ILayoutContext context); } diff --git a/src/WixToolset.Core/ILibrarian.cs b/src/WixToolset.Core/ILibrarian.cs index 3e951e65..fa1dd816 100644 --- a/src/WixToolset.Core/ILibrarian.cs +++ b/src/WixToolset.Core/ILibrarian.cs @@ -1,11 +1,11 @@ -// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. +// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. namespace WixToolset.Core { using WixToolset.Data; using WixToolset.Extensibility.Data; - public interface ILibrarian + internal interface ILibrarian { Intermediate Combine(ILibraryContext context); } diff --git a/src/WixToolset.Core/ILinker.cs b/src/WixToolset.Core/ILinker.cs index 0580bf46..6a7fe0f7 100644 --- a/src/WixToolset.Core/ILinker.cs +++ b/src/WixToolset.Core/ILinker.cs @@ -1,10 +1,11 @@ -// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. +// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. namespace WixToolset.Core { using WixToolset.Data; using WixToolset.Extensibility.Data; +#pragma warning disable 1591 // TODO: add documentation, move into Extensibility public interface ILinker { Intermediate Link(ILinkContext context); diff --git a/src/WixToolset.Core/IPreprocessor.cs b/src/WixToolset.Core/IPreprocessor.cs index 151f8111..f6ed5fed 100644 --- a/src/WixToolset.Core/IPreprocessor.cs +++ b/src/WixToolset.Core/IPreprocessor.cs @@ -5,6 +5,7 @@ namespace WixToolset.Core using System.Xml; using WixToolset.Extensibility.Data; +#pragma warning disable 1591 // TODO: add documentation, move into Extensibility public interface IPreprocessor { IPreprocessResult Preprocess(IPreprocessContext context); diff --git a/src/WixToolset.Core/IResolver.cs b/src/WixToolset.Core/IResolver.cs index c5b2568f..661972c4 100644 --- a/src/WixToolset.Core/IResolver.cs +++ b/src/WixToolset.Core/IResolver.cs @@ -4,7 +4,7 @@ namespace WixToolset.Core { using WixToolset.Extensibility.Data; - public interface IResolver + internal interface IResolver { IResolveResult Resolve(IResolveContext context); } diff --git a/src/WixToolset.Core/Inscriber.cs b/src/WixToolset.Core/Inscriber.cs index 649e1661..cff2dab2 100644 --- a/src/WixToolset.Core/Inscriber.cs +++ b/src/WixToolset.Core/Inscriber.cs @@ -10,10 +10,10 @@ namespace WixToolset.Core /// internal class Inscriber { - /// - /// Gets or sets the temp files collection. - /// - /// The temp files collection. + // + // Gets or sets the temp files collection. + // + // The temp files collection. // public TempFileCollection TempFiles // { // get { return this.tempFiles; } diff --git a/src/WixToolset.Core/LayoutCreator.cs b/src/WixToolset.Core/LayoutCreator.cs index 16fdd70f..0da18ab5 100644 --- a/src/WixToolset.Core/LayoutCreator.cs +++ b/src/WixToolset.Core/LayoutCreator.cs @@ -85,7 +85,7 @@ namespace WixToolset.Core /// Writes the paths to the content files to a text file. /// /// Path to write file. - /// Collection of paths to content files that will be written to file. + /// Collection of paths to content files that will be written to file. private void CreateContentsFile(string path, IEnumerable trackedFiles) { var uniqueInputFilePaths = new SortedSet(trackedFiles.Where(t => t.Type == TrackedFileType.Input).Select(t => t.Path), StringComparer.OrdinalIgnoreCase); @@ -111,7 +111,7 @@ namespace WixToolset.Core /// Writes the paths to the output files to a text file. /// /// Path to write file. - /// Collection of files that were transferred to the output directory. + /// Collection of files that were transferred to the output directory. private void CreateOutputsFile(string path, IEnumerable trackedFiles) { var uniqueOutputPaths = new SortedSet(trackedFiles.Where(t => t.Clean).Select(t => t.Path), StringComparer.OrdinalIgnoreCase); @@ -142,7 +142,7 @@ namespace WixToolset.Core /// Writes the paths to the built output files to a text file. /// /// Path to write file. - /// Collection of files that were transferred to the output directory. + /// Collection of files that were transferred to the output directory. private void CreateBuiltOutputsFile(string path, IEnumerable trackedFiles) { var uniqueBuiltPaths = new SortedSet(trackedFiles.Where(t => t.Type == TrackedFileType.Final).Select(t => t.Path), StringComparer.OrdinalIgnoreCase); diff --git a/src/WixToolset.Core/Link/SymbolWithSection.cs b/src/WixToolset.Core/Link/SymbolWithSection.cs index c8934d0f..08e01077 100644 --- a/src/WixToolset.Core/Link/SymbolWithSection.cs +++ b/src/WixToolset.Core/Link/SymbolWithSection.cs @@ -18,6 +18,7 @@ namespace WixToolset.Core.Link /// /// Creates a symbol for a symbol. /// + /// /// Symbol for the symbol public SymbolWithSection(IntermediateSection section, IntermediateSymbol symbol) { diff --git a/src/WixToolset.Core/Link/WixComplexReferenceSymbolExtensions.cs b/src/WixToolset.Core/Link/WixComplexReferenceSymbolExtensions.cs index 1702d3ca..2b1925ad 100644 --- a/src/WixToolset.Core/Link/WixComplexReferenceSymbolExtensions.cs +++ b/src/WixToolset.Core/Link/WixComplexReferenceSymbolExtensions.cs @@ -1,4 +1,4 @@ -// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. +// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. namespace WixToolset.Core.Link { @@ -27,7 +27,8 @@ namespace WixToolset.Core.Link /// /// Compares two complex references without considering the primary bit. /// - /// Complex reference to compare to. + /// this + /// Complex reference to compare to. /// Zero if the objects are equivalent, negative number if the provided object is less, positive if greater. public static int CompareToWithoutConsideringPrimary(this WixComplexReferenceSymbol symbol, WixComplexReferenceSymbol other) { @@ -57,6 +58,7 @@ namespace WixToolset.Core.Link /// /// Changes all of the parent references to point to the passed in parent reference. /// + /// this /// New parent complex reference. public static void Reparent(this WixComplexReferenceSymbol symbol, WixComplexReferenceSymbol parent) { diff --git a/src/WixToolset.Core/Link/WixGroupingOrdering.cs b/src/WixToolset.Core/Link/WixGroupingOrdering.cs index a7013062..a8044a0c 100644 --- a/src/WixToolset.Core/Link/WixGroupingOrdering.cs +++ b/src/WixToolset.Core/Link/WixGroupingOrdering.cs @@ -29,10 +29,8 @@ namespace WixToolset.Core.Link /// /// Creates a WixGroupingOrdering object. /// - /// Output from which to read the group and order information. + /// Output from which to read the group and order information. /// Handler for any error messages. - /// Group types to include. - /// Item types to include. public WixGroupingOrdering(IntermediateSection entrySections, IMessaging messageHandler) { this.EntrySection = entrySections; @@ -582,7 +580,7 @@ namespace WixToolset.Core.Link /// /// Adds an item to the 'after' ordering collection. /// - /// Items to add. + /// Item to add. /// Message handler in case a circular ordering reference is found. public void AddAfter(Item after, IMessaging messageHandler) { diff --git a/src/WixToolset.Core/Linker.cs b/src/WixToolset.Core/Linker.cs index 86eb7a3d..e9f9554c 100644 --- a/src/WixToolset.Core/Linker.cs +++ b/src/WixToolset.Core/Linker.cs @@ -1219,7 +1219,7 @@ namespace WixToolset.Core /// /// Flattens the tables used in a Bundle. /// - /// Output containing the tables to process. + /// Output containing the tables to process. private void FlattenBundleTables(IntermediateSection entrySection) { if (SectionType.Bundle != entrySection.Type) diff --git a/src/WixToolset.Core/LocalizationParser.cs b/src/WixToolset.Core/LocalizationParser.cs index 3b66b707..a0cf38a9 100644 --- a/src/WixToolset.Core/LocalizationParser.cs +++ b/src/WixToolset.Core/LocalizationParser.cs @@ -63,6 +63,7 @@ namespace WixToolset.Core /// /// Adds a WixVariableRow to a dictionary while performing the expected override checks. /// + /// /// Dictionary of variable rows. /// Row to add to the variables dictionary. private static void AddWixVariable(IMessaging messaging, IDictionary variables, BindVariable wixVariableRow) @@ -80,6 +81,7 @@ namespace WixToolset.Core /// /// Parses the WixLocalization element. /// + /// /// Element to parse. private static Localization ParseWixLocalizationElement(IMessaging messaging, XElement node) { @@ -147,7 +149,9 @@ namespace WixToolset.Core /// /// Parse a localization string into a WixVariableRow. /// + /// /// Element to parse. + /// private static void ParseString(IMessaging messaging, XElement node, IDictionary variables) { string id = null; @@ -208,6 +212,7 @@ namespace WixToolset.Core /// /// Parse a localized control. /// + /// /// Element to parse. /// Dictionary of localized controls. private static void ParseUI(IMessaging messaging, XElement node, IDictionary localizedControls) diff --git a/src/WixToolset.Core/PatchSymbolFlagsType.cs b/src/WixToolset.Core/PatchSymbolFlagsType.cs index eeb5c798..e751fd18 100644 --- a/src/WixToolset.Core/PatchSymbolFlagsType.cs +++ b/src/WixToolset.Core/PatchSymbolFlagsType.cs @@ -1,19 +1,34 @@ -// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. +// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. namespace WixToolset.Core { using System; - // - // The following flags are used with PATCH_OPTION_DATA SymbolOptionFlags: - // + /// + /// The following flags are used with PATCH_OPTION_DATA SymbolOptionFlags: + /// [Flags] public enum PatchSymbolFlagsType : uint { - PATCH_SYMBOL_NO_IMAGEHLP = 0x00000001, // don't use imagehlp.dll - PATCH_SYMBOL_NO_FAILURES = 0x00000002, // don't fail patch due to imagehlp failures - PATCH_SYMBOL_UNDECORATED_TOO = 0x00000004, // after matching decorated symbols, try to match remaining by undecorated names - PATCH_SYMBOL_RESERVED1 = 0x80000000, // (used internally) + /// + /// don't use imagehlp.dll + /// + PATCH_SYMBOL_NO_IMAGEHLP = 0x00000001, + /// + /// don't fail patch due to imagehlp failures + /// + PATCH_SYMBOL_NO_FAILURES = 0x00000002, + /// + /// after matching decorated symbols, try to match remaining by undecorated names + /// + PATCH_SYMBOL_UNDECORATED_TOO = 0x00000004, + /// + /// (used internally) + /// + PATCH_SYMBOL_RESERVED1 = 0x80000000, + /// + /// + /// MaxValue = PATCH_SYMBOL_NO_IMAGEHLP | PATCH_SYMBOL_NO_FAILURES | PATCH_SYMBOL_UNDECORATED_TOO } } diff --git a/src/WixToolset.Core/Preprocess/IfDefEventHandler.cs b/src/WixToolset.Core/Preprocess/IfDefEventHandler.cs index ff181d61..6b56638a 100644 --- a/src/WixToolset.Core/Preprocess/IfDefEventHandler.cs +++ b/src/WixToolset.Core/Preprocess/IfDefEventHandler.cs @@ -5,9 +5,9 @@ namespace WixToolset.Core.Preprocess using System; using WixToolset.Data; - public delegate void IfDefEventHandler(object sender, IfDefEventArgs e); + internal delegate void IfDefEventHandler(object sender, IfDefEventArgs e); - public class IfDefEventArgs : EventArgs + internal class IfDefEventArgs : EventArgs { public IfDefEventArgs(SourceLineNumber sourceLineNumbers, bool isIfDef, bool isDefined, string variableName) { diff --git a/src/WixToolset.Core/Preprocess/IncludedFileEventHandler.cs b/src/WixToolset.Core/Preprocess/IncludedFileEventHandler.cs index beba216d..3c8ff2e8 100644 --- a/src/WixToolset.Core/Preprocess/IncludedFileEventHandler.cs +++ b/src/WixToolset.Core/Preprocess/IncludedFileEventHandler.cs @@ -9,13 +9,13 @@ namespace WixToolset.Core.Preprocess /// Included file event handler delegate. /// /// Sender of the message. - /// Arguments for the included file event. - public delegate void IncludedFileEventHandler(object sender, IncludedFileEventArgs e); + /// Arguments for the included file event. + internal delegate void IncludedFileEventHandler(object sender, IncludedFileEventArgs e); /// /// Event args for included file event. /// - public class IncludedFileEventArgs : EventArgs + internal class IncludedFileEventArgs : EventArgs { /// /// Creates a new IncludedFileEventArgs. diff --git a/src/WixToolset.Core/Preprocess/ProcessedStreamEventHandler.cs b/src/WixToolset.Core/Preprocess/ProcessedStreamEventHandler.cs index b2a4ddb1..672b4b9f 100644 --- a/src/WixToolset.Core/Preprocess/ProcessedStreamEventHandler.cs +++ b/src/WixToolset.Core/Preprocess/ProcessedStreamEventHandler.cs @@ -9,13 +9,13 @@ namespace WixToolset.Core.Preprocess /// Preprocessed output stream event handler delegate. /// /// Sender of the message. - /// Arguments for the preprocessed stream event. - public delegate void ProcessedStreamEventHandler(object sender, ProcessedStreamEventArgs e); + /// Arguments for the preprocessed stream event. + internal delegate void ProcessedStreamEventHandler(object sender, ProcessedStreamEventArgs e); /// /// Event args for preprocessed stream event. /// - public class ProcessedStreamEventArgs : EventArgs + internal class ProcessedStreamEventArgs : EventArgs { /// /// Creates a new ProcessedStreamEventArgs. diff --git a/src/WixToolset.Core/Preprocess/ResolvedVariableEventHandler.cs b/src/WixToolset.Core/Preprocess/ResolvedVariableEventHandler.cs index df3a7e6a..6d159ad0 100644 --- a/src/WixToolset.Core/Preprocess/ResolvedVariableEventHandler.cs +++ b/src/WixToolset.Core/Preprocess/ResolvedVariableEventHandler.cs @@ -5,9 +5,9 @@ namespace WixToolset.Core.Preprocess using System; using WixToolset.Data; - public delegate void ResolvedVariableEventHandler(object sender, ResolvedVariableEventArgs e); + internal delegate void ResolvedVariableEventHandler(object sender, ResolvedVariableEventArgs e); - public class ResolvedVariableEventArgs : EventArgs + internal class ResolvedVariableEventArgs : EventArgs { public ResolvedVariableEventArgs(SourceLineNumber sourceLineNumbers, string variableName, string variableValue) { diff --git a/src/WixToolset.Core/PreprocessResult.cs b/src/WixToolset.Core/PreprocessResult.cs index 8595d21d..7126f049 100644 --- a/src/WixToolset.Core/PreprocessResult.cs +++ b/src/WixToolset.Core/PreprocessResult.cs @@ -6,7 +6,7 @@ namespace WixToolset.Core using System.Xml.Linq; using WixToolset.Extensibility.Data; - public class PreprocessResult : IPreprocessResult + internal class PreprocessResult : IPreprocessResult { public XDocument Document { get; set; } diff --git a/src/WixToolset.Core/Preprocessor.cs b/src/WixToolset.Core/Preprocessor.cs index c6cd3801..b111b291 100644 --- a/src/WixToolset.Core/Preprocessor.cs +++ b/src/WixToolset.Core/Preprocessor.cs @@ -63,10 +63,10 @@ namespace WixToolset.Core /// public event ProcessedStreamEventHandler ProcessedStream; - /// - /// Event for resolved variables. - /// - /// TOOD: Remove? + // + // Event for resolved variables. + // + // TOOD: Remove? //public event ResolvedVariableEventHandler ResolvedVariable; /// @@ -134,7 +134,7 @@ namespace WixToolset.Core /// /// Preprocesses a file. /// - /// The preprocessing context. + /// The preprocessing context. /// XmlReader to processing the context. /// XDocument with the postprocessed data. private IPreprocessResult Process(ProcessingState state, XmlReader reader) @@ -266,6 +266,7 @@ namespace WixToolset.Core /// /// Processes an xml reader into an xml writer. /// + /// /// Specifies if reader is from an included file. /// Reader for the source document. /// Node where content should be added. @@ -546,6 +547,7 @@ namespace WixToolset.Core /// /// Processes an error processing instruction. /// + /// /// Text from source. private void PreprocessError(ProcessingState state, string errorMessage) { @@ -558,6 +560,7 @@ namespace WixToolset.Core /// /// Processes a warning processing instruction. /// + /// /// Text from source. private void PreprocessWarning(ProcessingState state, string warningMessage) { @@ -570,6 +573,7 @@ namespace WixToolset.Core /// /// Processes a define processing instruction and creates the appropriate parameter. /// + /// /// Text from source. private void PreprocessDefine(ProcessingState state, string originalDefine) { @@ -607,6 +611,7 @@ namespace WixToolset.Core /// /// Processes an undef processing instruction and creates the appropriate parameter. /// + /// /// Text from source. private void PreprocessUndef(ProcessingState state, string originalDefine) { @@ -625,6 +630,7 @@ namespace WixToolset.Core /// /// Processes an included file. /// + /// /// Path to included file. /// Parent container for included content. private void PreprocessInclude(ProcessingState state, string includePath, XContainer parent) @@ -671,6 +677,7 @@ namespace WixToolset.Core /// /// Preprocess a foreach processing instruction. /// + /// /// The xml reader. /// The container where to output processed data. /// Offset for the line numbers. @@ -785,7 +792,9 @@ namespace WixToolset.Core /// /// Processes a pragma processing instruction /// + /// /// Text from source. + /// private void PreprocessPragma(ProcessingState state, string pragmaText, XContainer parent) { var match = PragmaRegex.Match(pragmaText); @@ -811,6 +820,7 @@ namespace WixToolset.Core /// /// Gets the next token in an expression. /// + /// /// Expression to parse. /// Expression with token removed. /// Flag if token is a string literal instead of a variable. @@ -958,6 +968,7 @@ namespace WixToolset.Core /// /// Gets the value for a variable. /// + /// /// Original expression for error message. /// Variable to evaluate. /// Value of variable. @@ -996,6 +1007,7 @@ namespace WixToolset.Core /// /// Gets the left side value, operator, and right side value of an expression. /// + /// /// Original expression to evaluate. /// Expression modified while processing. /// Left side value from expression. @@ -1048,6 +1060,7 @@ namespace WixToolset.Core /// /// Evaluates an expression. /// + /// /// Original expression to evaluate. /// Expression modified while processing. /// true if expression evaluates to true. @@ -1143,6 +1156,7 @@ namespace WixToolset.Core /// /// Gets a sub-expression in parenthesis. /// + /// /// Original expression to evaluate. /// Expression modified while processing. /// Index of end of sub-expression. @@ -1197,6 +1211,7 @@ namespace WixToolset.Core /// /// Updates expression based on operation. /// + /// /// State to update. /// Operation to apply to current value. /// Previous result. @@ -1221,6 +1236,7 @@ namespace WixToolset.Core /// /// Evaluate an expression. /// + /// /// Expression to evaluate. /// Boolean result of expression. private bool EvaluateExpression(ProcessingState state, string expression) @@ -1252,6 +1268,7 @@ namespace WixToolset.Core /// $(var.A) and $(var.B)>2 or $(var.B) <= 2 /// $(var.A) != "2" /// + /// /// The original expression /// The expression currently being evaluated /// The operation to apply to this result @@ -1322,6 +1339,7 @@ namespace WixToolset.Core /// /// Update the current line number with the reader's current state. /// + /// /// The xml reader for the preprocessor. /// This is the artificial offset of the line numbers from the reader. Used for the foreach processing. private void UpdateCurrentLineNumber(ProcessingState state, XmlReader reader, int offset) @@ -1341,6 +1359,7 @@ namespace WixToolset.Core /// /// Pushes a file name on the stack of included files. /// + /// /// Name to push on to the stack of included files. private void PushInclude(ProcessingState state, string fileName) { @@ -1374,6 +1393,7 @@ namespace WixToolset.Core /// through the search paths in the order given on the command line /// (leftmost first, ...). /// + /// /// User-specified path to the included file (usually just the file name). /// Returns a FileInfo for the found include file, or null if the file cannot be found. private string GetIncludeFile(ProcessingState state, string includePath) diff --git a/src/WixToolset.Core/ResolveFileResult.cs b/src/WixToolset.Core/ResolveFileResult.cs index e36c474a..12b31d54 100644 --- a/src/WixToolset.Core/ResolveFileResult.cs +++ b/src/WixToolset.Core/ResolveFileResult.cs @@ -5,7 +5,7 @@ namespace WixToolset.Core using System.Collections.Generic; using WixToolset.Extensibility.Data; - public class ResolveFileResult : IResolveFileResult + internal class ResolveFileResult : IResolveFileResult { public string Path { get; set; } diff --git a/src/WixToolset.Core/WixToolset.Core.csproj b/src/WixToolset.Core/WixToolset.Core.csproj index 3952f97c..947c445f 100644 --- a/src/WixToolset.Core/WixToolset.Core.csproj +++ b/src/WixToolset.Core/WixToolset.Core.csproj @@ -9,6 +9,8 @@ WiX Toolset Core embedded true + true + true diff --git a/src/WixToolset.Core/WixToolsetServiceProviderFactory.cs b/src/WixToolset.Core/WixToolsetServiceProviderFactory.cs index 51e7a447..8e07070b 100644 --- a/src/WixToolset.Core/WixToolsetServiceProviderFactory.cs +++ b/src/WixToolset.Core/WixToolsetServiceProviderFactory.cs @@ -4,8 +4,15 @@ namespace WixToolset.Core { using WixToolset.Extensibility.Services; + /// + /// Class for creating . + /// public static class WixToolsetServiceProviderFactory { + /// + /// Creates a new . + /// + /// The created public static IWixToolsetCoreServiceProvider CreateServiceProvider() { return new WixToolsetServiceProvider(); -- cgit v1.2.3-55-g6feb