diff --git a/src/Build/Definition/ProjectCollection.cs b/src/Build/Definition/ProjectCollection.cs
index 8629bd94317..647e3811692 100644
--- a/src/Build/Definition/ProjectCollection.cs
+++ b/src/Build/Definition/ProjectCollection.cs
@@ -432,7 +432,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 ToolsetCollectionVersion.
+ /// This is not the ToolsetCollection.ToolsVersions.
///
public static Version Version
{
diff --git a/src/Build/Logging/BinaryLogger/BinaryLogger.cs b/src/Build/Logging/BinaryLogger/BinaryLogger.cs
index dac426db8b4..60bd5867bcd 100644
--- a/src/Build/Logging/BinaryLogger/BinaryLogger.cs
+++ b/src/Build/Logging/BinaryLogger/BinaryLogger.cs
@@ -89,19 +89,20 @@ public enum ProjectImportsCollectionMode
private string FilePath { get; set; }
- ///
+ /// Gets or sets the verbosity level.
+ ///
/// The binary logger Verbosity is always maximum (Diagnostic). It tries to capture as much
/// information as possible.
- ///
+ ///
public LoggerVerbosity Verbosity { get; set; } = LoggerVerbosity.Diagnostic;
///
- /// The only supported parameter is the output log file path (e.g. "msbuild.binlog")
+ /// Gets or sets the parameters. The only supported parameter is the output log file path (for example, "msbuild.binlog").
///
public string Parameters { get; set; }
///
- /// Initializes the logger by subscribing to events of IEventSource
+ /// Initializes the logger by subscribing to events of the specified event source.
///
public void Initialize(IEventSource eventSource)
{
diff --git a/src/Build/Logging/BinaryLogger/BuildEventArgsReader.cs b/src/Build/Logging/BinaryLogger/BuildEventArgsReader.cs
index c6be1d59db3..5601cb647af 100644
--- a/src/Build/Logging/BinaryLogger/BuildEventArgsReader.cs
+++ b/src/Build/Logging/BinaryLogger/BuildEventArgsReader.cs
@@ -53,9 +53,9 @@ public class BuildEventArgsReader : IDisposable
typeof(BuildEventArgs).GetField("senderName", BindingFlags.Instance | BindingFlags.NonPublic);
///
- /// Initializes a new instance of BuildEventArgsReader using a BinaryReader instance
+ /// Initializes a new instance of using a instance.
///
- /// The BinaryReader to read BuildEventArgs from
+ /// The to read from.
/// The file format version of the log file being read.
public BuildEventArgsReader(BinaryReader binaryReader, int fileFormatVersion)
{
@@ -79,8 +79,11 @@ public void Dispose()
internal event Action OnBlobRead;
///
- /// Reads the next log record from the binary reader. If there are no more records, returns null.
+ /// Reads the next log record from the .
///
+ ///
+ /// The next . If there are no more records, returns .
+ ///
public BuildEventArgs Read()
{
BinaryLogRecordKind recordKind = (BinaryLogRecordKind)ReadInt32();
diff --git a/src/Build/Logging/ProfilerLogger.cs b/src/Build/Logging/ProfilerLogger.cs
index 5d0ed444b07..b4a00967474 100644
--- a/src/Build/Logging/ProfilerLogger.cs
+++ b/src/Build/Logging/ProfilerLogger.cs
@@ -51,12 +51,15 @@ internal static ProfilerLogger CreateForTesting()
}
///
- /// Verbosity is ignored by this logger
+ /// Gets or sets the verbosity level.
///
+ ///
+ /// Verbosity is ignored by this logger.
+ ///
public LoggerVerbosity Verbosity { get; set; }
///
- /// No specific parameters are used by this logger
+ /// No specific parameters are used by this logger.
///
public string Parameters { get; set; }
@@ -74,7 +77,7 @@ public void Initialize(IEventSource eventSource)
}
///
- /// On shutdown, the profiler report is written to disk
+ /// On shutdown, the profiler report is written to disk.
///
public void Shutdown()
{
@@ -103,13 +106,13 @@ private void ProjectEvaluationFinishedRaised(object sender, BuildEventArgs e)
}
///
- /// Returns the result of aggregating all profiled projects across a build
+ /// Returns the result of aggregating all profiled projects across a build.
///
/// Whether small items should be pruned. This is called with false on some tests since the result may vary depending on the evaluator speed
///
/// Not thread safe. After this method is called, the assumption is that no new ProjectEvaluationFinishedEventArgs will arrive.
/// In the regular code path, this method is called only once per build. But some test cases may call it multiple times to validate
- /// the aggregated data
+ /// the aggregated data.
///
internal ProfilerResult GetAggregatedResult(bool pruneSmallItems = true)
{
@@ -230,7 +233,7 @@ private static Dictionary PruneSmallItems(
}
///
- /// Finds the first ancestor of parentId (which could be itself) that is either an evaluation pass location or a big enough profiled data
+ /// Finds the first ancestor of parentId (which could be itself) that is either an evaluation pass location or a big enough profiled data.
///
private static long? FindBigEnoughParentId(IDictionary> idTable,
long? parentId)
@@ -271,11 +274,11 @@ private static ProfiledLocation AggregateProfiledLocation(ProfiledLocation locat
}
///
- /// Pretty prints the aggregated results and saves it to disk
+ /// Pretty prints the aggregated results and saves it to disk.
///
///
/// If the extension of the file to log is 'md', markdown content is generated. Otherwise, it falls
- /// back to a tab separated format
+ /// back to a tab separated format.
///
private void GenerateProfilerReport()
{
diff --git a/src/Framework/Sdk/SdkReference.cs b/src/Framework/Sdk/SdkReference.cs
index f48c8444bbc..e62c308289d 100644
--- a/src/Framework/Sdk/SdkReference.cs
+++ b/src/Framework/Sdk/SdkReference.cs
@@ -44,10 +44,11 @@ public SdkReference(string name, string version, string minimumVersion)
///
public string MinimumVersion { get; }
- ///
- ///
- ///
- ///
+ /// Indicates whether the current object is equal to another object of the same type.
+ /// An object to compare with this object.
+ ///
+ /// if the current object is equal to the parameter; otherwise, .
+ ///
public bool Equals(SdkReference other)
{
if (other is null) return false;
diff --git a/src/Framework/Sdk/SdkResolver.cs b/src/Framework/Sdk/SdkResolver.cs
index 9280c30af24..469fda51744 100644
--- a/src/Framework/Sdk/SdkResolver.cs
+++ b/src/Framework/Sdk/SdkResolver.cs
@@ -30,9 +30,12 @@ public abstract class SdkResolver
/// the SDK could not be resolved. Return null if the resolver is not
/// applicable for a particular .
///
- ///
- /// Note: You must use to return a result.
- ///
+ /// [!NOTE]
+ /// > You must use the to return a result.
+ /// ]]>
+ ///
///
public abstract SdkResult Resolve(SdkReference sdkReference, SdkResolverContext resolverContext,
SdkResultFactory factory);
diff --git a/src/Framework/Sdk/SdkResolverContext.cs b/src/Framework/Sdk/SdkResolverContext.cs
index 63e2f48482d..d932cd2ba9b 100644
--- a/src/Framework/Sdk/SdkResolverContext.cs
+++ b/src/Framework/Sdk/SdkResolverContext.cs
@@ -39,8 +39,11 @@ public abstract class SdkResolverContext
/// Version of MSBuild currently running.
///
///
- /// File version based on commit height from our public git repository. This is informational
- /// and not equal to the assembly version.
+ ///
///
public virtual Version MSBuildVersion { get; protected set; }
diff --git a/src/Framework/Sdk/SdkResult.cs b/src/Framework/Sdk/SdkResult.cs
index 29c201f24b8..514b2db367a 100644
--- a/src/Framework/Sdk/SdkResult.cs
+++ b/src/Framework/Sdk/SdkResult.cs
@@ -9,7 +9,11 @@ namespace Microsoft.Build.Framework
/// An abstract interface class to indicate SDK resolver success or failure.
///
///
- /// Note: Use to create instances of this class. Do not inherit from this class.
+ /// [!NOTE]
+ /// > Use to create instances of this class. Do not inherit from this class.
+ /// ]]>
///
public abstract class SdkResult
{
diff --git a/src/Tasks/CodeTaskFactory.cs b/src/Tasks/CodeTaskFactory.cs
index 2e2bb8b2ab9..983e9547fe9 100644
--- a/src/Tasks/CodeTaskFactory.cs
+++ b/src/Tasks/CodeTaskFactory.cs
@@ -160,7 +160,7 @@ private static Assembly CurrentDomainOnAssemblyResolve(object sender, ResolveEve
public Type TaskType { get; private set; }
///
- /// Get the type information for all task parameters
+ /// Get the type information for all task parameters.
///
public TaskPropertyInfo[] GetTaskParameters()
{
@@ -170,7 +170,7 @@ public TaskPropertyInfo[] GetTaskParameters()
}
///
- /// Initialze the task factory
+ /// Initializes the task factory.
///
public bool Initialize(string taskName, IDictionary taskParameters, string taskElementContents, IBuildEngine taskFactoryLoggingHost)
{
@@ -306,7 +306,7 @@ public bool Initialize(string taskName, IDictionary ta
}
///
- /// Create a taskfactory instance which contains the data that needs to be refreshed between task invocations
+ /// Create a taskfactory instance which contains the data that needs to be refreshed between task invocations.
///
public ITask CreateTask(IBuildEngine loggingHost)
{
diff --git a/src/Tasks/Copy.cs b/src/Tasks/Copy.cs
index 1575b55d11b..3e67d20a147 100644
--- a/src/Tasks/Copy.cs
+++ b/src/Tasks/Copy.cs
@@ -101,26 +101,26 @@ public Copy()
public ITaskItem DestinationFolder { get; set; }
///
- /// How many times to attempt to copy, if all previous
- /// attempts failed. Defaults to zero.
- /// Warning: using retries may mask a synchronization problem in your
- /// build process.
+ /// Gets or sets the number of times to attempt to copy, if all previous attempts failed.
+ /// Warning: using retries may mask a synchronization problem in your build process.
///
public int Retries { get; set; } = 10;
///
- /// Delay between any necessary retries.
+ /// Gets or sets the delay, in milliseconds, between any necessary retries.
/// Defaults to RetryDelayMillisecondsDefault
///
public int RetryDelayMilliseconds { get; set; }
///
- /// Create Hard Links for the copied files rather than copy the files if possible to do so
+ /// Gets or sets a value that indicates whether to use hard links for the copied files
+ /// rather than copy the files, if it's possible to do so.
///
public bool UseHardlinksIfPossible { get; set; }
///
- /// Create Symbolic Links for the copied files rather than copy the files if possible to do so
+ /// Gets or sets a value that indicates whether to create symbolic links for the copied files
+ /// rather than copy the files, if it's possible to do so.
///
public bool UseSymboliclinksIfPossible { get; set; } = s_forceSymlinks;
@@ -144,7 +144,7 @@ public Copy()
public bool WroteAtLeastOneFile { get; private set; }
///
- /// Whether to overwrite files in the destination
+ /// Gets or sets a value that indicates whether to overwrite files in the destination
/// that have the read-only attribute set.
///
public bool OverwriteReadOnlyFiles { get; set; }
diff --git a/src/Tasks/Hash.cs b/src/Tasks/Hash.cs
index 81699764e51..1969f9c4ebe 100644
--- a/src/Tasks/Hash.cs
+++ b/src/Tasks/Hash.cs
@@ -13,8 +13,11 @@ 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. Not
- /// intended as a cryptographic security measure, only uniqueness between build executions.
+ ///
///
public class Hash : TaskExtension
{
diff --git a/src/Tasks/Unzip.cs b/src/Tasks/Unzip.cs
index 01544039194..a86b518d62b 100644
--- a/src/Tasks/Unzip.cs
+++ b/src/Tasks/Unzip.cs
@@ -46,12 +46,12 @@ public sealed class Unzip : TaskExtension, ICancelableTask
public ITaskItem DestinationFolder { get; set; }
///
- /// Gets or sets a value indicating whether read-only files should be overwritten.
+ /// Gets or sets a value that indicates whether read-only files should be overwritten.
///
public bool OverwriteReadOnlyFiles { get; set; }
///
- /// Gets or sets a value indicating whether files should be skipped if the destination is unchanged.
+ /// Gets or sets a value that indicates whether files should be skipped if the destination is unchanged.
///
public bool SkipUnchangedFiles { get; set; } = true;
@@ -62,12 +62,12 @@ public sealed class Unzip : TaskExtension, ICancelableTask
public ITaskItem[] SourceFiles { get; set; }
///
- /// Gets or sets an MSBuild glob expression that will be used to determine which files to include being unzipped from the archive.
+ /// Gets or sets an MSBuild glob expression that specifies which files to include being unzipped from the archive.
///
public string Include { get; set; }
///
- /// Gets or sets an MSBuild glob expression that will be used to determine which files to exclude from being unzipped from the archive.
+ /// Gets or sets an MSBuild glob expression that specifies which files to exclude from being unzipped from the archive.
///
public string Exclude { get; set; }