diff --git a/eng/Common.globalconfig b/eng/Common.globalconfig index ba9176829ef..00835e17638 100644 --- a/eng/Common.globalconfig +++ b/eng/Common.globalconfig @@ -164,7 +164,7 @@ dotnet_diagnostic.CA1069.severity = none dotnet_diagnostic.CA1070.severity = warning # Avoid using cref tags with a prefix -dotnet_diagnostic.CA1200.severity = suggestion +dotnet_diagnostic.CA1200.severity = warning # Do not pass literals as localized parameters dotnet_diagnostic.CA1303.severity = none diff --git a/src/Build/Collections/RetrievableEntryHashSet/HashSet.cs b/src/Build/Collections/RetrievableEntryHashSet/HashSet.cs index 7c3efec3bac..72add2878f0 100644 --- a/src/Build/Collections/RetrievableEntryHashSet/HashSet.cs +++ b/src/Build/Collections/RetrievableEntryHashSet/HashSet.cs @@ -45,7 +45,7 @@ namespace Microsoft.Build.Collections { /// /// Implementation notes: - /// This uses an array-based implementation similar to , using a buckets array + /// This uses an array-based implementation similar to , using a buckets array /// to map hash values to the Slots array. Items in the Slots array that hash to the same value /// are chained together through the "next" indices. /// diff --git a/src/Build/Construction/ProjectElementContainer.cs b/src/Build/Construction/ProjectElementContainer.cs index f377db4c8d9..033b2fdb614 100644 --- a/src/Build/Construction/ProjectElementContainer.cs +++ b/src/Build/Construction/ProjectElementContainer.cs @@ -318,7 +318,7 @@ public void RemoveChild(ProjectElement child) /// /// /// It is safe to modify the children in this way - /// during enumeration. See . + /// during enumeration. See . /// public void RemoveAllChildren() { diff --git a/src/Build/Definition/ProjectCollection.cs b/src/Build/Definition/ProjectCollection.cs index fe629102479..2d76ca87e4f 100644 --- a/src/Build/Definition/ProjectCollection.cs +++ b/src/Build/Definition/ProjectCollection.cs @@ -434,7 +434,7 @@ public static ProjectCollection GlobalProjectCollection /// This is the Windows file version (specifically the value of the FileVersion /// resource), not necessarily the assembly version. /// If you want the assembly version, use Constants.AssemblyVersion. - /// This is not the ToolsetCollection.ToolsVersions. + /// This is not the . /// public static Version Version { diff --git a/src/Build/Graph/ProjectGraph.cs b/src/Build/Graph/ProjectGraph.cs index 1b3f94cdebe..d72c6dce862 100644 --- a/src/Build/Graph/ProjectGraph.cs +++ b/src/Build/Graph/ProjectGraph.cs @@ -353,7 +353,7 @@ public ProjectGraph( /// on for other scenarios. /// /// - /// The token to observe. + /// The to observe. /// /// /// If the evaluation of any project in the graph fails @@ -397,7 +397,7 @@ public ProjectGraph( /// Number of threads to participate in building the project graph. /// /// - /// The token to observe. + /// The to observe. /// /// /// If the evaluation of any project in the graph fails diff --git a/src/Build/Logging/BinaryLogger/BuildEventArgsReader.cs b/src/Build/Logging/BinaryLogger/BuildEventArgsReader.cs index 5f007b40826..64a26269a78 100644 --- a/src/Build/Logging/BinaryLogger/BuildEventArgsReader.cs +++ b/src/Build/Logging/BinaryLogger/BuildEventArgsReader.cs @@ -55,9 +55,9 @@ public class BuildEventArgsReader : IDisposable typeof(BuildEventArgs).GetField("senderName", BindingFlags.Instance | BindingFlags.NonPublic); /// - /// Initializes a new instance of using a instance. + /// Initializes a new instance of using a instance. /// - /// The to read from. + /// The to read from. /// The file format version of the log file being read. public BuildEventArgsReader(BinaryReader binaryReader, int fileFormatVersion) { @@ -81,10 +81,11 @@ public void Dispose() internal event Action OnBlobRead; /// - /// Reads the next log record from the . + /// Reads the next log record from the . /// /// - /// The next . If there are no more records, returns . + /// The next . + /// If there are no more records, returns . /// public BuildEventArgs Read() { diff --git a/src/Framework/NativeMethods.cs b/src/Framework/NativeMethods.cs index 367b4eb6955..aba2bb7c7b7 100644 --- a/src/Framework/NativeMethods.cs +++ b/src/Framework/NativeMethods.cs @@ -258,7 +258,7 @@ protected override bool ReleaseHandle() internal class MemoryStatus { /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public MemoryStatus() { diff --git a/src/Framework/Sdk/SdkResolver.cs b/src/Framework/Sdk/SdkResolver.cs index 728bc476bf3..753cc5a0116 100644 --- a/src/Framework/Sdk/SdkResolver.cs +++ b/src/Framework/Sdk/SdkResolver.cs @@ -29,15 +29,12 @@ public abstract class SdkResolver /// Factory class to create an /// /// An containing the resolved SDKs or associated error / reason - /// the SDK could not be resolved. Return null if the resolver is not + /// the SDK could not be resolved. Return if the resolver is not /// applicable for a particular . /// - /// [!NOTE] - /// > You must use the to return a result. - /// ]]> - /// + /// + /// Note: You must use to return a result. + /// /// public abstract SdkResult Resolve(SdkReference sdkReference, SdkResolverContext resolverContext, diff --git a/src/MSBuildTaskHost/Concurrent/ConcurrentDictionary.cs b/src/MSBuildTaskHost/Concurrent/ConcurrentDictionary.cs index 588c67814f1..a27b5f6dbba 100644 --- a/src/MSBuildTaskHost/Concurrent/ConcurrentDictionary.cs +++ b/src/MSBuildTaskHost/Concurrent/ConcurrentDictionary.cs @@ -269,14 +269,14 @@ private static void ThrowKeyNullException() /// if the key does not already exist. /// /// The key of the element to add. - /// The function used to generate a value for the key - /// is a null reference + /// The function used to generate a value for the key. + /// is a null reference /// (Nothing in Visual Basic). - /// is a null reference + /// is a null reference /// (Nothing in Visual Basic). - /// The dictionary contains too many + /// The dictionary contains too many /// elements. - /// The value for the key. This will be either the existing value for the key if the + /// The value for the key. This will be either the existing value for the key if the /// key is already in the dictionary, or the new value for the key as returned by valueFactory /// if the key was not in the dictionary. public TValue GetOrAdd(TKey key, Func valueFactory) diff --git a/src/Tasks/Hash.cs b/src/Tasks/Hash.cs index 23e8eaf7650..a18aadfe071 100644 --- a/src/Tasks/Hash.cs +++ b/src/Tasks/Hash.cs @@ -15,11 +15,8 @@ namespace Microsoft.Build.Tasks /// Generates a hash of a given ItemGroup items. Metadata is not considered in the hash. /// /// - /// + /// Currently uses SHA1. Implementation subject to change between MSBuild versions. + /// This class is not intended as a cryptographic security measure, only uniqueness between build executions. /// public class Hash : TaskExtension { diff --git a/src/Tasks/RoslynCodeTaskFactory/RoslynCodeTaskFactory.cs b/src/Tasks/RoslynCodeTaskFactory/RoslynCodeTaskFactory.cs index ec48b416e19..a7497f27d9e 100644 --- a/src/Tasks/RoslynCodeTaskFactory/RoslynCodeTaskFactory.cs +++ b/src/Tasks/RoslynCodeTaskFactory/RoslynCodeTaskFactory.cs @@ -116,7 +116,7 @@ public sealed class RoslynCodeTaskFactory : ITaskFactory public string FactoryName => "Roslyn Code Task Factory"; /// - /// Gets the of the compiled task. + /// Gets the of the compiled task. /// public Type TaskType { get; private set; }