diff --git a/src/Microsoft.Build.Utilities.ProjectCreation.UnitTests/ExtensibilityTests.cs b/src/Microsoft.Build.Utilities.ProjectCreation.UnitTests/ExtensibilityTests.cs index 08a89c5..83e7e1f 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation.UnitTests/ExtensibilityTests.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation.UnitTests/ExtensibilityTests.cs @@ -11,7 +11,7 @@ namespace Microsoft.Build.Utilities.ProjectCreation.UnitTests public class ExtensibilityTests : MSBuildTestBase { /// - /// Proves that can be extended by and end user through extension methods. + /// Proves that can be extended by and end user through extension methods. /// [Fact] public void CustomExtensionMethod() diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/BuildEngine.cs b/src/Microsoft.Build.Utilities.ProjectCreation/BuildEngine.cs index 5a8cc4e..babb511 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/BuildEngine.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/BuildEngine.cs @@ -9,7 +9,7 @@ namespace Microsoft.Build.Utilities.ProjectCreation { /// - /// Represents an implementation of that allows for capturing logged events in tasks. + /// Represents an implementation of that allows for capturing logged events in tasks. /// public sealed class BuildEngine : BuildEventArgsCollection, IBuildEngine { @@ -17,43 +17,43 @@ private BuildEngine() { } - /// + /// public int ColumnNumberOfTaskNode => 0; - /// + /// public bool ContinueOnError => false; - /// + /// public int LineNumberOfTaskNode => 0; - /// + /// public string? ProjectFileOfTaskNode => null; /// - /// Creates an instance of the class. + /// Creates an instance of the class. /// - /// A instance. + /// A instance. public static BuildEngine Create() { return new BuildEngine(); } - /// + /// public bool BuildProjectFile(string projectFileName, string[] targetNames, IDictionary globalProperties, IDictionary targetOutputs) { throw new NotSupportedException(); } - /// + /// public void LogCustomEvent(CustomBuildEventArgs e) => Add(e); - /// + /// public void LogErrorEvent(BuildErrorEventArgs e) => Add(e); - /// + /// public void LogMessageEvent(BuildMessageEventArgs e) => Add(e); - /// + /// public void LogWarningEvent(BuildWarningEventArgs e) => Add(e); } } \ No newline at end of file diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/BuildEventArgsCollection.cs b/src/Microsoft.Build.Utilities.ProjectCreation/BuildEventArgsCollection.cs index e2892b5..11776cf 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/BuildEventArgsCollection.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/BuildEventArgsCollection.cs @@ -13,7 +13,7 @@ namespace Microsoft.Build.Utilities.ProjectCreation { /// - /// Represents a collection of objects. + /// Represents a collection of objects. /// public abstract class BuildEventArgsCollection : IDisposable { @@ -38,7 +38,7 @@ public abstract class BuildEventArgsCollection : IDisposable private readonly ConcurrentQueue _allEvents = new ConcurrentQueue(); /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// protected BuildEventArgsCollection() { @@ -67,7 +67,7 @@ protected BuildEventArgsCollection() public BuildMessageEventArgsCollection MessageEvents { get; } /// - /// Gets a object that gets the messages from the build. + /// Gets a object that gets the messages from the build. /// public BuildMessageCollection Messages { get; } @@ -81,7 +81,7 @@ protected BuildEventArgsCollection() /// public IReadOnlyCollection Warnings => _warningEvents.Select(i => i.Message).ToList(); - /// + /// public virtual void Dispose() { _errorEvents.Clear(); @@ -160,7 +160,7 @@ public string GetConsoleLog(LoggerVerbosity verbosity = LoggerVerbosity.Normal) /// /// Adds a build event. /// - /// A object to add. + /// A object to add. protected void Add(BuildEventArgs buildEventArgs) { _allEvents.Enqueue(buildEventArgs); diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/BuildMessageCollection.cs b/src/Microsoft.Build.Utilities.ProjectCreation/BuildMessageCollection.cs index 05851e8..d1d606f 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/BuildMessageCollection.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/BuildMessageCollection.cs @@ -18,39 +18,39 @@ public sealed class BuildMessageCollection : IReadOnlyCollection private readonly BuildEventArgsCollection _buildOutput; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// - /// The object that has message events. + /// The object that has message events. internal BuildMessageCollection(BuildEventArgsCollection buildOutput) { _buildOutput = buildOutput ?? throw new ArgumentNullException(nameof(buildOutput)); } - /// + /// public int Count => _buildOutput.MessageEvents.Count; /// - /// Gets the messages that were logged with . + /// Gets the messages that were logged with . /// public IReadOnlyCollection High => _buildOutput.MessageEvents.High.Select(i => i.Message).ToList(); /// - /// Gets the messages that were logged with . + /// Gets the messages that were logged with . /// public IReadOnlyCollection Low => _buildOutput.MessageEvents.Low.Select(i => i.Message).ToList(); /// - /// Gets the messages that were logged with . + /// Gets the messages that were logged with . /// public IReadOnlyCollection Normal => _buildOutput.MessageEvents.Normal.Select(i => i.Message).ToList(); - /// + /// public IEnumerator GetEnumerator() { return _buildOutput.MessageEvents.Select(i => i.Message).ToList().GetEnumerator(); } - /// + /// IEnumerator IEnumerable.GetEnumerator() { return GetEnumerator(); diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/BuildMessageEventArgsCollection.cs b/src/Microsoft.Build.Utilities.ProjectCreation/BuildMessageEventArgsCollection.cs index 8b12a07..e3e3cc2 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/BuildMessageEventArgsCollection.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/BuildMessageEventArgsCollection.cs @@ -11,46 +11,46 @@ namespace Microsoft.Build.Utilities.ProjectCreation { /// - /// Represents the that were logged. + /// Represents the that were logged. /// public sealed class BuildMessageEventArgsCollection : IReadOnlyCollection { private readonly IReadOnlyCollection _messageEvents; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// - /// A containing the logged message events. + /// A containing the logged message events. internal BuildMessageEventArgsCollection(IReadOnlyCollection messageEvents) { _messageEvents = messageEvents ?? throw new ArgumentNullException(nameof(messageEvents)); } - /// + /// public int Count => _messageEvents.Count; /// - /// Gets the that were logged with . + /// Gets the that were logged with . /// public IReadOnlyCollection High => _messageEvents.Where(i => i.Importance == MessageImportance.High).ToList(); /// - /// Gets the that were logged with . + /// Gets the that were logged with . /// public IReadOnlyCollection Low => _messageEvents.Where(i => i.Importance == MessageImportance.Low).ToList(); /// - /// Gets the that were logged with . + /// Gets the that were logged with . /// public IReadOnlyCollection Normal => _messageEvents.Where(i => i.Importance == MessageImportance.Normal).ToList(); - /// + /// public IEnumerator GetEnumerator() { return _messageEvents.GetEnumerator(); } - /// + /// IEnumerator IEnumerable.GetEnumerator() { return GetEnumerator(); diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/BuildOutput.cs b/src/Microsoft.Build.Utilities.ProjectCreation/BuildOutput.cs index 179d139..824acb0 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/BuildOutput.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/BuildOutput.cs @@ -20,7 +20,7 @@ public sealed class BuildOutput : BuildEventArgsCollection, ILogger private readonly ConcurrentDictionary _resultsByProject = new ConcurrentDictionary(StringComparer.OrdinalIgnoreCase); /// - /// Stores the that were logged when the build finished. + /// Stores the that were logged when the build finished. /// private BuildFinishedEventArgs? _buildFinished; @@ -29,7 +29,7 @@ private BuildOutput() Parameters = string.Empty; } - /// + /// public string Parameters { get; set; } /// @@ -42,19 +42,19 @@ private BuildOutput() /// public bool? Succeeded => _buildFinished?.Succeeded; - /// + /// public LoggerVerbosity Verbosity { get; set; } /// - /// Creates an instance of the class. + /// Creates an instance of the class. /// - /// A instance. + /// A instance. public static BuildOutput Create() { return new BuildOutput(); } - /// + /// public override void Dispose() { _buildFinished = null; @@ -62,7 +62,7 @@ public override void Dispose() base.Dispose(); } - /// + /// public void Initialize(IEventSource eventSource) { eventSource.BuildFinished += OnBuildFinished; @@ -70,7 +70,7 @@ public void Initialize(IEventSource eventSource) eventSource.AnyEventRaised += OnAnyEventRaised; } - /// + /// public void Shutdown() { } diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/ExtensionMethods.cs b/src/Microsoft.Build.Utilities.ProjectCreation/ExtensionMethods.cs index 3925597..c1268b9 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/ExtensionMethods.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/ExtensionMethods.cs @@ -13,14 +13,14 @@ namespace Microsoft.Build.Utilities.ProjectCreation /// /// Provides extension methods. /// - internal static class ExtensionMethods + public static class ExtensionMethods { /// - /// Gets the current object as an . + /// Gets the current object as an . /// /// The type of the object. - /// The item to make into an . - /// The current object as an . + /// The item to make into an . + /// The current object as an . [DebuggerStepThrough] public static IEnumerable AsEnumerable(this T? item) where T : class @@ -42,7 +42,7 @@ public static IEnumerable AsEnumerable(this T? item) /// /// The first dictionary and all of its values to start with. /// The second dictionary to merge with the first and override its values. - /// A merged with the values of the first dictionary overridden by the second. + /// A merged with the values of the first dictionary overridden by the second. [DebuggerStepThrough] public static IDictionary Merge(this IDictionary? first, IDictionary second) { @@ -54,8 +54,8 @@ public static IEnumerable AsEnumerable(this T? item) /// /// The first dictionary and all of its values to start with. /// The second dictionary to merge with the first and override its values. - /// The implementation to use when comparing keys, or null to use the default for the type of the key. - /// A merged with the values of the first dictionary overridden by the second. + /// The implementation to use when comparing keys, or null to use the default for the type of the key. + /// A merged with the values of the first dictionary overridden by the second. [DebuggerStepThrough] public static IDictionary Merge(this IDictionary? first, IDictionary second, IEqualityComparer comparer) { @@ -93,7 +93,8 @@ public static T[] ToArrayWithSingleElement(this T item) /// An containing package types. /// An containing the package types. /// Any package types are invalid. - public static IEnumerable ToPackageTypes(this IEnumerable? packageTypes) + [DebuggerStepThrough] + internal static IEnumerable ToPackageTypes(this IEnumerable? packageTypes) { if (packageTypes == null) { diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/MSBuildAssemblyResolver.netcoreapp3.1.cs b/src/Microsoft.Build.Utilities.ProjectCreation/MSBuildAssemblyResolver.netcoreapp3.1.cs index 77ca2b0..b8f7128 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/MSBuildAssemblyResolver.netcoreapp3.1.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/MSBuildAssemblyResolver.netcoreapp3.1.cs @@ -14,7 +14,7 @@ namespace Microsoft.Build.Utilities.ProjectCreation public static partial class MSBuildAssemblyResolver { /// - /// A for MSBuild related assemblies. + /// A for MSBuild related assemblies. /// /// The source of the event. /// The event data. diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/MSBuildAssemblyResolver.netframework.cs b/src/Microsoft.Build.Utilities.ProjectCreation/MSBuildAssemblyResolver.netframework.cs index 6b3ca14..dda68c8 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/MSBuildAssemblyResolver.netframework.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/MSBuildAssemblyResolver.netframework.cs @@ -67,7 +67,7 @@ public static partial class MSBuildAssemblyResolver private static readonly char[] PathSplitChars = { Path.PathSeparator }; /// - /// A for MSBuild related assemblies. + /// A for MSBuild related assemblies. /// /// The source of the event. /// The event data. diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/PackageFeed.Items.cs b/src/Microsoft.Build.Utilities.ProjectCreation/PackageFeed.Items.cs index 10808f7..74a8307 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/PackageFeed.Items.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/PackageFeed.Items.cs @@ -15,10 +15,10 @@ public partial class ProjectCreator /// An optional value specifying which assets belonging to the package should be consumed. /// An optional value specifying which assets belonging to the package should be not consumed. /// An optional value specifying which assets belonging to the package should not flow to dependent projects. - /// An optional containing metadata for the item. + /// An optional containing metadata for the item. /// An optional condition to add to the item. /// An optional label to add to the item. - /// The current . + /// The current . public ProjectCreator ItemPackageReference(Package package, string? includeAssets = null, string? excludeAssets = null, string? privateAssets = null, IDictionary? metadata = null, string? condition = null, string? label = null) { return ItemPackageReference(package.Id, package.Version, includeAssets, excludeAssets, privateAssets, metadata, condition, label); diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/PackageManifest.cs b/src/Microsoft.Build.Utilities.ProjectCreation/PackageManifest.cs index fcc3ca3..1b60f53 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/PackageManifest.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/PackageManifest.cs @@ -20,7 +20,7 @@ namespace Microsoft.Build.Utilities.ProjectCreation internal class PackageManifest : Manifest { /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// /// The full path to the manifest file. /// The name or ID of the package. @@ -171,7 +171,7 @@ public void Save() /// Gets the for a package. /// /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// /// The name or ID of the package. /// The semantic version of the package. diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/PackageRepository.File.cs b/src/Microsoft.Build.Utilities.ProjectCreation/PackageRepository.File.cs index 0b5078a..392f3a9 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/PackageRepository.File.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/PackageRepository.File.cs @@ -25,7 +25,7 @@ public PackageRepository FileText(string relativePath, string contents) /// Adds a custom file to the package. /// /// The relative path of the file within the package. - /// The of the file to copy from. + /// The of the file to copy from. /// The current . public PackageRepository FileCustom(string relativePath, FileInfo sourceFileInfo) { diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Build.cs b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Build.cs index 73eb005..0f01d25 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Build.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Build.cs @@ -16,7 +16,7 @@ public partial class ProjectCreator /// /// The name of the target to build. /// A value indicating the result of the build. - /// The current . + /// The current . public ProjectCreator TryBuild(string target, out bool result) { return TryBuild(target, null, out result); @@ -28,7 +28,7 @@ public ProjectCreator TryBuild(string target, out bool result) /// The name of the target to build. /// Global properties to use when building the target. /// A value indicating the result of the build. - /// The current . + /// The current . public ProjectCreator TryBuild(string target, IDictionary? globalProperties, out bool result) { return TryBuild(restore: false, target, globalProperties, out result); @@ -40,7 +40,7 @@ public ProjectCreator TryBuild(string target, IDictionary? globa /// A value indicating whether or not the project should be restored before building. /// The name of the target to build. /// A value indicating the result of the build. - /// The current . + /// The current . public ProjectCreator TryBuild(bool restore, string target, out bool result) { return TryBuild(restore, target, null, out result); @@ -53,7 +53,7 @@ public ProjectCreator TryBuild(bool restore, string target, out bool result) /// The name of the target to build. /// Global properties to use when building the target. /// A value indicating the result of the build. - /// The current . + /// The current . public ProjectCreator TryBuild(bool restore, string target, IDictionary? globalProperties, out bool result) { if (restore) @@ -76,8 +76,8 @@ public ProjectCreator TryBuild(bool restore, string target, IDictionary /// The name of the target to build. /// A value indicating the result of the build. - /// A object that captured the logging from the build. - /// The current . + /// A object that captured the logging from the build. + /// The current . public ProjectCreator TryBuild(string target, out bool result, out BuildOutput buildOutput) { return TryBuild(target, null, out result, out buildOutput); @@ -89,8 +89,8 @@ public ProjectCreator TryBuild(string target, out bool result, out BuildOutput b /// The name of the target to build. /// Global properties to use when building the target. /// A value indicating the result of the build. - /// A object that captured the logging from the build. - /// The current . + /// A object that captured the logging from the build. + /// The current . public ProjectCreator TryBuild(string target, IDictionary? globalProperties, out bool result, out BuildOutput buildOutput) { return TryBuild(restore: false, target, globalProperties, out result, out buildOutput); @@ -102,8 +102,8 @@ public ProjectCreator TryBuild(string target, IDictionary? globa /// A value indicating whether or not the project should be restored before building. /// The name of the target to build. /// A value indicating the result of the build. - /// A object that captured the logging from the build. - /// The current . + /// A object that captured the logging from the build. + /// The current . public ProjectCreator TryBuild(bool restore, string target, out bool result, out BuildOutput buildOutput) { return TryBuild(restore, target, null, out result, out buildOutput); @@ -116,8 +116,8 @@ public ProjectCreator TryBuild(bool restore, string target, out bool result, out /// The name of the target to build. /// Global properties to use when building the target. /// A value indicating the result of the build. - /// A object that captured the logging from the build. - /// The current . + /// A object that captured the logging from the build. + /// The current . public ProjectCreator TryBuild(bool restore, string target, IDictionary? globalProperties, out bool result, out BuildOutput buildOutput) { buildOutput = BuildOutput.Create(); @@ -131,7 +131,7 @@ public ProjectCreator TryBuild(bool restore, string target, IDictionary /// A value indicating the result of the build. - /// The current . + /// The current . public ProjectCreator TryBuild(out bool result) { return TryBuild(globalProperties: null, out result); @@ -142,7 +142,7 @@ public ProjectCreator TryBuild(out bool result) /// /// Global properties to use when building the target. /// A value indicating the result of the build. - /// The current . + /// The current . public ProjectCreator TryBuild(Dictionary? globalProperties, out bool result) { return TryBuild(restore: false, globalProperties: globalProperties, out result); @@ -153,7 +153,7 @@ public ProjectCreator TryBuild(Dictionary? globalProperties, out /// /// A value indicating whether or not the project should be restored before building. /// A value indicating the result of the build. - /// The current . + /// The current . public ProjectCreator TryBuild(bool restore, out bool result) { return TryBuild(restore, globalProperties: null, out result); @@ -165,7 +165,7 @@ public ProjectCreator TryBuild(bool restore, out bool result) /// A value indicating whether or not the project should be restored before building. /// Global properties to use when building the target. /// A value indicating the result of the build. - /// The current . + /// The current . public ProjectCreator TryBuild(bool restore, IDictionary? globalProperties, out bool result) { if (restore) @@ -187,8 +187,8 @@ public ProjectCreator TryBuild(bool restore, IDictionary? global /// Attempts to build the current project. /// /// A value indicating the result of the build. - /// A object that captured the logging from the build. - /// The current . + /// A object that captured the logging from the build. + /// The current . public ProjectCreator TryBuild(out bool result, out BuildOutput buildOutput) { return TryBuild(globalProperties: null, out result, out buildOutput); @@ -199,8 +199,8 @@ public ProjectCreator TryBuild(out bool result, out BuildOutput buildOutput) /// /// Global properties to use when building the target. /// A value indicating the result of the build. - /// A object that captured the logging from the build. - /// The current . + /// A object that captured the logging from the build. + /// The current . public ProjectCreator TryBuild(IDictionary? globalProperties, out bool result, out BuildOutput buildOutput) { return TryBuild(restore: false, globalProperties, out result, out buildOutput); @@ -211,8 +211,8 @@ public ProjectCreator TryBuild(IDictionary? globalProperties, ou /// /// A value indicating whether or not the project should be restored before building. /// A value indicating the result of the build. - /// A object that captured the logging from the build. - /// The current . + /// A object that captured the logging from the build. + /// The current . public ProjectCreator TryBuild(bool restore, out bool result, out BuildOutput buildOutput) { return TryBuild(restore, globalProperties: null, out result, out buildOutput); @@ -224,8 +224,8 @@ public ProjectCreator TryBuild(bool restore, out bool result, out BuildOutput bu /// A value indicating whether or not the project should be restored before building. /// Global properties to use when building the target. /// A value indicating the result of the build. - /// A object that captured the logging from the build. - /// The current . + /// A object that captured the logging from the build. + /// The current . public ProjectCreator TryBuild(bool restore, IDictionary? globalProperties, out bool result, out BuildOutput buildOutput) { buildOutput = BuildOutput.Create(); @@ -240,9 +240,9 @@ public ProjectCreator TryBuild(bool restore, IDictionary? global /// /// The name of the target to build. /// A value indicating the result of the build. - /// A object that captured the logging from the build. + /// A object that captured the logging from the build. /// A containing the target outputs. - /// The current . + /// The current . public ProjectCreator TryBuild(string target, out bool result, out BuildOutput buildOutput, out IDictionary? targetOutputs) { return TryBuild(target, null, out result, out buildOutput, out targetOutputs); @@ -254,9 +254,9 @@ public ProjectCreator TryBuild(string target, out bool result, out BuildOutput b /// The name of the target to build. /// Global properties to use when building the target. /// A value indicating the result of the build. - /// A object that captured the logging from the build. + /// A object that captured the logging from the build. /// A containing the target outputs. - /// The current . + /// The current . public ProjectCreator TryBuild(string target, IDictionary? globalProperties, out bool result, out BuildOutput buildOutput, out IDictionary? targetOutputs) { return TryBuild(restore: false, target, globalProperties, out result, out buildOutput, out targetOutputs); @@ -268,9 +268,9 @@ public ProjectCreator TryBuild(string target, IDictionary? globa /// A value indicating whether or not the project should be restored before building. /// The name of the target to build. /// A value indicating the result of the build. - /// A object that captured the logging from the build. + /// A object that captured the logging from the build. /// A containing the target outputs. - /// The current . + /// The current . public ProjectCreator TryBuild(bool restore, string target, out bool result, out BuildOutput buildOutput, out IDictionary? targetOutputs) { return TryBuild(restore, target, null, out result, out buildOutput, out targetOutputs); @@ -283,9 +283,9 @@ public ProjectCreator TryBuild(bool restore, string target, out bool result, out /// The name of the target to build. /// Global properties to use when building the target. /// A value indicating the result of the build. - /// A object that captured the logging from the build. + /// A object that captured the logging from the build. /// A containing the target outputs. - /// The current . + /// The current . public ProjectCreator TryBuild(bool restore, string target, IDictionary? globalProperties, out bool result, out BuildOutput buildOutput, out IDictionary? targetOutputs) { return TryBuild(restore, new[] { target }, globalProperties, out result, out buildOutput, out targetOutputs); @@ -296,9 +296,9 @@ public ProjectCreator TryBuild(bool restore, string target, IDictionary /// The names of the targets to build. /// A value indicating the result of the build. - /// A object that captured the logging from the build. + /// A object that captured the logging from the build. /// A containing the target outputs. - /// The current . + /// The current . public ProjectCreator TryBuild(string[] targets, out bool result, out BuildOutput buildOutput, out IDictionary? targetOutputs) { return TryBuild(targets, null, out result, out buildOutput, out targetOutputs); @@ -310,9 +310,9 @@ public ProjectCreator TryBuild(string[] targets, out bool result, out BuildOutpu /// The names of the targets to build. /// Global properties to use when building the target. /// A value indicating the result of the build. - /// A object that captured the logging from the build. + /// A object that captured the logging from the build. /// A containing the target outputs. - /// The current . + /// The current . public ProjectCreator TryBuild(string[] targets, IDictionary? globalProperties, out bool result, out BuildOutput buildOutput, out IDictionary? targetOutputs) { return TryBuild(restore: false, targets, globalProperties, out result, out buildOutput, out targetOutputs); @@ -324,9 +324,9 @@ public ProjectCreator TryBuild(string[] targets, IDictionary? gl /// A value indicating whether or not the project should be restored before building. /// The names of the targets to build. /// A value indicating the result of the build. - /// A object that captured the logging from the build. + /// A object that captured the logging from the build. /// A containing the target outputs. - /// The current . + /// The current . public ProjectCreator TryBuild(bool restore, string[] targets, out bool result, out BuildOutput buildOutput, out IDictionary? targetOutputs) { return TryBuild(restore, targets, null, out result, out buildOutput, out targetOutputs); @@ -339,9 +339,9 @@ public ProjectCreator TryBuild(bool restore, string[] targets, out bool result, /// The names of the targets to build. /// Global properties to use when building the target. /// A value indicating the result of the build. - /// A object that captured the logging from the build. + /// A object that captured the logging from the build. /// A containing the target outputs. - /// The current . + /// The current . public ProjectCreator TryBuild(bool restore, string[] targets, IDictionary? globalProperties, out bool result, out BuildOutput buildOutput, out IDictionary? targetOutputs) { buildOutput = BuildOutput.Create(); @@ -356,9 +356,9 @@ public ProjectCreator TryBuild(bool restore, string[] targets, IDictionary /// The names of the targets to build. /// A value indicating the result of the build. - /// A object that captured the logging from the build. + /// A object that captured the logging from the build. /// A containing the target outputs. - /// The current . + /// The current . public ProjectCreator TryBuild(IEnumerable targets, out bool result, out BuildOutput buildOutput, out IDictionary? targetOutputs) { return TryBuild(targets, null, out result, out buildOutput, out targetOutputs); @@ -370,9 +370,9 @@ public ProjectCreator TryBuild(IEnumerable targets, out bool result, out /// The names of the targets to build. /// Global properties to use when building the target. /// A value indicating the result of the build. - /// A object that captured the logging from the build. + /// A object that captured the logging from the build. /// A containing the target outputs. - /// The current . + /// The current . public ProjectCreator TryBuild(IEnumerable targets, IDictionary? globalProperties, out bool result, out BuildOutput buildOutput, out IDictionary? targetOutputs) { return TryBuild(restore: false, targets, globalProperties, out result, out buildOutput, out targetOutputs); @@ -384,9 +384,9 @@ public ProjectCreator TryBuild(IEnumerable targets, IDictionaryA value indicating whether or not the project should be restored before building. /// The names of the targets to build. /// A value indicating the result of the build. - /// A object that captured the logging from the build. + /// A object that captured the logging from the build. /// A containing the target outputs. - /// The current . + /// The current . public ProjectCreator TryBuild(bool restore, IEnumerable targets, out bool result, out BuildOutput buildOutput, out IDictionary? targetOutputs) { return TryBuild(restore, targets, null, out result, out buildOutput, out targetOutputs); @@ -399,9 +399,9 @@ public ProjectCreator TryBuild(bool restore, IEnumerable targets, out bo /// The names of the targets to build. /// Global properties to use when building the target. /// A value indicating the result of the build. - /// A object that captured the logging from the build. + /// A object that captured the logging from the build. /// A containing the target outputs. - /// The current . + /// The current . public ProjectCreator TryBuild(bool restore, IEnumerable targets, IDictionary? globalProperties, out bool result, out BuildOutput buildOutput, out IDictionary? targetOutputs) { return TryBuild(restore, targets.ToArray(), globalProperties, out result, out buildOutput, out targetOutputs); @@ -411,7 +411,7 @@ public ProjectCreator TryBuild(bool restore, IEnumerable targets, IDicti /// Attempts to run the Restore target for the current project with a unique evaluation context. /// /// A value indicating the result of the restore. - /// The current . + /// The current . public ProjectCreator TryRestore(out bool result) { return TryRestore(null, out result); @@ -422,7 +422,7 @@ public ProjectCreator TryRestore(out bool result) /// /// Global properties to use when running the Restore the target. /// A value indicating the result of the restore. - /// The current . + /// The current . public ProjectCreator TryRestore(IDictionary? globalProperties, out bool result) { return TryRestore(globalProperties, out result, out BuildOutput _, out IDictionary _); @@ -432,8 +432,8 @@ public ProjectCreator TryRestore(IDictionary? globalProperties, /// Attempts to run the Restore target for the current project with a unique evaluation context. /// /// A value indicating the result of the restore. - /// A object that captured the logging from the restore. - /// The current . + /// A object that captured the logging from the restore. + /// The current . public ProjectCreator TryRestore(out bool result, out BuildOutput buildOutput) { return TryRestore(null, out result, out buildOutput); @@ -444,8 +444,8 @@ public ProjectCreator TryRestore(out bool result, out BuildOutput buildOutput) /// /// Global properties to use when running the Restore the target. /// A value indicating the result of the restore. - /// A object that captured the logging from the restore. - /// The current . + /// A object that captured the logging from the restore. + /// The current . public ProjectCreator TryRestore(IDictionary? globalProperties, out bool result, out BuildOutput buildOutput) { return TryRestore(globalProperties, out result, out buildOutput, out IDictionary _); @@ -455,9 +455,9 @@ public ProjectCreator TryRestore(IDictionary? globalProperties, /// Attempts to run the Restore target for the current project with a unique evaluation context. /// /// A value indicating the result of the restore. - /// A object that captured the logging from the restore. + /// A object that captured the logging from the restore. /// A containing the target outputs. - /// The current . + /// The current . public ProjectCreator TryRestore(out bool result, out BuildOutput buildOutput, out IDictionary? targetOutputs) { return TryRestore(null, out result, out buildOutput, out targetOutputs); @@ -468,9 +468,9 @@ public ProjectCreator TryRestore(out bool result, out BuildOutput buildOutput, o /// /// Global properties to use when running the Restore the target. /// A value indicating the result of the restore. - /// A object that captured the logging from the restore. + /// A object that captured the logging from the restore. /// A containing the target outputs. - /// The current . + /// The current . public ProjectCreator TryRestore(IDictionary? globalProperties, out bool result, out BuildOutput buildOutput, out IDictionary? targetOutputs) { buildOutput = BuildOutput.Create(); diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Choose.cs b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Choose.cs index d636d44..29944ed 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Choose.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Choose.cs @@ -36,7 +36,7 @@ protected ProjectChooseElement LastChoose /// Adds a <Choose /> element to the current project. /// /// An optional label to add to the Choose. - /// The current . + /// The current . public ProjectCreator Choose(string? label = null) { _lastChoose = AddTopLevelElement(RootElement.CreateChooseElement()); @@ -55,7 +55,7 @@ public ProjectCreator Choose(string? label = null) /// Adds an <Otherwise /> element to the current project. /// /// An optional label to add to the Otherwise. - /// The current . + /// The current . /// A <When /> element has not been added /// -or- /// An <Otherwise /> has already been added to the current <Choose /> element. @@ -83,7 +83,7 @@ public ProjectCreator Otherwise(string? label = null) /// /// An optional condition to add to the item group. /// An optional label to add to the item group. - /// The current . + /// The current . /// A <When /> element has not been added. public ProjectCreator OtherwiseItemGroup(string? condition = null, string? label = null) { @@ -108,10 +108,10 @@ public ProjectCreator OtherwiseItemGroup(string? condition = null, string? label /// The type of the item to add. /// The file or wildcard to include in the list of items. /// An optional file or wildcard to exclude from the list of items. - /// An optional containing metadata for the item. + /// An optional containing metadata for the item. /// An optional condition to add to the item. /// An option label to add to the item. - /// The current . + /// The current . /// A <When /> element has not been added. public ProjectCreator OtherwiseItemInclude( string itemType, @@ -151,9 +151,9 @@ public ProjectCreator OtherwiseItemInclude( /// An optional condition to add to the property. /// An optional value indicating whether or not a condition should be added that checks if the property has already been set. /// An optional label to add to the property. - /// The current . + /// The current . /// - /// The parameter will add a condition such as " '$(Property)' == '' " which will only set the property if it has not already been set. + /// The parameter will add a condition such as " '$(Property)' == '' " which will only set the property if it has not already been set. /// public ProjectCreator OtherwiseProperty(string name, string unevaluatedValue, string? condition = null, bool setIfEmpty = false, string? label = null) { @@ -172,7 +172,7 @@ public ProjectCreator OtherwiseProperty(string name, string unevaluatedValue, st /// /// An optional condition to add to the property group. /// An optional label to add to the property group. - /// The current . + /// The current . public ProjectCreator OtherwisePropertyGroup(string? condition = null, string? label = null) { if (LastChoose.OtherwiseElement == null) @@ -190,7 +190,7 @@ public ProjectCreator OtherwisePropertyGroup(string? condition = null, string? l /// /// An optional condition to add to the <When /> element. /// An optional label to add to the <When /> element. - /// The current . + /// The current . public ProjectCreator When(string? condition = null, string? label = null) { ProjectChooseElement lastChoose = LastChoose; @@ -210,7 +210,7 @@ public ProjectCreator When(string? condition = null, string? label = null) /// /// An optional condition to add to the item group. /// An optional label to add to the item group. - /// The current . + /// The current . /// A <When /> element has not been added. public ProjectCreator WhenItemGroup(string? condition = null, string? label = null) { @@ -230,10 +230,10 @@ public ProjectCreator WhenItemGroup(string? condition = null, string? label = nu /// The type of the item to add. /// The file or wildcard to include in the list of items. /// An optional file or wildcard to exclude from the list of items. - /// An optional containing metadata for the item. + /// An optional containing metadata for the item. /// An optional condition to add to the item. /// An option label to add to the item. - /// The current . + /// The current . public ProjectCreator WhenItemInclude( string itemType, string include, @@ -267,9 +267,9 @@ public ProjectCreator WhenItemInclude( /// An optional condition to add to the property. /// An optional value indicating whether or not a condition should be added that checks if the property has already been set. /// An optional label to add to the property. - /// The current . + /// The current . /// - /// The parameter will add a condition such as " '$(Property)' == '' " which will only set the property if it has not already been set. + /// The parameter will add a condition such as " '$(Property)' == '' " which will only set the property if it has not already been set. /// public ProjectCreator WhenProperty(string name, string unevaluatedValue, string? condition = null, bool setIfEmpty = false, string? label = null) { @@ -288,7 +288,7 @@ public ProjectCreator WhenProperty(string name, string unevaluatedValue, string? /// /// An optional condition to add to the property group. /// An optional label to add to the property group. - /// The current . + /// The current . /// A <When /> element has not been added. public ProjectCreator WhenPropertyGroup(string? condition = null, string? label = null) { diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Conversions.cs b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Conversions.cs index 4fac636..447b320 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Conversions.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Conversions.cs @@ -12,54 +12,54 @@ namespace Microsoft.Build.Utilities.ProjectCreation public partial class ProjectCreator { /// - /// Defines an implicit conversion of a to a . + /// Defines an implicit conversion of a to a . /// - /// A to convert. + /// A to convert. public static implicit operator Project(ProjectCreator creator) { return creator.Project; } /// - /// Defines an implicit conversion of a to a . + /// Defines an implicit conversion of a to a . /// - /// A to convert. + /// A to convert. public static implicit operator ProjectCollection(ProjectCreator creator) { return creator.ProjectCollection; } /// - /// Defines an implicit conversion of a to a . + /// Defines an implicit conversion of a to a . /// - /// A to convert. + /// A to convert. public static implicit operator ProjectInstance(ProjectCreator creator) { return creator.ProjectInstance; } /// - /// Defines an implicit conversion of a to a . + /// Defines an implicit conversion of a to a . /// - /// A to convert. + /// A to convert. public static implicit operator ProjectRootElement(ProjectCreator creator) { return creator.RootElement; } /// - /// Defines an implicit conversion of a to a . + /// Defines an implicit conversion of a to a . /// - /// A to convert. + /// A to convert. public static implicit operator string(ProjectCreator creator) { return creator.FullPath; } /// - /// Defines an implicit conversion of a to an . + /// Defines an implicit conversion of a to an . /// - /// A to convert. + /// A to convert. public static implicit operator XDocument(ProjectCreator creator) { return XDocument.Parse(creator.Xml); diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Imports.cs b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Imports.cs index 63128e6..f2e7057 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Imports.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Imports.cs @@ -23,7 +23,7 @@ public partial class ProjectCreator /// An optional SDK version to add to the import. /// An optional value indicating if a condition should be automatically added that checks if the specified project exists. /// An optional label to add to the import. - /// The current . + /// The current . public ProjectCreator Import(string project, string? condition = null, string? sdk = null, string? sdkVersion = null, bool conditionOnExistence = false, string? label = null) { _lastImport = AddTopLevelElement(RootElement.CreateImportElement(project)); @@ -48,11 +48,11 @@ public ProjectCreator Import(string project, string? condition = null, string? s /// /// Adds an <Import /> element to the current project. /// - /// A to import. + /// A to import. /// An optional condition to add to the import. /// An optional value indicating if a condition should be automatically added that checks if the specified project exists. /// An optional label to add to the import. - /// The current . + /// The current . public ProjectCreator Import(ProjectCreator projectCreator, string? condition = null, bool conditionOnExistence = false, string? label = null) { return Import(projectCreator.FullPath, condition, null, null, conditionOnExistence, label: label); @@ -61,11 +61,11 @@ public ProjectCreator Import(ProjectCreator projectCreator, string? condition = /// /// Adds an <Import /> element to the current project. /// - /// A to import. + /// A to import. /// An optional condition to add to the import. /// An optional value indicating if a condition should be automatically added that checks if the specified project exists. /// An optional label to add to the import. - /// The current . + /// The current . public ProjectCreator Import(Project project, string? condition = null, bool conditionOnExistence = false, string? label = null) { return Import(project.FullPath, condition, null, null, conditionOnExistence, label: label); @@ -74,11 +74,11 @@ public ProjectCreator Import(Project project, string? condition = null, bool con /// /// Adds an <Import /> element to the current project. /// - /// A to import. + /// A to import. /// An optional condition to add to the import. /// An optional value indicating if a condition should be automatically added that checks if the specified project exists. /// An optional label to add to the import. - /// The current . + /// The current . public ProjectCreator Import(ProjectRootElement projectRootElement, string? condition = null, bool conditionOnExistence = false, string? label = null) { return Import(projectRootElement.FullPath, condition, null, null, conditionOnExistence, label: label); @@ -92,7 +92,7 @@ public ProjectCreator Import(ProjectRootElement projectRootElement, string? cond /// An optional version of the SDK. /// An optional condition to add to the import. /// An optional label to add to the import. - /// The current . + /// The current . public ProjectCreator ImportSdk(string project, string name, string? version = null, string? condition = null, string? label = null) { return Import(project, condition, name, version, label: label); diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.ItemGroups.cs b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.ItemGroups.cs index 2606d3b..75e7b6f 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.ItemGroups.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.ItemGroups.cs @@ -34,7 +34,7 @@ protected ProjectItemGroupElement LastItemGroup /// /// An optional condition to add to the item group. /// An optional label to add to the item group. - /// The current . + /// The current . public ProjectCreator ItemGroup(string? condition = null, string? label = null) { _lastItemGroup = AddTopLevelElement(RootElement.CreateItemGroupElement()); @@ -49,10 +49,10 @@ public ProjectCreator ItemGroup(string? condition = null, string? label = null) /// /// Adds an <ItemGroup /> element to the specifed parent. /// - /// A parent to add the item group to. + /// A parent to add the item group to. /// An optional condition to add to the item group. /// An optional label to add to the item group. - /// The current . + /// The current . protected ProjectItemGroupElement ItemGroup(ProjectElementContainer parent, string? condition = null, string? label = null) { ProjectItemGroupElement itemGroup = RootElement.CreateItemGroupElement(); diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Items.cs b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Items.cs index 7342b27..2146f12 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Items.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Items.cs @@ -20,10 +20,10 @@ public partial class ProjectCreator /// An optional path to a file that this file depends on to compile correctly. /// An optional notational path to be displayed when the file is physically located outside the influence of the project file. /// An optional value indicating whether to display the file in Solution Explorer in Visual Studio. - /// An optional containing metadata for the item. + /// An optional containing metadata for the item. /// An optional condition to add to the item. /// An optional label to add to the item. - /// The current . + /// The current . public ProjectCreator ItemCompile(string include, string? exclude = null, string? dependentUpon = null, string? link = null, bool? isVisible = null, IDictionary? metadata = null, string? condition = null, string? label = null) { return ItemInclude( @@ -60,10 +60,10 @@ public ProjectCreator ItemCompile(string include, string? exclude = null, string /// /// /// - /// An optional containing metadata for the item. + /// An optional containing metadata for the item. /// An optional condition to add to the item. /// An optional label to add to the item. - /// The current . + /// The current . public ProjectCreator ItemContent(string include, string? exclude = null, string? dependentUpon = null, string? link = null, bool? isVisible = null, string? copyToOutputDirectory = null, IDictionary? metadata = null, string? condition = null, string? label = null) { return ItemInclude( @@ -82,15 +82,15 @@ public ProjectCreator ItemContent(string include, string? exclude = null, string } /// - /// Adds an item to the current item group. If is null, the item is not added. + /// Adds an item to the current item group. If is null, the item is not added. /// /// The type of the item to add. /// The file or wildcard to include in the list of items. /// An optional file or wildcard to exclude from the list of items. - /// An optional containing metadata for the item. + /// An optional containing metadata for the item. /// An optional condition to add to the item. /// An optional label to add to the item. - /// The current . + /// The current . public ProjectCreator ItemInclude( string itemType, string? include, @@ -126,10 +126,10 @@ public ProjectCreator ItemInclude( /// /// /// - /// An optional containing metadata for the item. + /// An optional containing metadata for the item. /// An optional condition to add to the item. /// An optional label to add to the item. - /// The current . + /// The current . public ProjectCreator ItemNone(string include, string? exclude = null, string? dependentUpon = null, string? link = null, bool? isVisible = null, string? copyToOutputDirectory = null, IDictionary? metadata = null, string? condition = null, string? label = null) { return ItemInclude( @@ -155,10 +155,10 @@ public ProjectCreator ItemNone(string include, string? exclude = null, string? d /// An optional value specifying which assets belonging to the package should be consumed. /// An optional value specifying which assets belonging to the package should be not consumed. /// An optional value specifying which assets belonging to the package should not flow to dependent projects. - /// An optional containing metadata for the item. + /// An optional containing metadata for the item. /// An optional condition to add to the item. /// An optional label to add to the item. - /// The current . + /// The current . public ProjectCreator ItemPackageReference(string include, string? version = null, string? includeAssets = null, string? excludeAssets = null, string? privateAssets = null, IDictionary? metadata = null, string? condition = null, string? label = null) { return ItemInclude( @@ -178,14 +178,14 @@ public ProjectCreator ItemPackageReference(string include, string? version = nul /// /// Adds a <ProjectReference /> item to the current item group. /// - /// A to get the full path from. + /// A to get the full path from. /// An optional name for the project reference. /// An optional project GUID for the project reference. /// An optional value indicating if the output of the project reference should be referenced by the current project. - /// An optional containing metadata for the item. + /// An optional containing metadata for the item. /// An optional condition to add to the item. /// An optional label to add to the item. - /// The current . + /// The current . public ProjectCreator ItemProjectReference(Project project, string? name = null, string? projectGuid = null, bool? referenceOutputAssembly = null, IDictionary? metadata = null, string? condition = null, string? label = null) { return ItemProjectReference(project.Xml, name, projectGuid, referenceOutputAssembly, metadata, condition, label); @@ -194,14 +194,14 @@ public ProjectCreator ItemProjectReference(Project project, string? name = null, /// /// Adds a <ProjectReference /> item to the current item group. /// - /// A to get the full path from. + /// A to get the full path from. /// An optional name for the project reference. /// An optional project GUID for the project reference. /// An optional value indicating if the output of the project reference should be referenced by the current project. - /// An optional containing metadata for the item. + /// An optional containing metadata for the item. /// An optional condition to add to the item. /// An optional label to add to the item. - /// The current . + /// The current . public ProjectCreator ItemProjectReference(ProjectRootElement rootElement, string? name = null, string? projectGuid = null, bool? referenceOutputAssembly = null, IDictionary? metadata = null, string? condition = null, string? label = null) { return ItemProjectReference(rootElement.FullPath, name, projectGuid, referenceOutputAssembly, metadata, condition, label); @@ -210,14 +210,14 @@ public ProjectCreator ItemProjectReference(ProjectRootElement rootElement, strin /// /// Adds a <ProjectReference /> item to the current item group. /// - /// A to get the full path from. + /// A to get the full path from. /// An optional name for the project reference. /// An optional project GUID for the project reference. /// An optional value indicating if the output of the project reference should be referenced by the current project. - /// An optional containing metadata for the item. + /// An optional containing metadata for the item. /// An optional condition to add to the item. /// An optional label to add to the item. - /// The current . + /// The current . public ProjectCreator ItemProjectReference(ProjectCreator projectCreator, string? name = null, string? projectGuid = null, bool? referenceOutputAssembly = null, IDictionary? metadata = null, string? condition = null, string? label = null) { return ItemProjectReference(projectCreator.RootElement, name, projectGuid, referenceOutputAssembly, metadata, condition, label); @@ -230,10 +230,10 @@ public ProjectCreator ItemProjectReference(ProjectCreator projectCreator, string /// An optional name for the project reference. /// An optional project GUID for the project reference. /// An optional value indicating if the output of the project reference should be referenced by the current project. - /// An optional containing metadata for the item. + /// An optional containing metadata for the item. /// An optional condition to add to the item. /// An optional label to add to the item. - /// The current . + /// The current . public ProjectCreator ItemProjectReference(string include, string? name = null, string? projectGuid = null, bool? referenceOutputAssembly = null, IDictionary? metadata = null, string? condition = null, string? label = null) { return ItemInclude( @@ -258,10 +258,10 @@ public ProjectCreator ItemProjectReference(string include, string? name = null, /// An optional value indicating whether or not to use a specific version for the reference. /// An optional list of aliases for the reference. /// An optional value indicating whether or not the reference should be copied to the output folder. - /// An optional containing metadata for the item. + /// An optional containing metadata for the item. /// An optional condition to add to the item. /// An optional label to add to the item. - /// The current . + /// The current . public ProjectCreator ItemReference(string include, string? name = null, string? hintPath = null, bool? isSpecificVersion = null, string? aliases = null, bool? isPrivate = null, IDictionary? metadata = null, string? condition = null, string? label = null) { return ItemInclude( @@ -280,14 +280,14 @@ public ProjectCreator ItemReference(string include, string? name = null, string? } /// - /// Remove items in the current item group. If is null, the item is not added. + /// Remove items in the current item group. If is null, the item is not added. /// /// The type of the item to remove items from. /// The file or wildcard to remove in the list of items. - /// An optional containing metadata for the item. + /// An optional containing metadata for the item. /// An optional condition to add to the item. /// An optional label to add to the item. - /// The current . + /// The current . public ProjectCreator ItemRemove( string itemType, string? remove, @@ -310,14 +310,14 @@ public ProjectCreator ItemRemove( } /// - /// Updates items in the current item group. If is null, the item is not added. + /// Updates items in the current item group. If is null, the item is not added. /// /// The type of the item to update items in. /// The file or wildcard to update in the list of items. - /// An optional containing metadata for the item. + /// An optional containing metadata for the item. /// An optional condition to add to the item. /// An optional label to add to the item. - /// The current . + /// The current . public ProjectCreator ItemUpdate( string itemType, string? update, @@ -343,8 +343,8 @@ public ProjectCreator ItemUpdate( /// Gets a list of items in the project. /// /// The item type. - /// A containing the items. - /// The current . + /// A containing the items. + /// The current . public ProjectCreator TryGetItems(string itemType, out IReadOnlyCollection items) { items = Project.GetItems(itemType).ToList(); @@ -357,9 +357,9 @@ public ProjectCreator TryGetItems(string itemType, out IReadOnlyCollection /// The type of the object that the selector will return. /// The item type. - /// A that gets the desired return object. - /// A containing the items. - /// The current . + /// A that gets the desired return object. + /// A containing the items. + /// The current . public ProjectCreator TryGetItems(string itemType, Func selector, out IReadOnlyCollection items) { if (selector == null) @@ -377,8 +377,8 @@ public ProjectCreator TryGetItems(string itemType, Func selec /// /// The item type. /// The name of a metadata item to get. - /// A containing the ItemSpec and metadata value. - /// The current . + /// A containing the ItemSpec and metadata value. + /// The current . public ProjectCreator TryGetItems(string itemType, string metadataName, out IReadOnlyDictionary items) { if (string.IsNullOrWhiteSpace(metadataName)) @@ -398,14 +398,14 @@ public ProjectCreator TryGetItems(string itemType, string metadataName, out IRea /// The type of the item to add. /// The file or wildcard to include in the list of items. /// An optional file or wildcard to exclude from the list of items. - /// An optional containing metadata for the item. + /// An optional containing metadata for the item. /// The file or wildcard to remove from the list of items. /// The file or wildcard to update in the list of items. /// An optional condition to add to the item. /// Specifies whether an item should be added to the target group if it's an exact duplicate of an existing item. /// The metadata for the source items to add to the target items. /// An optional label to add to the item. - /// The current . + /// The current . private ProjectCreator Item( ProjectItemGroupElement itemGroup, string itemType, diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Linq.cs b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Linq.cs index 63d5ff2..2c82964 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Linq.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Linq.cs @@ -13,9 +13,9 @@ public partial class ProjectCreator /// Executes the specified action for each item in a list. /// /// The type of the item. - /// An containing items to iterate through. - /// An to execute against the current . - /// The current . + /// An containing items to iterate through. + /// An to execute against the current . + /// The current . public ProjectCreator ForEach(IEnumerable source, Action action) { if (source != null) diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Project.cs b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Project.cs index 42ee5ef..32f56be 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Project.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Project.cs @@ -18,7 +18,7 @@ public partial class ProjectCreator private readonly IDictionary? _globalProperties; /// - /// Stores the instance used to create a object lazily. + /// Stores the instance used to create a object lazily. /// private Project? _project; @@ -28,7 +28,7 @@ public partial class ProjectCreator private ProjectInstance? _projectInstance; /// - /// Gets the instance for the current project. The project is re-evaluated if necessary every time this property is accessed. + /// Gets the instance for the current project. The project is re-evaluated if necessary every time this property is accessed. /// public Project Project { @@ -51,14 +51,14 @@ public Project Project public ProjectInstance ProjectInstance => _projectInstance ??= Project.CreateProjectInstance(); /// - /// Gets a instance from the current project. + /// Gets a instance from the current project. /// - /// Receives the instance. - /// Optional containing global properties. + /// Receives the instance. + /// Optional containing global properties. /// Optional tools version. - /// Optional to use. Defaults to ProjectCollection.GlobalProjectCollection. - /// Optional to use. Defaults to . - /// The current . + /// Optional to use. Defaults to ProjectCollection.GlobalProjectCollection. + /// Optional to use. Defaults to . + /// The current . public ProjectCreator TryGetProject( out Project project, IDictionary? globalProperties = null, @@ -77,15 +77,15 @@ public ProjectCreator TryGetProject( } /// - /// Gets a instance from the current project. + /// Gets a instance from the current project. /// - /// Receives the instance. - /// Receives instance. - /// Optional containing global properties. + /// Receives the instance. + /// Receives instance. + /// Optional containing global properties. /// Optional tools version. - /// Optional to use. Defaults to ProjectCollection.GlobalProjectCollection. - /// Optional to use. Defaults to . - /// The current . + /// Optional to use. Defaults to ProjectCollection.GlobalProjectCollection. + /// Optional to use. Defaults to . + /// The current . public ProjectCreator TryGetProject( out Project project, out BuildOutput buildOutput, @@ -116,7 +116,7 @@ public ProjectCreator TryGetProject( /// Receives the . /// Optional to use when creating the project instance. /// Optional to use when creating the project instance. - /// The current . + /// The current . public ProjectCreator TryGetProjectInstance( out ProjectInstance projectInstance, ProjectInstanceSettings projectInstanceSettings = ProjectInstanceSettings.None, diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Properties.cs b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Properties.cs index d79adb8..e8ba1df 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Properties.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Properties.cs @@ -16,9 +16,9 @@ public partial class ProjectCreator /// An optional condition to add to the property. /// An optional value indicating whether or not a condition should be added that checks if the property has already been set. /// An optional label to add to the property. - /// The current . + /// The current . /// - /// The parameter will add a condition such as " '$(Property)' == '' " which will only set the property if it has not already been set. + /// The parameter will add a condition such as " '$(Property)' == '' " which will only set the property if it has not already been set. /// public ProjectCreator Property(string name, string? unevaluatedValue, string? condition = null, bool setIfEmpty = false, string? label = null) { @@ -44,17 +44,17 @@ public ProjectCreator TryGetPropertyValue(string name, out string value) } /// - /// Adds a property element to the current <PropertyGroup />. A property group is automatically added if necessary. if is null, the property is not added. + /// Adds a property element to the current <PropertyGroup />. A property group is automatically added if necessary. if is null, the property is not added. /// - /// The to add the property to. + /// The to add the property to. /// The name of the property. /// The unevaluated value of the property. /// An optional condition to add to the property. /// An optional value indicating whether or not a condition should be added that checks if the property has already been set. /// An option label to add to the property. - /// The current . + /// The current . /// - /// The parameter will add a condition such as " '$(Property)' == '' " which will only set the property if it has not already been set. + /// The parameter will add a condition such as " '$(Property)' == '' " which will only set the property if it has not already been set. /// private ProjectCreator Property(ProjectPropertyGroupElement propertyGroup, string name, string unevaluatedValue, string? condition = null, bool setIfEmpty = false, string? label = null) { diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.PropertyGroups.cs b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.PropertyGroups.cs index 7cc8f3c..99c3c6d 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.PropertyGroups.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.PropertyGroups.cs @@ -34,7 +34,7 @@ protected ProjectPropertyGroupElement LastPropertyGroup /// /// An optional condition to add to the property group. /// An optional label to add to the property group. - /// The current . + /// The current . public ProjectCreator PropertyGroup(string? condition = null, string? label = null) { _lastPropertyGroup = AddTopLevelElement(RootElement.CreatePropertyGroupElement()); @@ -47,12 +47,12 @@ public ProjectCreator PropertyGroup(string? condition = null, string? label = nu } /// - /// Adds a <PropertyGroup /> element to the specified . + /// Adds a <PropertyGroup /> element to the specified . /// - /// The parent to add the property group to. + /// The parent to add the property group to. /// An optional condition to add to the property group. /// An optional label to add to the property group. - /// The that was added. + /// The that was added. protected ProjectPropertyGroupElement PropertyGroup(ProjectElementContainer parent, string? condition = null, string? label = null) { ProjectPropertyGroupElement propertyGroup = RootElement.CreatePropertyGroupElement(); diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Sdk.cs b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Sdk.cs index 93ec639..a717974 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Sdk.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Sdk.cs @@ -11,7 +11,7 @@ public partial class ProjectCreator /// /// The name of the SDK. /// An optional version of the SDK. - /// The current . + /// The current . public ProjectCreator Sdk(string name, string? version = null) { AddTopLevelElement(RootElement.CreateProjectSdkElement(name, version)); diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Targets.cs b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Targets.cs index db985f1..1c4c452 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Targets.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Targets.cs @@ -25,7 +25,7 @@ public partial class ProjectCreator private ProjectPropertyGroupElement? _lastTargetPropertyGroup; /// - /// Gets the last target that was added if there is one, otherwise one is added with a default name from . + /// Gets the last target that was added if there is one, otherwise one is added with a default name from . /// protected ProjectTargetElement LastTarget { @@ -53,7 +53,7 @@ protected ProjectTargetElement LastTarget /// The set of items that will be made available to tasks that invoke this target, for example, MSBuild tasks. Multiple targets are separated by semicolons. /// If true, multiple references to the same item in the target's Returns are recorded. By default, this attribute is false. /// An optional label to add to the target. - /// The current . + /// The current . public ProjectCreator Target( string name, string? condition = null, @@ -90,7 +90,7 @@ public ProjectCreator Target( /// /// An optional condition to add to the item group. /// An optional label to add to the item group. - /// The current . + /// The current . public ProjectCreator TargetItemGroup(string? condition = null, string? label = null) { _lastTargetItemGroup = ItemGroup(LastTarget, condition, label); @@ -104,10 +104,10 @@ public ProjectCreator TargetItemGroup(string? condition = null, string? label = /// The type of the item to add. /// The file or wildcard to include in the list of items. /// An optional file or wildcard to exclude from the list of items. - /// An optional containing metadata for the item. + /// An optional containing metadata for the item. /// An optional condition to add to the item. /// An optional label to add to the item. - /// The current . + /// The current . public ProjectCreator TargetItemInclude( string itemType, string include, @@ -139,7 +139,7 @@ public ProjectCreator TargetItemInclude( /// The targets to execute if a task fails. Separate multiple targets with semicolons. Multiple targets are executed in the order specified. /// Condition to be evaluated. /// An optional label to add. - /// The current . + /// The current . public ProjectCreator TargetOnError(string executeTargets, string? condition = null, string? label = null) { ProjectOnErrorElement onErrorElement = RootElement.CreateOnErrorElement(executeTargets); @@ -160,9 +160,9 @@ public ProjectCreator TargetOnError(string executeTargets, string? condition = n /// An optional condition to add to the property. /// An optional value indicating whether or not a condition should be added that checks if the property has already been set. /// An optional label to add to the property. - /// The current . + /// The current . /// - /// The parameter will add a condition such as " '$(Property)' == '' " which will only set the property if it has not already been set. + /// The parameter will add a condition such as " '$(Property)' == '' " which will only set the property if it has not already been set. /// public ProjectCreator TargetProperty(string name, string unevaluatedValue, string? condition = null, bool setIfEmpty = false, string? label = null) { @@ -179,7 +179,7 @@ public ProjectCreator TargetProperty(string name, string unevaluatedValue, strin /// /// An optional condition to add to the property group. /// An optional label to add to the property group. - /// The current . + /// The current . public ProjectCreator TargetPropertyGroup(string? condition = null, string? label = null) { _lastTargetPropertyGroup = PropertyGroup(LastTarget, condition, label); diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Tasks.cs b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Tasks.cs index 2c2645b..80479e0 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Tasks.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Tasks.cs @@ -21,7 +21,7 @@ public partial class ProjectCreator /// /// The name of the task. /// An optional condition to add to the task. - /// An optional that contains the parameters to pass to the task. + /// An optional that contains the parameters to pass to the task. /// An optional value indicating if the build should continue in the case of an error. The valid values are: /// /// @@ -38,7 +38,7 @@ public partial class ProjectCreator /// an optional architecture for the task. /// An optional runtime for the task. /// An optional label to add to the task. - /// The current . + /// The current . public ProjectCreator Task(string name, string? condition = null, IDictionary? parameters = null, string? continueOnError = null, string? architecture = null, string? runtime = null, string? label = null) { _lastTask = LastTarget.AddTask(name); @@ -69,7 +69,7 @@ public ProjectCreator Task(string name, string? condition = null, IDictionaryAn optional help keyword. /// An optional condition to add to the task. /// An optional label to add to the task. - /// The current . + /// The current . public ProjectCreator TaskError(string text, string? code = null, string? file = null, string? helpKeyword = null, string? condition = null, string? label = null) { return Task( @@ -89,10 +89,10 @@ public ProjectCreator TaskError(string text, string? code = null, string? file = /// Adds a <Message /> task to the current target. /// /// The message to display. - /// An optional to use. + /// An optional to use. /// An optional condition to add to the task. /// An optional label to add to the task. - /// The current . + /// The current . public ProjectCreator TaskMessage(string text, MessageImportance? importance = null, string? condition = null, string? label = null) { return Task( @@ -107,13 +107,13 @@ public ProjectCreator TaskMessage(string text, MessageImportance? importance = n } /// - /// Adds an <Output /> element to the current task that receives an item from task. To add an output property, use . + /// Adds an <Output /> element to the current task that receives an item from task. To add an output property, use . /// /// The name of the task's output parameter. /// The item that receives the task's output parameter value. /// An optional condition to add to the output element. /// An optional label to add to the output element. - /// The current . + /// The current . public ProjectCreator TaskOutputItem(string taskParameter, string itemType, string? condition = null, string? label = null) { if (_lastTask == null) @@ -128,13 +128,13 @@ public ProjectCreator TaskOutputItem(string taskParameter, string itemType, stri } /// - /// Adds an <Output /> element to the current task that receives a property from task. To add an output Item, use . + /// Adds an <Output /> element to the current task that receives a property from task. To add an output Item, use . /// /// The name of the task's output parameter. /// The property that receives the task's output parameter value. /// An optional condition to add to the output element. /// An optional label to add to the output element. - /// The current . + /// The current . public ProjectCreator TaskOutputProperty(string taskParameter, string propertyName, string? condition = null, string? label = null) { if (_lastTask == null) @@ -157,7 +157,7 @@ public ProjectCreator TaskOutputProperty(string taskParameter, string propertyNa /// An optional help keyword. /// An optional condition to add to the task. /// An optional label to add to the task. - /// The current . + /// The current . public ProjectCreator TaskWarning(string text, string? code = null, string? file = null, string? helpKeyword = null, string? condition = null, string? label = null) { return Task( diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.UsingTasks.cs b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.UsingTasks.cs index 86beb5a..56da5ac 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.UsingTasks.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.UsingTasks.cs @@ -23,7 +23,7 @@ public partial class ProjectCreator /// An optional architecture for the task. /// An optional condition to add to the task. /// An optional label to add to the task. - /// The current . + /// The current . public ProjectCreator UsingTaskAssemblyFile(string taskName, string assemblyFile, string? taskFactory = null, string? runtime = null, string? architecture = null, string? condition = null, string? label = null) { _lastUsingTask = AddTopLevelElement(RootElement.CreateUsingTaskElement(taskName, assemblyFile, null, runtime, architecture)); @@ -45,7 +45,7 @@ public ProjectCreator UsingTaskAssemblyFile(string taskName, string assemblyFile /// An optional architecture for the task. /// An optional condition to add to the task. /// An optional label to add to the task. - /// The current . + /// The current . public ProjectCreator UsingTaskAssemblyName(string taskName, string assemblyName, string taskFactory, string? runtime = null, string? architecture = null, string? condition = null, string? label = null) { _lastUsingTask = AddTopLevelElement(RootElement.CreateUsingTaskElement(taskName, null, assemblyName, runtime, architecture)); @@ -62,7 +62,7 @@ public ProjectCreator UsingTaskAssemblyName(string taskName, string assemblyName /// /// The data that is passed to the TaskFactory to generate an instance of the task. /// An optional value indicating if the body should be evaluated. - /// The current . + /// The current . public ProjectCreator UsingTaskBody(string body, bool? evaluate = null) { if (_lastUsingTask == null) @@ -87,7 +87,7 @@ public ProjectCreator UsingTaskBody(string body, bool? evaluate = null) /// An optional .NET type of the parameter, for example, "System.String". /// An optional value indicating whether or not the property is an output. /// An optional value indicating whether or not the property is required. - /// The current . + /// The current . public ProjectCreator UsingTaskParameter(string name, string? parameterType = null, bool? output = null, bool? required = null) { if (_lastUsingTask == null) diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.cs b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.cs index 6d61277..db5fe8d 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.cs @@ -25,9 +25,9 @@ public partial class ProjectCreator private ProjectElement? _lastTopLevelElement; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// - /// The of the backing MSBuild project. + /// The of the backing MSBuild project. /// An containing global properties to use when creating the project. private ProjectCreator(ProjectRootElement rootElement, IDictionary? globalProperties) { @@ -44,12 +44,12 @@ private ProjectCreator(ProjectRootElement rootElement, IDictionary RootElement.FullPath; /// - /// Gets the for the current project. + /// Gets the for the current project. /// public ProjectCollection ProjectCollection { get; private set; } /// - /// Gets the instance for the current project. + /// Gets the instance for the current project. /// public ProjectRootElement RootElement { get; } @@ -59,7 +59,7 @@ private ProjectCreator(ProjectRootElement rootElement, IDictionary RootElement.RawXml; /// - /// Creates a new instance. + /// Creates a new instance. /// /// An optional relative or full path for the project. /// An optional list of default targets for the project. @@ -67,10 +67,10 @@ private ProjectCreator(ProjectRootElement rootElement, IDictionaryAn optional SDK for the project. /// An optional tools version for the project. /// An optional list of properties to treat as local properties. - /// An optional to use when loading the project. - /// An optional specifying options when creating a new file. + /// An optional to use when loading the project. + /// An optional specifying options when creating a new file. /// An optional containing global properties for the project. - /// A object that is used to construct an MSBuild project. + /// A object that is used to construct an MSBuild project. public static ProjectCreator Create( string? path = null, string? defaultTargets = null, @@ -120,10 +120,10 @@ public static ProjectCreator Create( } /// - /// Executes custom actions against the current . + /// Executes custom actions against the current . /// - /// An delegate to execute against the current . - /// The current . + /// An delegate to execute against the current . + /// The current . public ProjectCreator CustomAction(Action? projectCreator) { projectCreator?.Invoke(this); @@ -134,7 +134,7 @@ public ProjectCreator CustomAction(Action? projectCreator) /// /// Saves the project to disk. /// - /// The current . + /// The current . public ProjectCreator Save() { RootElement.Save(); @@ -147,7 +147,7 @@ public ProjectCreator Save() /// /// The path to save the file to. /// is null. - /// The current . + /// The current . public ProjectCreator Save(string path) { if (path == null) diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreatorConstants.cs b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreatorConstants.cs index 50e8e27..963d53d 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreatorConstants.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreatorConstants.cs @@ -5,7 +5,7 @@ namespace Microsoft.Build.Utilities.ProjectCreation { /// - /// Represents constants used by the class. + /// Represents constants used by the class. /// public static class ProjectCreatorConstants { diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreatorException.cs b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreatorException.cs index 6b7e9b9..33a615b 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreatorException.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreatorException.cs @@ -7,12 +7,12 @@ namespace Microsoft.Build.Utilities.ProjectCreation { /// - /// Represents an exception that is thrown by the . + /// Represents an exception that is thrown by the . /// public class ProjectCreatorException : Exception { /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// /// The exception message. public ProjectCreatorException(string message) @@ -21,10 +21,10 @@ public ProjectCreatorException(string message) } /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// /// The exception message. - /// The inner . + /// The inner . public ProjectCreatorException(string message, Exception innerException) : base(message, innerException) { diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net472/PublicAPI.Unshipped.txt b/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net472/PublicAPI.Unshipped.txt index 29f1eff..cb33243 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net472/PublicAPI.Unshipped.txt +++ b/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net472/PublicAPI.Unshipped.txt @@ -1,4 +1,5 @@ -Microsoft.Build.Utilities.ProjectCreation.Package.Compare(Microsoft.Build.Utilities.ProjectCreation.Package? x, Microsoft.Build.Utilities.ProjectCreation.Package? y) -> int +Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods +Microsoft.Build.Utilities.ProjectCreation.Package.Compare(Microsoft.Build.Utilities.ProjectCreation.Package? x, Microsoft.Build.Utilities.ProjectCreation.Package? y) -> int Microsoft.Build.Utilities.ProjectCreation.Package.CompareTo(Microsoft.Build.Utilities.ProjectCreation.Package? other) -> int Microsoft.Build.Utilities.ProjectCreation.Package.Equals(Microsoft.Build.Utilities.ProjectCreation.Package? x, Microsoft.Build.Utilities.ProjectCreation.Package? y) -> bool Microsoft.Build.Utilities.ProjectCreation.Package.GetHashCode(Microsoft.Build.Utilities.ProjectCreation.Package! obj) -> int @@ -174,6 +175,10 @@ Microsoft.Build.Utilities.ProjectCreation.ProjectCreatorTemplates.LegacyCsproj(s Microsoft.Build.Utilities.ProjectCreation.ProjectCreatorTemplates.LogsMessage(string! text, Microsoft.Build.Framework.MessageImportance? importance = null, string? condition = null, string? targetName = null, string? path = null, string? defaultTargets = null, string? initialTargets = null, string? sdk = null, string? toolsVersion = null, string? treatAsLocalProperty = null, Microsoft.Build.Evaluation.ProjectCollection? projectCollection = null, Microsoft.Build.Evaluation.NewProjectFileOptions? projectFileOptions = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator! Microsoft.Build.Utilities.ProjectCreation.ProjectCreatorTemplates.SdkCsproj(string? path = null, string! sdk = "Microsoft.NET.Sdk", string? targetFramework = "netstandard2.0", string? outputType = null, System.Action? projectCreator = null, string? defaultTargets = null, string? initialTargets = null, string? treatAsLocalProperty = null, Microsoft.Build.Evaluation.ProjectCollection? projectCollection = null, Microsoft.Build.Evaluation.NewProjectFileOptions? projectFileOptions = 0, System.Collections.Generic.IDictionary? globalProperties = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator! Microsoft.Build.Utilities.ProjectCreation.ProjectCreatorTemplates.SdkCsproj(System.Collections.Generic.IEnumerable? targetFrameworks, string? path = null, string! sdk = "Microsoft.NET.Sdk", string? outputType = null, System.Action? projectCreator = null, string? defaultTargets = null, string? initialTargets = null, string? treatAsLocalProperty = null, Microsoft.Build.Evaluation.ProjectCollection? projectCollection = null, Microsoft.Build.Evaluation.NewProjectFileOptions? projectFileOptions = 0, System.Collections.Generic.IDictionary? globalProperties = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator! +static Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods.AsEnumerable(this T? item) -> System.Collections.Generic.IEnumerable! +static Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods.Merge(this System.Collections.Generic.IDictionary? first, System.Collections.Generic.IDictionary! second) -> System.Collections.Generic.IDictionary! +static Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods.Merge(this System.Collections.Generic.IDictionary? first, System.Collections.Generic.IDictionary! second, System.Collections.Generic.IEqualityComparer! comparer) -> System.Collections.Generic.IDictionary! +static Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods.ToArrayWithSingleElement(this T! item) -> T![]! static Microsoft.Build.Utilities.ProjectCreation.MSBuildAssemblyResolver.AssemblyResolve(object? sender, System.ResolveEventArgs! args) -> System.Reflection.Assembly? static Microsoft.Build.Utilities.ProjectCreation.MSBuildAssemblyResolver.DotNetSdksPath.get -> string? static Microsoft.Build.Utilities.ProjectCreation.MSBuildAssemblyResolver.MSBuildExePath.get -> string? diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net5.0/PublicAPI.Unshipped.txt b/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net5.0/PublicAPI.Unshipped.txt index 5ed08d0..587f0bc 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net5.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net5.0/PublicAPI.Unshipped.txt @@ -1,4 +1,5 @@ -Microsoft.Build.Utilities.ProjectCreation.Package.Compare(Microsoft.Build.Utilities.ProjectCreation.Package? x, Microsoft.Build.Utilities.ProjectCreation.Package? y) -> int +Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods +Microsoft.Build.Utilities.ProjectCreation.Package.Compare(Microsoft.Build.Utilities.ProjectCreation.Package? x, Microsoft.Build.Utilities.ProjectCreation.Package? y) -> int Microsoft.Build.Utilities.ProjectCreation.Package.CompareTo(Microsoft.Build.Utilities.ProjectCreation.Package? other) -> int Microsoft.Build.Utilities.ProjectCreation.Package.Equals(Microsoft.Build.Utilities.ProjectCreation.Package? x, Microsoft.Build.Utilities.ProjectCreation.Package? y) -> bool Microsoft.Build.Utilities.ProjectCreation.Package.GetHashCode(Microsoft.Build.Utilities.ProjectCreation.Package! obj) -> int @@ -174,6 +175,10 @@ Microsoft.Build.Utilities.ProjectCreation.ProjectCreatorTemplates.LegacyCsproj(s Microsoft.Build.Utilities.ProjectCreation.ProjectCreatorTemplates.LogsMessage(string! text, Microsoft.Build.Framework.MessageImportance? importance = null, string? condition = null, string? targetName = null, string? path = null, string? defaultTargets = null, string? initialTargets = null, string? sdk = null, string? toolsVersion = null, string? treatAsLocalProperty = null, Microsoft.Build.Evaluation.ProjectCollection? projectCollection = null, Microsoft.Build.Evaluation.NewProjectFileOptions? projectFileOptions = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator! Microsoft.Build.Utilities.ProjectCreation.ProjectCreatorTemplates.SdkCsproj(string? path = null, string! sdk = "Microsoft.NET.Sdk", string? targetFramework = "netstandard2.0", string? outputType = null, System.Action? projectCreator = null, string? defaultTargets = null, string? initialTargets = null, string? treatAsLocalProperty = null, Microsoft.Build.Evaluation.ProjectCollection? projectCollection = null, Microsoft.Build.Evaluation.NewProjectFileOptions? projectFileOptions = 0, System.Collections.Generic.IDictionary? globalProperties = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator! Microsoft.Build.Utilities.ProjectCreation.ProjectCreatorTemplates.SdkCsproj(System.Collections.Generic.IEnumerable? targetFrameworks, string? path = null, string! sdk = "Microsoft.NET.Sdk", string? outputType = null, System.Action? projectCreator = null, string? defaultTargets = null, string? initialTargets = null, string? treatAsLocalProperty = null, Microsoft.Build.Evaluation.ProjectCollection? projectCollection = null, Microsoft.Build.Evaluation.NewProjectFileOptions? projectFileOptions = 0, System.Collections.Generic.IDictionary? globalProperties = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator! +static Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods.AsEnumerable(this T? item) -> System.Collections.Generic.IEnumerable! +static Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods.Merge(this System.Collections.Generic.IDictionary? first, System.Collections.Generic.IDictionary! second) -> System.Collections.Generic.IDictionary! +static Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods.Merge(this System.Collections.Generic.IDictionary? first, System.Collections.Generic.IDictionary! second, System.Collections.Generic.IEqualityComparer! comparer) -> System.Collections.Generic.IDictionary! +static Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods.ToArrayWithSingleElement(this T! item) -> T![]! static Microsoft.Build.Utilities.ProjectCreation.MSBuildAssemblyResolver.AssemblyResolve(System.Runtime.Loader.AssemblyLoadContext! assemblyLoadContext, System.Reflection.AssemblyName! requestedAssemblyName) -> System.Reflection.Assembly? static Microsoft.Build.Utilities.ProjectCreation.MSBuildAssemblyResolver.DotNetSdksPath.get -> string? static Microsoft.Build.Utilities.ProjectCreation.MSBuildAssemblyResolver.MSBuildExePath.get -> string? diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net6.0/PublicAPI.Unshipped.txt b/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net6.0/PublicAPI.Unshipped.txt index 5ed08d0..587f0bc 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net6.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net6.0/PublicAPI.Unshipped.txt @@ -1,4 +1,5 @@ -Microsoft.Build.Utilities.ProjectCreation.Package.Compare(Microsoft.Build.Utilities.ProjectCreation.Package? x, Microsoft.Build.Utilities.ProjectCreation.Package? y) -> int +Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods +Microsoft.Build.Utilities.ProjectCreation.Package.Compare(Microsoft.Build.Utilities.ProjectCreation.Package? x, Microsoft.Build.Utilities.ProjectCreation.Package? y) -> int Microsoft.Build.Utilities.ProjectCreation.Package.CompareTo(Microsoft.Build.Utilities.ProjectCreation.Package? other) -> int Microsoft.Build.Utilities.ProjectCreation.Package.Equals(Microsoft.Build.Utilities.ProjectCreation.Package? x, Microsoft.Build.Utilities.ProjectCreation.Package? y) -> bool Microsoft.Build.Utilities.ProjectCreation.Package.GetHashCode(Microsoft.Build.Utilities.ProjectCreation.Package! obj) -> int @@ -174,6 +175,10 @@ Microsoft.Build.Utilities.ProjectCreation.ProjectCreatorTemplates.LegacyCsproj(s Microsoft.Build.Utilities.ProjectCreation.ProjectCreatorTemplates.LogsMessage(string! text, Microsoft.Build.Framework.MessageImportance? importance = null, string? condition = null, string? targetName = null, string? path = null, string? defaultTargets = null, string? initialTargets = null, string? sdk = null, string? toolsVersion = null, string? treatAsLocalProperty = null, Microsoft.Build.Evaluation.ProjectCollection? projectCollection = null, Microsoft.Build.Evaluation.NewProjectFileOptions? projectFileOptions = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator! Microsoft.Build.Utilities.ProjectCreation.ProjectCreatorTemplates.SdkCsproj(string? path = null, string! sdk = "Microsoft.NET.Sdk", string? targetFramework = "netstandard2.0", string? outputType = null, System.Action? projectCreator = null, string? defaultTargets = null, string? initialTargets = null, string? treatAsLocalProperty = null, Microsoft.Build.Evaluation.ProjectCollection? projectCollection = null, Microsoft.Build.Evaluation.NewProjectFileOptions? projectFileOptions = 0, System.Collections.Generic.IDictionary? globalProperties = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator! Microsoft.Build.Utilities.ProjectCreation.ProjectCreatorTemplates.SdkCsproj(System.Collections.Generic.IEnumerable? targetFrameworks, string? path = null, string! sdk = "Microsoft.NET.Sdk", string? outputType = null, System.Action? projectCreator = null, string? defaultTargets = null, string? initialTargets = null, string? treatAsLocalProperty = null, Microsoft.Build.Evaluation.ProjectCollection? projectCollection = null, Microsoft.Build.Evaluation.NewProjectFileOptions? projectFileOptions = 0, System.Collections.Generic.IDictionary? globalProperties = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator! +static Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods.AsEnumerable(this T? item) -> System.Collections.Generic.IEnumerable! +static Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods.Merge(this System.Collections.Generic.IDictionary? first, System.Collections.Generic.IDictionary! second) -> System.Collections.Generic.IDictionary! +static Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods.Merge(this System.Collections.Generic.IDictionary? first, System.Collections.Generic.IDictionary! second, System.Collections.Generic.IEqualityComparer! comparer) -> System.Collections.Generic.IDictionary! +static Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods.ToArrayWithSingleElement(this T! item) -> T![]! static Microsoft.Build.Utilities.ProjectCreation.MSBuildAssemblyResolver.AssemblyResolve(System.Runtime.Loader.AssemblyLoadContext! assemblyLoadContext, System.Reflection.AssemblyName! requestedAssemblyName) -> System.Reflection.Assembly? static Microsoft.Build.Utilities.ProjectCreation.MSBuildAssemblyResolver.DotNetSdksPath.get -> string? static Microsoft.Build.Utilities.ProjectCreation.MSBuildAssemblyResolver.MSBuildExePath.get -> string? diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/netcoreapp3.1/PublicAPI.Unshipped.txt b/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/netcoreapp3.1/PublicAPI.Unshipped.txt index 29f1eff..cb33243 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/netcoreapp3.1/PublicAPI.Unshipped.txt +++ b/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/netcoreapp3.1/PublicAPI.Unshipped.txt @@ -1,4 +1,5 @@ -Microsoft.Build.Utilities.ProjectCreation.Package.Compare(Microsoft.Build.Utilities.ProjectCreation.Package? x, Microsoft.Build.Utilities.ProjectCreation.Package? y) -> int +Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods +Microsoft.Build.Utilities.ProjectCreation.Package.Compare(Microsoft.Build.Utilities.ProjectCreation.Package? x, Microsoft.Build.Utilities.ProjectCreation.Package? y) -> int Microsoft.Build.Utilities.ProjectCreation.Package.CompareTo(Microsoft.Build.Utilities.ProjectCreation.Package? other) -> int Microsoft.Build.Utilities.ProjectCreation.Package.Equals(Microsoft.Build.Utilities.ProjectCreation.Package? x, Microsoft.Build.Utilities.ProjectCreation.Package? y) -> bool Microsoft.Build.Utilities.ProjectCreation.Package.GetHashCode(Microsoft.Build.Utilities.ProjectCreation.Package! obj) -> int @@ -174,6 +175,10 @@ Microsoft.Build.Utilities.ProjectCreation.ProjectCreatorTemplates.LegacyCsproj(s Microsoft.Build.Utilities.ProjectCreation.ProjectCreatorTemplates.LogsMessage(string! text, Microsoft.Build.Framework.MessageImportance? importance = null, string? condition = null, string? targetName = null, string? path = null, string? defaultTargets = null, string? initialTargets = null, string? sdk = null, string? toolsVersion = null, string? treatAsLocalProperty = null, Microsoft.Build.Evaluation.ProjectCollection? projectCollection = null, Microsoft.Build.Evaluation.NewProjectFileOptions? projectFileOptions = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator! Microsoft.Build.Utilities.ProjectCreation.ProjectCreatorTemplates.SdkCsproj(string? path = null, string! sdk = "Microsoft.NET.Sdk", string? targetFramework = "netstandard2.0", string? outputType = null, System.Action? projectCreator = null, string? defaultTargets = null, string? initialTargets = null, string? treatAsLocalProperty = null, Microsoft.Build.Evaluation.ProjectCollection? projectCollection = null, Microsoft.Build.Evaluation.NewProjectFileOptions? projectFileOptions = 0, System.Collections.Generic.IDictionary? globalProperties = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator! Microsoft.Build.Utilities.ProjectCreation.ProjectCreatorTemplates.SdkCsproj(System.Collections.Generic.IEnumerable? targetFrameworks, string? path = null, string! sdk = "Microsoft.NET.Sdk", string? outputType = null, System.Action? projectCreator = null, string? defaultTargets = null, string? initialTargets = null, string? treatAsLocalProperty = null, Microsoft.Build.Evaluation.ProjectCollection? projectCollection = null, Microsoft.Build.Evaluation.NewProjectFileOptions? projectFileOptions = 0, System.Collections.Generic.IDictionary? globalProperties = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator! +static Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods.AsEnumerable(this T? item) -> System.Collections.Generic.IEnumerable! +static Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods.Merge(this System.Collections.Generic.IDictionary? first, System.Collections.Generic.IDictionary! second) -> System.Collections.Generic.IDictionary! +static Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods.Merge(this System.Collections.Generic.IDictionary? first, System.Collections.Generic.IDictionary! second, System.Collections.Generic.IEqualityComparer! comparer) -> System.Collections.Generic.IDictionary! +static Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods.ToArrayWithSingleElement(this T! item) -> T![]! static Microsoft.Build.Utilities.ProjectCreation.MSBuildAssemblyResolver.AssemblyResolve(object? sender, System.ResolveEventArgs! args) -> System.Reflection.Assembly? static Microsoft.Build.Utilities.ProjectCreation.MSBuildAssemblyResolver.DotNetSdksPath.get -> string? static Microsoft.Build.Utilities.ProjectCreation.MSBuildAssemblyResolver.MSBuildExePath.get -> string? diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/Templates/LegacyCsproj.cs b/src/Microsoft.Build.Utilities.ProjectCreation/Templates/LegacyCsproj.cs index dea2b12..d66e43c 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/Templates/LegacyCsproj.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/Templates/LegacyCsproj.cs @@ -27,15 +27,15 @@ public partial class ProjectCreatorTemplates /// An optional default value for the Platform property. /// An optional GUID for the project. If none is specified, one is generated. /// An optional file alignment for the project. - /// An optional delegate to call in the body of the project. + /// An optional delegate to call in the body of the project. /// An optional list of default targets for the project. /// An optional list of initial targets for the project. /// An optional tools version for the project. /// An optional list of properties to treat as local properties. - /// An optional to use when loading the project. - /// An optional specifying options when creating a new file. + /// An optional to use when loading the project. + /// An optional specifying options when creating a new file. /// An optional containing global properties for the project. - /// A object that is used to construct an MSBuild project. + /// A object that is used to construct an MSBuild project. public ProjectCreator LegacyCsproj( string? path = null, string outputType = "Library", diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/Templates/LogsMessage.cs b/src/Microsoft.Build.Utilities.ProjectCreation/Templates/LogsMessage.cs index 7ed52c0..bc5df53 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/Templates/LogsMessage.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/Templates/LogsMessage.cs @@ -14,7 +14,7 @@ public partial class ProjectCreatorTemplates /// Creates a project that logs a single message. /// /// The message to display. - /// An optional to use. + /// An optional to use. /// An optional condition to add to the message task. /// An optional target name to add the message task to. Default is "Build". /// An optional relative or full path for the project. @@ -23,9 +23,9 @@ public partial class ProjectCreatorTemplates /// An optional SDK for the project. /// An optional tools version for the project. /// An optional list of properties to treat as local properties. - /// An optional to use when loading the project. - /// An optional specifying options when creating a new file. - /// A object that is used to construct an MSBuild project. + /// An optional to use when loading the project. + /// An optional specifying options when creating a new file. + /// A object that is used to construct an MSBuild project. public ProjectCreator LogsMessage( string text, MessageImportance? importance = null, diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/Templates/SdkCsproj.cs b/src/Microsoft.Build.Utilities.ProjectCreation/Templates/SdkCsproj.cs index a8057cd..eb5dea3 100644 --- a/src/Microsoft.Build.Utilities.ProjectCreation/Templates/SdkCsproj.cs +++ b/src/Microsoft.Build.Utilities.ProjectCreation/Templates/SdkCsproj.cs @@ -20,14 +20,14 @@ public partial class ProjectCreatorTemplates /// An optional SDK for the project. /// An optional target framework for the project. /// An optional output type for the project. - /// An optional delegate to call in the body of the project. + /// An optional delegate to call in the body of the project. /// An optional list of default targets for the project. /// An optional list of initial targets for the project. /// An optional list of properties to treat as local properties. - /// An optional to use when loading the project. - /// An optional specifying options when creating a new file. + /// An optional to use when loading the project. + /// An optional specifying options when creating a new file. /// An optional containing global properties for the project. - /// A object that is used to construct an MSBuild project. + /// A object that is used to construct an MSBuild project. public ProjectCreator SdkCsproj( string? path = null, string sdk = ProjectCreatorConstants.SdkCsprojDefaultSdk, @@ -58,18 +58,18 @@ public ProjectCreator SdkCsproj( /// /// Creates an SDK-style C# project that target multiple frameworks. /// - /// An that specifies the target frameworks for the project. + /// An that specifies the target frameworks for the project. /// An optional relative or full path for the project. /// An optional SDK for the project. /// An optional output type for the project. - /// An optional delegate to call in the body of the project. + /// An optional delegate to call in the body of the project. /// An optional list of default targets for the project. /// An optional list of initial targets for the project. /// An optional list of properties to treat as local properties. - /// An optional to use when loading the project. - /// An optional specifying options when creating a new file. + /// An optional to use when loading the project. + /// An optional specifying options when creating a new file. /// An optional containing global properties for the project. - /// A object that is used to construct an MSBuild project. + /// A object that is used to construct an MSBuild project. public ProjectCreator SdkCsproj( IEnumerable? targetFrameworks, string? path = null,