Fix help warnings (#5140)

Author: nohwnd

Directory.Build.props

@@ -45,18 +45,7 @@
     <!-- default to max warnlevel -->
     <AnalysisLevel>preview</AnalysisLevel>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
-    <!--
-      Make sure any documentation comments which are included in code get checked for syntax during the build, but do
-      not report warnings for missing comments.
-
-      Cleanup issue: https://github.com/microsoft/vstest/issues/4236
-      CS1570: XML comment on '<construct>' has badly formed XML
-      CS1572: XML comment on 'construct' has a param tag for 'parameter', but there is no parameter by that name
-      CS1573: Parameter 'parameter' has no matching param tag in the XML comment for 'parameter' (but other parameters do)
-      CS1574: XML comment on 'construct' has syntactically incorrect cref attribute 'name'
-      CS1591: Missing XML comment for publicly visible type or member 'Type_or_Member'
-    -->
-    <NoWarn>$(NoWarn);CA1416;RS0037;CS1570;CS1572;CS1573;CS1574;CS1591</NoWarn>
+    <NoWarn>$(NoWarn);CA1416;RS0037</NoWarn>
   </PropertyGroup>
 
   <!-- The TFMs to build and test against. -->

src/Microsoft.TestPlatform.Client/DesignMode/IDesignModeClient.cs

@@ -20,6 +20,7 @@ public interface IDesignModeClient : IDisposable
     /// Setups client based on port
     /// </summary>
     /// <param name="port">port number to connect</param>
+    /// <param name="testRequestManager">test request manager</param>
     void ConnectToClientAndProcessRequests(int port, ITestRequestManager testRequestManager);
 
     /// <summary>

src/Microsoft.TestPlatform.Client/Discovery/DiscoveryRequest.cs

@@ -33,6 +33,7 @@ public sealed class DiscoveryRequest : IDiscoveryRequest, ITestDiscoveryEventsHa
     /// <param name="requestData">The Request Data instance providing services and data for discovery</param>
     /// <param name="criteria">Discovery criterion.</param>
     /// <param name="discoveryManager">Discovery manager instance.</param>
+    /// <param name="loggerManager">Logger manager instance.</param>
     internal DiscoveryRequest(IRequestData requestData, DiscoveryCriteria criteria, IProxyDiscoveryManager discoveryManager, ITestLoggerManager loggerManager)
         : this(requestData, criteria, discoveryManager, loggerManager, JsonDataSerializer.Instance)
     {
@@ -44,6 +45,7 @@ internal DiscoveryRequest(IRequestData requestData, DiscoveryCriteria criteria,
     /// <param name="requestData">The Request Data instance providing services and data for discovery</param>
     /// <param name="criteria">Discovery criterion.</param>
     /// <param name="discoveryManager">Discovery manager instance.</param>
+    /// <param name="loggerManager">Logger manager instance.</param>
     /// <param name="dataSerializer">Data Serializer</param>
     internal DiscoveryRequest(
         IRequestData requestData,

src/Microsoft.TestPlatform.Client/RequestHelper/ITestRequestManager.cs

@@ -92,7 +92,7 @@ void StartTestSession(
     /// Stops a test session.
     /// </summary>
     ///
-    /// <param name="testSessionInfo">The stop test session payload.</param>
+    /// <param name="payload">The stop test session payload.</param>
     /// <param name="eventsHandler">The events handler.</param>
     /// <param name="protocolConfig">Protocol related information.</param>
     void StopTestSession(

src/Microsoft.TestPlatform.Client/TestPlatform.cs

@@ -231,6 +231,7 @@ private void AddExtensionAssemblies(string? runSettings, TestAdapterLoadingStrat
     /// </summary>
     ///
     /// <param name="sources">The list of sources.</param>
+    /// <param name="strategy">Adapter loading strategy</param>
     private void AddLoggerAssembliesFromSource(IEnumerable<string> sources, TestAdapterLoadingStrategy strategy)
     {
         // Skip discovery unless we're using the default behavior, or NextToSource is specified.

src/Microsoft.TestPlatform.Common/DataCollection/DataCollectionManager.cs

@@ -79,6 +79,8 @@ internal class DataCollectionManager : IDataCollectionManager
     /// <param name="messageSink">
     /// The message Sink.
     /// </param>
+    /// <param name="requestData">request data</param>
+    /// <param name="telemetryReporter">telemetry reporter</param>
     internal DataCollectionManager(IMessageSink messageSink, IRequestData requestData, ITelemetryReporter telemetryReporter) : this(new DataCollectionAttachmentManager(), messageSink, new DataCollectionTelemetryManager(requestData), telemetryReporter)
     {
     }
@@ -92,6 +94,8 @@ internal class DataCollectionManager : IDataCollectionManager
     /// <param name="messageSink">
     /// The message Sink.
     /// </param>
+    /// <param name="dataCollectionTelemetryManager">telemetry manager</param>
+    /// <param name="telemetryReporter">telemetry reporter</param>
     /// <remarks>
     /// The constructor is not public because the factory method should be used to get instances of this class.
     /// </remarks>
@@ -136,6 +140,8 @@ private DataCollectorExtensionManager DataCollectorExtensionManager
     /// <param name="messageSink">
     /// The message sink.
     /// </param>
+    /// <param name="requestData">request data</param>
+    /// <param name="telemetryReporter">telemetry reporter</param>
     /// <returns>
     /// The <see cref="DataCollectionManager"/>.
     /// </returns>

src/Microsoft.TestPlatform.Common/DataCollection/Interfaces/IDataCollectionAttachmentManager.cs

@@ -36,7 +36,7 @@ internal interface IDataCollectionAttachmentManager
     /// The data collection context.
     /// </param>
     /// <returns>
-    /// The <see cref="List"/>.
+    /// The <see cref="List{T}"/>.
     /// </returns>
     List<AttachmentSet> GetAttachments(DataCollectionContext dataCollectionContext);
 

src/Microsoft.TestPlatform.Common/ExtensionFramework/DataCollectionExtensionManager.cs

@@ -111,6 +111,7 @@ public DataCollectorMetadata(string extension, string friendlyName)
     /// </param>
     /// <param name="friendlyName">
     /// The friendly Name.
+    /// </param>
     /// <param name="hasAttachmentProcessor">
     /// Indicates if the current data collector registers an attachment processor
     /// </param>

src/Microsoft.TestPlatform.Common/ExtensionFramework/TestDiscoveryExtensionManager.cs

@@ -141,6 +141,8 @@ internal class TestDiscovererMetadata : ITestDiscovererCapabilities
     /// </summary>
     /// <param name="fileExtensions"> The file Extensions. </param>
     /// <param name="defaultExecutorUri"> The default Executor Uri. </param>
+    /// <param name="assemblyType">Type of the assembly.</param>
+    /// <param name="isDirectoryBased">True when the discoverer is based on directories.</param>
     public TestDiscovererMetadata(IReadOnlyCollection<string>? fileExtensions, string? defaultExecutorUri, AssemblyType assemblyType = default, bool isDirectoryBased = false)
     {
         if (fileExtensions != null && fileExtensions.Count > 0)

src/Microsoft.TestPlatform.Common/ExtensionFramework/TestPluginCache.cs

@@ -82,6 +82,7 @@ internal set
     /// Gets a list of all extension paths filtered by input string.
     /// </summary>
     /// <param name="endsWithPattern">Pattern to filter extension paths.</param>
+    /// <param name="skipDefaultExtensions">True when default extensions should be skipped.</param>
     public List<string> GetExtensionPaths(string endsWithPattern, bool skipDefaultExtensions = false)
     {
         var extensions = GetFilteredExtensions(_filterableExtensionPaths, endsWithPattern);
@@ -115,7 +116,7 @@ public List<string> GetExtensionPaths(string endsWithPattern, bool skipDefaultEx
     /// Pattern used to select files using String.EndsWith
     /// </param>
     /// <returns>
-    /// The <see cref="Dictionary"/>. of test plugin info.
+    /// The <see cref="Dictionary{TKey, TValue}"/>. of test plugin info.
     /// </returns>
     public Dictionary<string, TPluginInfo>? DiscoverTestExtensions<TPluginInfo, TExtension>(
         string endsWithPattern)
@@ -306,7 +307,7 @@ internal IEnumerable<string> DefaultExtensionPaths
     /// Type of extension.
     /// </typeparam>
     /// <returns>
-    /// The <see cref="Dictionary"/>.
+    /// The <see cref="Dictionary{TKey, TValue>"/>.
     /// </returns>
     internal Dictionary<string, TPluginInfo> GetTestExtensions<TPluginInfo, TExtension>(
         string extensionAssembly,