diff --git a/Directory.Build.props b/Directory.Build.props index 1d8854a6ba..94e7a2ac6d 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -45,18 +45,7 @@ preview true - - $(NoWarn);CA1416;RS0037;CS1570;CS1572;CS1573;CS1574;CS1591 + $(NoWarn);CA1416;RS0037 diff --git a/src/Microsoft.TestPlatform.Client/DesignMode/IDesignModeClient.cs b/src/Microsoft.TestPlatform.Client/DesignMode/IDesignModeClient.cs index 1a21066235..a8b8c023c6 100644 --- a/src/Microsoft.TestPlatform.Client/DesignMode/IDesignModeClient.cs +++ b/src/Microsoft.TestPlatform.Client/DesignMode/IDesignModeClient.cs @@ -20,6 +20,7 @@ public interface IDesignModeClient : IDisposable /// Setups client based on port /// /// port number to connect + /// test request manager void ConnectToClientAndProcessRequests(int port, ITestRequestManager testRequestManager); /// diff --git a/src/Microsoft.TestPlatform.Client/Discovery/DiscoveryRequest.cs b/src/Microsoft.TestPlatform.Client/Discovery/DiscoveryRequest.cs index 9a2e655868..530a5d82f3 100644 --- a/src/Microsoft.TestPlatform.Client/Discovery/DiscoveryRequest.cs +++ b/src/Microsoft.TestPlatform.Client/Discovery/DiscoveryRequest.cs @@ -33,6 +33,7 @@ public sealed class DiscoveryRequest : IDiscoveryRequest, ITestDiscoveryEventsHa /// The Request Data instance providing services and data for discovery /// Discovery criterion. /// Discovery manager instance. + /// Logger manager instance. 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, /// The Request Data instance providing services and data for discovery /// Discovery criterion. /// Discovery manager instance. + /// Logger manager instance. /// Data Serializer internal DiscoveryRequest( IRequestData requestData, diff --git a/src/Microsoft.TestPlatform.Client/RequestHelper/ITestRequestManager.cs b/src/Microsoft.TestPlatform.Client/RequestHelper/ITestRequestManager.cs index 291d69954f..758c63a6f0 100644 --- a/src/Microsoft.TestPlatform.Client/RequestHelper/ITestRequestManager.cs +++ b/src/Microsoft.TestPlatform.Client/RequestHelper/ITestRequestManager.cs @@ -92,7 +92,7 @@ void StartTestSession( /// Stops a test session. /// /// - /// The stop test session payload. + /// The stop test session payload. /// The events handler. /// Protocol related information. void StopTestSession( diff --git a/src/Microsoft.TestPlatform.Client/TestPlatform.cs b/src/Microsoft.TestPlatform.Client/TestPlatform.cs index 73b7a47627..56a1dea9c2 100644 --- a/src/Microsoft.TestPlatform.Client/TestPlatform.cs +++ b/src/Microsoft.TestPlatform.Client/TestPlatform.cs @@ -231,6 +231,7 @@ private void AddExtensionAssemblies(string? runSettings, TestAdapterLoadingStrat /// /// /// The list of sources. + /// Adapter loading strategy private void AddLoggerAssembliesFromSource(IEnumerable sources, TestAdapterLoadingStrategy strategy) { // Skip discovery unless we're using the default behavior, or NextToSource is specified. diff --git a/src/Microsoft.TestPlatform.Common/DataCollection/DataCollectionManager.cs b/src/Microsoft.TestPlatform.Common/DataCollection/DataCollectionManager.cs index 055d3d0e39..5fdaf63c00 100644 --- a/src/Microsoft.TestPlatform.Common/DataCollection/DataCollectionManager.cs +++ b/src/Microsoft.TestPlatform.Common/DataCollection/DataCollectionManager.cs @@ -79,6 +79,8 @@ internal class DataCollectionManager : IDataCollectionManager /// /// The message Sink. /// + /// request data + /// telemetry reporter internal DataCollectionManager(IMessageSink messageSink, IRequestData requestData, ITelemetryReporter telemetryReporter) : this(new DataCollectionAttachmentManager(), messageSink, new DataCollectionTelemetryManager(requestData), telemetryReporter) { } @@ -92,6 +94,8 @@ internal class DataCollectionManager : IDataCollectionManager /// /// The message Sink. /// + /// telemetry manager + /// telemetry reporter /// /// The constructor is not public because the factory method should be used to get instances of this class. /// @@ -136,6 +140,8 @@ private DataCollectorExtensionManager DataCollectorExtensionManager /// /// The message sink. /// + /// request data + /// telemetry reporter /// /// The . /// diff --git a/src/Microsoft.TestPlatform.Common/DataCollection/Interfaces/IDataCollectionAttachmentManager.cs b/src/Microsoft.TestPlatform.Common/DataCollection/Interfaces/IDataCollectionAttachmentManager.cs index adda6c450e..bcc92420e9 100644 --- a/src/Microsoft.TestPlatform.Common/DataCollection/Interfaces/IDataCollectionAttachmentManager.cs +++ b/src/Microsoft.TestPlatform.Common/DataCollection/Interfaces/IDataCollectionAttachmentManager.cs @@ -36,7 +36,7 @@ internal interface IDataCollectionAttachmentManager /// The data collection context. /// /// - /// The . + /// The . /// List GetAttachments(DataCollectionContext dataCollectionContext); diff --git a/src/Microsoft.TestPlatform.Common/ExtensionFramework/DataCollectionExtensionManager.cs b/src/Microsoft.TestPlatform.Common/ExtensionFramework/DataCollectionExtensionManager.cs index 2d3485ecc0..2fa6b1f1c5 100644 --- a/src/Microsoft.TestPlatform.Common/ExtensionFramework/DataCollectionExtensionManager.cs +++ b/src/Microsoft.TestPlatform.Common/ExtensionFramework/DataCollectionExtensionManager.cs @@ -111,6 +111,7 @@ public DataCollectorMetadata(string extension, string friendlyName) /// /// /// The friendly Name. + /// /// /// Indicates if the current data collector registers an attachment processor /// diff --git a/src/Microsoft.TestPlatform.Common/ExtensionFramework/TestDiscoveryExtensionManager.cs b/src/Microsoft.TestPlatform.Common/ExtensionFramework/TestDiscoveryExtensionManager.cs index f64c566eea..885b279e55 100644 --- a/src/Microsoft.TestPlatform.Common/ExtensionFramework/TestDiscoveryExtensionManager.cs +++ b/src/Microsoft.TestPlatform.Common/ExtensionFramework/TestDiscoveryExtensionManager.cs @@ -141,6 +141,8 @@ internal class TestDiscovererMetadata : ITestDiscovererCapabilities /// /// The file Extensions. /// The default Executor Uri. + /// Type of the assembly. + /// True when the discoverer is based on directories. public TestDiscovererMetadata(IReadOnlyCollection? fileExtensions, string? defaultExecutorUri, AssemblyType assemblyType = default, bool isDirectoryBased = false) { if (fileExtensions != null && fileExtensions.Count > 0) diff --git a/src/Microsoft.TestPlatform.Common/ExtensionFramework/TestPluginCache.cs b/src/Microsoft.TestPlatform.Common/ExtensionFramework/TestPluginCache.cs index 40ca9a1cf3..b7301292e3 100644 --- a/src/Microsoft.TestPlatform.Common/ExtensionFramework/TestPluginCache.cs +++ b/src/Microsoft.TestPlatform.Common/ExtensionFramework/TestPluginCache.cs @@ -82,6 +82,7 @@ internal set /// Gets a list of all extension paths filtered by input string. /// /// Pattern to filter extension paths. + /// True when default extensions should be skipped. public List GetExtensionPaths(string endsWithPattern, bool skipDefaultExtensions = false) { var extensions = GetFilteredExtensions(_filterableExtensionPaths, endsWithPattern); @@ -115,7 +116,7 @@ public List GetExtensionPaths(string endsWithPattern, bool skipDefaultEx /// Pattern used to select files using String.EndsWith /// /// - /// The . of test plugin info. + /// The . of test plugin info. /// public Dictionary? DiscoverTestExtensions( string endsWithPattern) @@ -306,7 +307,7 @@ internal IEnumerable DefaultExtensionPaths /// Type of extension. /// /// - /// The . + /// The . /// internal Dictionary GetTestExtensions( string extensionAssembly, diff --git a/src/Microsoft.TestPlatform.Common/ExtensionFramework/TestPluginDiscoverer.cs b/src/Microsoft.TestPlatform.Common/ExtensionFramework/TestPluginDiscoverer.cs index 360d29bb92..5c0cdf8354 100644 --- a/src/Microsoft.TestPlatform.Common/ExtensionFramework/TestPluginDiscoverer.cs +++ b/src/Microsoft.TestPlatform.Common/ExtensionFramework/TestPluginDiscoverer.cs @@ -117,6 +117,7 @@ private static void GetTestExtensionsFromFiles( /// /// Assembly to check for test extension availability /// Test extensions collection to add to. + /// File path of the assembly. /// /// Type of Test Plugin Information. /// @@ -201,6 +202,7 @@ private static void GetTestExtensionsFromAssembly(Assem /// /// Test extensions collection to add to. /// + /// File path of the assembly. private static void GetTestExtensionFromType( Type type, Type extensionType, diff --git a/src/Microsoft.TestPlatform.Common/ExtensionFramework/Utilities/TestExtensions.cs b/src/Microsoft.TestPlatform.Common/ExtensionFramework/Utilities/TestExtensions.cs index e1f6c01ebc..5e5055af02 100644 --- a/src/Microsoft.TestPlatform.Common/ExtensionFramework/Utilities/TestExtensions.cs +++ b/src/Microsoft.TestPlatform.Common/ExtensionFramework/Utilities/TestExtensions.cs @@ -176,7 +176,7 @@ internal static void AddExtensionTelemetry( /// The info about new extensions discovered /// /// - /// The of extensions discovered + /// The of extensions discovered /// internal Dictionary? AddExtension(Dictionary? newExtensions) where TPluginInfo : TestPluginInformation @@ -415,7 +415,7 @@ internal void InvalidateCache() /// /// /// - /// The . of extensions discovered in assembly + /// The . of extensions discovered in assembly /// internal static Dictionary GetExtensionsDiscoveredFromAssembly( Dictionary? extensionCollection, diff --git a/src/Microsoft.TestPlatform.Common/Filtering/Condition.cs b/src/Microsoft.TestPlatform.Common/Filtering/Condition.cs index c333120b49..6d112c3fd3 100644 --- a/src/Microsoft.TestPlatform.Common/Filtering/Condition.cs +++ b/src/Microsoft.TestPlatform.Common/Filtering/Condition.cs @@ -167,7 +167,7 @@ internal bool Evaluate(Func propertyValueProvider) } /// - /// Returns a condition object after parsing input string of format 'Operation' + /// Returns a condition object after parsing input string of format 'Operation' /// internal static Condition Parse(string? conditionString) { diff --git a/src/Microsoft.TestPlatform.Common/Filtering/FilterExpression.cs b/src/Microsoft.TestPlatform.Common/Filtering/FilterExpression.cs index a587d1a98d..249b1b5916 100644 --- a/src/Microsoft.TestPlatform.Common/Filtering/FilterExpression.cs +++ b/src/Microsoft.TestPlatform.Common/Filtering/FilterExpression.cs @@ -19,7 +19,7 @@ namespace Microsoft.VisualStudio.TestPlatform.Common.Filtering; /// /// Represents an expression tree. /// Supports: -/// Logical Operators: &, | +/// Logical Operators: &, | /// Equality Operators: =, != /// Parenthesis (, ) for grouping. /// @@ -41,7 +41,7 @@ internal class FilterExpression private readonly FilterExpression? _right; /// - /// If logical expression is using logical And ('&') operator. + /// If logical expression is using logical And ('&') operator. /// private readonly bool _areJoinedByAnd; diff --git a/src/Microsoft.TestPlatform.Common/Interfaces/Engine/ClientProtocol/ITestEngine.cs b/src/Microsoft.TestPlatform.Common/Interfaces/Engine/ClientProtocol/ITestEngine.cs index eb40e4328c..d249244586 100644 --- a/src/Microsoft.TestPlatform.Common/Interfaces/Engine/ClientProtocol/ITestEngine.cs +++ b/src/Microsoft.TestPlatform.Common/Interfaces/Engine/ClientProtocol/ITestEngine.cs @@ -20,8 +20,9 @@ public interface ITestEngine /// /// The request data for providing discovery services and data. /// - /// Test host manager for the current test discovery. /// The discovery criteria. + /// Details of every source. + /// Logger of warnings. /// /// An IProxyDiscoveryManager object that can do discovery. IProxyDiscoveryManager GetDiscoveryManager( @@ -38,7 +39,8 @@ IProxyDiscoveryManager GetDiscoveryManager( /// /// The request data for providing common execution services and data. /// - /// Test host manager for the current test run. + /// Details of every source. + /// Logger of warnings. /// Test run criteria of the current test run. /// /// An IProxyExecutionManager object that can do execution. @@ -59,6 +61,8 @@ IProxyExecutionManager GetExecutionManager( /// /// Test session criteria of the current test session. /// + /// Details of every source. + /// Logger of warnings. /// /// An IProxyTestSessionManager object that can manage test sessions. IProxyTestSessionManager? GetTestSessionManager( diff --git a/src/Microsoft.TestPlatform.Common/Interfaces/Engine/IDataCollectorAttachmentsProcessorsFactory.cs b/src/Microsoft.TestPlatform.Common/Interfaces/Engine/IDataCollectorAttachmentsProcessorsFactory.cs index 250e3460a5..ef1b3f1228 100644 --- a/src/Microsoft.TestPlatform.Common/Interfaces/Engine/IDataCollectorAttachmentsProcessorsFactory.cs +++ b/src/Microsoft.TestPlatform.Common/Interfaces/Engine/IDataCollectorAttachmentsProcessorsFactory.cs @@ -17,7 +17,7 @@ internal interface IDataCollectorAttachmentsProcessorsFactory /// /// Creates and return a list of available attachments processor /// - /// List of invoked data collectors + /// List of invoked data collectors /// Message logger /// List of attachments processors DataCollectorAttachmentProcessor[] Create(InvokedDataCollector[]? invokedDataCollectors, IMessageLogger logger); diff --git a/src/Microsoft.TestPlatform.Common/Interfaces/Engine/ITestRunAttachmentsProcessingManager.cs b/src/Microsoft.TestPlatform.Common/Interfaces/Engine/ITestRunAttachmentsProcessingManager.cs index b04cfc66e5..7bb7692c15 100644 --- a/src/Microsoft.TestPlatform.Common/Interfaces/Engine/ITestRunAttachmentsProcessingManager.cs +++ b/src/Microsoft.TestPlatform.Common/Interfaces/Engine/ITestRunAttachmentsProcessingManager.cs @@ -19,6 +19,7 @@ internal interface ITestRunAttachmentsProcessingManager /// Processes attachments and provides results through handler /// /// RunSettings + /// Data in the request. /// Collection of attachments /// Collection of invoked data collectors /// EventHandler for handling test run attachments processing event @@ -29,6 +30,7 @@ internal interface ITestRunAttachmentsProcessingManager /// Processes attachments /// /// RunSettings + /// Data in the request. /// Collection of attachments /// Collection of invoked data collectors /// Cancellation token diff --git a/src/Microsoft.TestPlatform.Common/Interfaces/Engine/TesthostProtocol/IDiscoveryManager.cs b/src/Microsoft.TestPlatform.Common/Interfaces/Engine/TesthostProtocol/IDiscoveryManager.cs index c3c2ffdae2..73fc09bdac 100644 --- a/src/Microsoft.TestPlatform.Common/Interfaces/Engine/TesthostProtocol/IDiscoveryManager.cs +++ b/src/Microsoft.TestPlatform.Common/Interfaces/Engine/TesthostProtocol/IDiscoveryManager.cs @@ -16,6 +16,7 @@ public interface IDiscoveryManager /// Initializes the discovery manager. /// /// The path to additional extensions. + /// The discovery handler. void Initialize(IEnumerable pathToAdditionalExtensions, ITestDiscoveryEventsHandler2? eventHandler); /// diff --git a/src/Microsoft.TestPlatform.Common/Interfaces/Engine/TesthostProtocol/IExecutionManager.cs b/src/Microsoft.TestPlatform.Common/Interfaces/Engine/TesthostProtocol/IExecutionManager.cs index 15ca486b19..37f67bab5a 100644 --- a/src/Microsoft.TestPlatform.Common/Interfaces/Engine/TesthostProtocol/IExecutionManager.cs +++ b/src/Microsoft.TestPlatform.Common/Interfaces/Engine/TesthostProtocol/IExecutionManager.cs @@ -17,6 +17,7 @@ public interface IExecutionManager /// Initializes the execution manager. /// /// The path to additional extensions. + /// Handler of test messages. void Initialize(IEnumerable pathToAdditionalExtensions, ITestMessageEventHandler? testMessageEventsHandler); /// @@ -48,12 +49,12 @@ public interface IExecutionManager /// /// Cancel the test execution. /// - /// EventHandler for handling execution events from Engine. + /// EventHandler for handling execution events from Engine. void Cancel(IInternalTestRunEventsHandler testRunEventsHandler); /// /// Aborts the test execution. /// - /// EventHandler for handling execution events from Engine. + /// EventHandler for handling execution events from Engine. void Abort(IInternalTestRunEventsHandler testRunEventsHandler); } diff --git a/src/Microsoft.TestPlatform.Common/Interfaces/ITestDiscovererCapabilities.cs b/src/Microsoft.TestPlatform.Common/Interfaces/ITestDiscovererCapabilities.cs index 0d755333da..4a867e366f 100644 --- a/src/Microsoft.TestPlatform.Common/Interfaces/ITestDiscovererCapabilities.cs +++ b/src/Microsoft.TestPlatform.Common/Interfaces/ITestDiscovererCapabilities.cs @@ -29,7 +29,7 @@ public interface ITestDiscovererCapabilities AssemblyType AssemblyType { get; } /// - /// if the discoverer plugin is decorated with , + /// if the discoverer plugin is decorated with ObjectDirectoryBasedTestDiscovererAttribute/>, /// otherwise. /// bool IsDirectoryBased { get; } diff --git a/src/Microsoft.TestPlatform.Common/Utilities/FakesUtilities.cs b/src/Microsoft.TestPlatform.Common/Utilities/FakesUtilities.cs index feac1e682c..0193c4ebb4 100644 --- a/src/Microsoft.TestPlatform.Common/Utilities/FakesUtilities.cs +++ b/src/Microsoft.TestPlatform.Common/Utilities/FakesUtilities.cs @@ -90,6 +90,7 @@ public static string GenerateFakesSettingsForRunConfiguration(string[] sources, /// /// runsettings /// test sources + /// version of the framework /// true if runSettings was modified; false otherwise. private static bool TryAddFakesDataCollectorSettings( XmlDocument runSettings, diff --git a/src/Microsoft.TestPlatform.Common/Utilities/RunSettingsProviderExtensions.cs b/src/Microsoft.TestPlatform.Common/Utilities/RunSettingsProviderExtensions.cs index aa691c27d8..4e87b120cc 100644 --- a/src/Microsoft.TestPlatform.Common/Utilities/RunSettingsProviderExtensions.cs +++ b/src/Microsoft.TestPlatform.Common/Utilities/RunSettingsProviderExtensions.cs @@ -89,7 +89,7 @@ public static void UpdateRunSettingsNode(this IRunSettingsProvider runSettingsPr /// /// Matches with test run parameter node pattern and returns that match. /// - /// + /// /// /// public static Match GetTestRunParameterNodeMatch(this IRunSettingsProvider _, string node) diff --git a/src/Microsoft.TestPlatform.Common/Utilities/RunSettingsUtilities.cs b/src/Microsoft.TestPlatform.Common/Utilities/RunSettingsUtilities.cs index f9fb02e684..97376c5f05 100644 --- a/src/Microsoft.TestPlatform.Common/Utilities/RunSettingsUtilities.cs +++ b/src/Microsoft.TestPlatform.Common/Utilities/RunSettingsUtilities.cs @@ -169,7 +169,6 @@ private static bool GetTreatNoTestsAsError(RunConfiguration? runConfiguration) /// Gets the test adapters path from the run configuration /// /// Test run settings - /// True to return null, if adapter paths is not set. /// Test adapters paths public static IEnumerable GetTestAdaptersPaths(string? runSettings) { diff --git a/src/Microsoft.TestPlatform.CommunicationUtilities/DataCollectionTestCaseEventHandler.cs b/src/Microsoft.TestPlatform.CommunicationUtilities/DataCollectionTestCaseEventHandler.cs index e472ee3eba..483bf64db1 100644 --- a/src/Microsoft.TestPlatform.CommunicationUtilities/DataCollectionTestCaseEventHandler.cs +++ b/src/Microsoft.TestPlatform.CommunicationUtilities/DataCollectionTestCaseEventHandler.cs @@ -35,6 +35,7 @@ internal DataCollectionTestCaseEventHandler(IMessageSink messageSink) /// /// Initializes a new instance of the class. /// + /// Sink for messages /// Communication manager implementation. /// Data collection manager implementation. /// Serializer for serialization and deserialization of the messages. diff --git a/src/Microsoft.TestPlatform.CommunicationUtilities/Interfaces/IDataCollectionTestCaseEventSender.cs b/src/Microsoft.TestPlatform.CommunicationUtilities/Interfaces/IDataCollectionTestCaseEventSender.cs index 6a0efce3ce..1e650f4c21 100644 --- a/src/Microsoft.TestPlatform.CommunicationUtilities/Interfaces/IDataCollectionTestCaseEventSender.cs +++ b/src/Microsoft.TestPlatform.CommunicationUtilities/Interfaces/IDataCollectionTestCaseEventSender.cs @@ -46,7 +46,7 @@ public interface IDataCollectionTestCaseEventSender /// The args containing info about TestResult event. /// /// - /// The Collection of TestCase attachments. + /// The Collection of TestCase attachments. /// Collection? SendTestCaseEnd(TestCaseEndEventArgs e); diff --git a/src/Microsoft.TestPlatform.CommunicationUtilities/Interfaces/ITestRequestHandler.cs b/src/Microsoft.TestPlatform.CommunicationUtilities/Interfaces/ITestRequestHandler.cs index ff2b72de40..f7f5ec0994 100644 --- a/src/Microsoft.TestPlatform.CommunicationUtilities/Interfaces/ITestRequestHandler.cs +++ b/src/Microsoft.TestPlatform.CommunicationUtilities/Interfaces/ITestRequestHandler.cs @@ -91,7 +91,7 @@ public interface ITestRequestHandler : IDisposable /// /// Attach debugger to an already running process. /// - /// Process ID of the process to which the debugger should be attached. + /// Process ID and tfm of the process to which the debugger should be attached. /// if the debugger was successfully attached to the requested process, otherwise. bool AttachDebuggerToProcess(AttachDebuggerInfo attachDebuggerInfo); } diff --git a/src/Microsoft.TestPlatform.CoreUtilities/Helpers/CommandLineArgumentsHelper.cs b/src/Microsoft.TestPlatform.CoreUtilities/Helpers/CommandLineArgumentsHelper.cs index 6d59b3b1e9..c7d703b878 100644 --- a/src/Microsoft.TestPlatform.CoreUtilities/Helpers/CommandLineArgumentsHelper.cs +++ b/src/Microsoft.TestPlatform.CoreUtilities/Helpers/CommandLineArgumentsHelper.cs @@ -61,6 +61,7 @@ public static int GetIntArgFromDict(IDictionary argsDictionary, /// /// Dictionary of all arguments Ex: { "--port":"12312", "--parentprocessid":"2312" } /// The full name for required argument. Ex: "--port" + /// The output value. /// Value of the argument. /// Thrown if value of an argument is not an integer. public static bool TryGetIntArgFromDict(IDictionary argsDictionary, string fullname, out int value) diff --git a/src/Microsoft.TestPlatform.CoreUtilities/Helpers/Interfaces/IFileHelper.cs b/src/Microsoft.TestPlatform.CoreUtilities/Helpers/Interfaces/IFileHelper.cs index 1d61a75296..fb26029518 100644 --- a/src/Microsoft.TestPlatform.CoreUtilities/Helpers/Interfaces/IFileHelper.cs +++ b/src/Microsoft.TestPlatform.CoreUtilities/Helpers/Interfaces/IFileHelper.cs @@ -132,6 +132,7 @@ public interface IFileHelper /// /// The directory path. /// + /// If we should delete recursively. void DeleteDirectory(string directoryPath, bool recursive); /// @@ -152,7 +153,6 @@ public interface IFileHelper /// /// Get temporary file path /// - /// public string GetTempPath(); /// diff --git a/src/Microsoft.TestPlatform.CrossPlatEngine/Client/InProcessProxyexecutionManager.cs b/src/Microsoft.TestPlatform.CrossPlatEngine/Client/InProcessProxyexecutionManager.cs index 4dd1772c99..9ac60d0d1f 100644 --- a/src/Microsoft.TestPlatform.CrossPlatEngine/Client/InProcessProxyexecutionManager.cs +++ b/src/Microsoft.TestPlatform.CrossPlatEngine/Client/InProcessProxyexecutionManager.cs @@ -28,7 +28,7 @@ internal class InProcessProxyExecutionManager : IProxyExecutionManager public bool IsInitialized { get; private set; } /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// /// /// The test Host Manager. diff --git a/src/Microsoft.TestPlatform.CrossPlatEngine/Client/Parallel/ParallelProxyDiscoveryManager.cs b/src/Microsoft.TestPlatform.CrossPlatEngine/Client/Parallel/ParallelProxyDiscoveryManager.cs index 5cae5c4eea..417b619585 100644 --- a/src/Microsoft.TestPlatform.CrossPlatEngine/Client/Parallel/ParallelProxyDiscoveryManager.cs +++ b/src/Microsoft.TestPlatform.CrossPlatEngine/Client/Parallel/ParallelProxyDiscoveryManager.cs @@ -260,7 +260,9 @@ static DiscoveryCriteria NewDiscoveryCriteriaFromSourceAndSettings(IEnumerable - /// Proxy discovery manager instance. + /// Proxy discovery manager instance. + /// Discovery events handler. + /// Discovery criteria a parameters. private Task InitializeDiscoverTestsOnConcurrentManager(IProxyDiscoveryManager proxyDiscoveryManager, ITestDiscoveryEventsHandler2 eventHandler, DiscoveryCriteria discoveryCriteria) { // Kick off another discovery task for the next source @@ -279,7 +281,11 @@ private Task InitializeDiscoverTestsOnConcurrentManager(IProxyDiscoveryManager p /// Triggers the discovery for the next data object on the concurrent discoverer /// Each concurrent discoverer calls this method, once its completed working on previous data /// - /// Proxy discovery manager instance. + /// + /// + /// + /// + /// private void DiscoverTestsOnConcurrentManager( IProxyDiscoveryManager proxyDiscoveryManager, ITestDiscoveryEventsHandler2 eventHandler, diff --git a/src/Microsoft.TestPlatform.CrossPlatEngine/Client/Parallel/ParallelProxyExecutionManager.cs b/src/Microsoft.TestPlatform.CrossPlatEngine/Client/Parallel/ParallelProxyExecutionManager.cs index 4329d4620f..c020d44d85 100644 --- a/src/Microsoft.TestPlatform.CrossPlatEngine/Client/Parallel/ParallelProxyExecutionManager.cs +++ b/src/Microsoft.TestPlatform.CrossPlatEngine/Client/Parallel/ParallelProxyExecutionManager.cs @@ -418,7 +418,6 @@ private Task PrepareTestRunOnConcurrentManager(IProxyExecutionManager proxyExecu /// Triggers the execution for the next data object on the concurrent executor /// Each concurrent executor calls this method, once its completed working on previous data /// - /// Proxy execution manager instance. /// True, if execution triggered private void StartTestRunOnConcurrentManager( IProxyExecutionManager proxyExecutionManager, diff --git a/src/Microsoft.TestPlatform.CrossPlatEngine/Client/ProxyDiscoveryManager.cs b/src/Microsoft.TestPlatform.CrossPlatEngine/Client/ProxyDiscoveryManager.cs index caa2643b24..a20d68a7c2 100644 --- a/src/Microsoft.TestPlatform.CrossPlatEngine/Client/ProxyDiscoveryManager.cs +++ b/src/Microsoft.TestPlatform.CrossPlatEngine/Client/ProxyDiscoveryManager.cs @@ -95,6 +95,8 @@ public ProxyDiscoveryManager( /// /// The request sender. /// Test host manager instance. + /// Framework of the manager. + /// Aggregator of discovery data. /// The data serializer. /// The file helper. internal ProxyDiscoveryManager( diff --git a/src/Microsoft.TestPlatform.CrossPlatEngine/Client/ProxyExecutionManager.cs b/src/Microsoft.TestPlatform.CrossPlatEngine/Client/ProxyExecutionManager.cs index 23cb164489..42442f0735 100644 --- a/src/Microsoft.TestPlatform.CrossPlatEngine/Client/ProxyExecutionManager.cs +++ b/src/Microsoft.TestPlatform.CrossPlatEngine/Client/ProxyExecutionManager.cs @@ -100,6 +100,7 @@ public ProxyExecutionManager( /// /// Test request sender instance. /// Test host manager for this proxy. + /// Framework of testhost public ProxyExecutionManager( IRequestData requestData, ITestRequestSender requestSender, @@ -126,6 +127,7 @@ public ProxyExecutionManager( /// The request data for common services and data for run. /// Request sender instance. /// Test host manager instance. + /// Framework of testhost /// Data serializer instance. /// File helper instance. internal ProxyExecutionManager( diff --git a/src/Microsoft.TestPlatform.CrossPlatEngine/Client/ProxyExecutionManagerWithDataCollection.cs b/src/Microsoft.TestPlatform.CrossPlatEngine/Client/ProxyExecutionManagerWithDataCollection.cs index 31cfbc1c20..f6fcaa00b4 100644 --- a/src/Microsoft.TestPlatform.CrossPlatEngine/Client/ProxyExecutionManagerWithDataCollection.cs +++ b/src/Microsoft.TestPlatform.CrossPlatEngine/Client/ProxyExecutionManagerWithDataCollection.cs @@ -33,6 +33,7 @@ internal class ProxyExecutionManagerWithDataCollection : ProxyExecutionManager /// /// Test host manager for this operation. /// + /// Framework of the testhost. /// /// The proxy Data Collection Manager. /// diff --git a/src/Microsoft.TestPlatform.CrossPlatEngine/Client/ProxyOperationManager.cs b/src/Microsoft.TestPlatform.CrossPlatEngine/Client/ProxyOperationManager.cs index 59a5f68a47..8c47267c76 100644 --- a/src/Microsoft.TestPlatform.CrossPlatEngine/Client/ProxyOperationManager.cs +++ b/src/Microsoft.TestPlatform.CrossPlatEngine/Client/ProxyOperationManager.cs @@ -1,3 +1,4 @@ + // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. @@ -58,6 +59,7 @@ public class ProxyOperationManager /// Request data instance. /// Request sender instance. /// Test host manager instance. + /// Testhost manager framework public ProxyOperationManager( IRequestData? requestData, ITestRequestSender requestSender, @@ -78,6 +80,7 @@ public ProxyOperationManager( /// Request data instance. /// Request sender instance. /// Test host manager instance. + /// Testhost manager framework /// The base proxy. public ProxyOperationManager( IRequestData? requestData, @@ -395,6 +398,7 @@ public virtual TestProcessStartInfo UpdateTestProcessStartInfo(TestProcessStartI /// /// /// Run settings string. + /// Message logger. /// /// The run settings after removing non-required nodes. public string? RemoveNodesFromRunsettingsIfRequired(string? runsettingsXml, Action logMessage) diff --git a/src/Microsoft.TestPlatform.CrossPlatEngine/Client/ProxyOperationManagerWithDataCollection.cs b/src/Microsoft.TestPlatform.CrossPlatEngine/Client/ProxyOperationManagerWithDataCollection.cs index 1eac8f3d94..3ff84390ed 100644 --- a/src/Microsoft.TestPlatform.CrossPlatEngine/Client/ProxyOperationManagerWithDataCollection.cs +++ b/src/Microsoft.TestPlatform.CrossPlatEngine/Client/ProxyOperationManagerWithDataCollection.cs @@ -29,6 +29,7 @@ public class ProxyOperationManagerWithDataCollection : ProxyOperationManager /// The request data. /// The request sender. /// The test host manager. + /// Framework of the testhost. /// The data collection proxy. public ProxyOperationManagerWithDataCollection( IRequestData requestData, diff --git a/src/Microsoft.TestPlatform.CrossPlatEngine/DataCollection/DataCollectionTestRunEventsHandler.cs b/src/Microsoft.TestPlatform.CrossPlatEngine/DataCollection/DataCollectionTestRunEventsHandler.cs index 11440b5b15..cc522a6f6b 100644 --- a/src/Microsoft.TestPlatform.CrossPlatEngine/DataCollection/DataCollectionTestRunEventsHandler.cs +++ b/src/Microsoft.TestPlatform.CrossPlatEngine/DataCollection/DataCollectionTestRunEventsHandler.cs @@ -41,6 +41,7 @@ internal class DataCollectionTestRunEventsHandler : IInternalTestRunEventsHandle /// /// The proxy Data Collection Manager. /// + /// Cancellation token public DataCollectionTestRunEventsHandler(IInternalTestRunEventsHandler baseTestRunEventsHandler, IProxyDataCollectionManager proxyDataCollectionManager, CancellationToken cancellationToken) : this(baseTestRunEventsHandler, proxyDataCollectionManager, JsonDataSerializer.Instance, cancellationToken) { @@ -58,6 +59,7 @@ public DataCollectionTestRunEventsHandler(IInternalTestRunEventsHandler baseTest /// /// The data Serializer. /// + /// Cancellation token. public DataCollectionTestRunEventsHandler(IInternalTestRunEventsHandler baseTestRunEventsHandler, IProxyDataCollectionManager proxyDataCollectionManager, IDataSerializer dataSerializer, CancellationToken cancellationToken) { _proxyDataCollectionManager = proxyDataCollectionManager; @@ -196,7 +198,7 @@ public bool AttachDebuggerToProcess(AttachDebuggerInfo attachDebuggerInfo) /// The run context attachments. /// /// - /// The . + /// The . /// [return: NotNullIfNotNull("originalAttachmentSets")] [return: NotNullIfNotNull("newAttachments")] diff --git a/src/Microsoft.TestPlatform.CrossPlatEngine/DataCollection/InProcDataCollectionExtensionManager.cs b/src/Microsoft.TestPlatform.CrossPlatEngine/DataCollection/InProcDataCollectionExtensionManager.cs index 89917eaa08..dcd5a59ca1 100644 --- a/src/Microsoft.TestPlatform.CrossPlatEngine/DataCollection/InProcDataCollectionExtensionManager.cs +++ b/src/Microsoft.TestPlatform.CrossPlatEngine/DataCollection/InProcDataCollectionExtensionManager.cs @@ -50,6 +50,7 @@ internal class InProcDataCollectionExtensionManager /// /// The default code base to be used by in-proc data collector /// + /// The cache of test plugins. public InProcDataCollectionExtensionManager(string? runSettings, ITestEventsPublisher testEventsPublisher, string? defaultCodeBase, TestPluginCache testPluginCache) : this(runSettings, testEventsPublisher, defaultCodeBase, testPluginCache, new FileHelper()) { } @@ -90,12 +91,6 @@ protected InProcDataCollectionExtensionManager(string? runSettings, ITestEventsP /// /// Creates data collector instance based on datacollector settings provided. /// - /// - /// Settings to be used for creating DataCollector. - /// - /// - /// TypeInfo of datacollector. - /// /// /// The . /// diff --git a/src/Microsoft.TestPlatform.CrossPlatEngine/DataCollection/InProcDataCollector.cs b/src/Microsoft.TestPlatform.CrossPlatEngine/DataCollection/InProcDataCollector.cs index 466b8d16b4..ee4dd85be0 100644 --- a/src/Microsoft.TestPlatform.CrossPlatEngine/DataCollection/InProcDataCollector.cs +++ b/src/Microsoft.TestPlatform.CrossPlatEngine/DataCollection/InProcDataCollector.cs @@ -57,12 +57,13 @@ public InProcDataCollector( /// /// /// - /// + /// /// /// /// /// /// + /// internal InProcDataCollector(string codeBase, string assemblyQualifiedName, Type interfaceType, string? configXml, IAssemblyLoadContext assemblyLoadContext, TestPluginCache testPluginCache) { _configXml = configXml; diff --git a/src/Microsoft.TestPlatform.CrossPlatEngine/DataCollection/ProxyOutOfProcDataCollectionManager.cs b/src/Microsoft.TestPlatform.CrossPlatEngine/DataCollection/ProxyOutOfProcDataCollectionManager.cs index 8ae2a30f3c..4596d38202 100644 --- a/src/Microsoft.TestPlatform.CrossPlatEngine/DataCollection/ProxyOutOfProcDataCollectionManager.cs +++ b/src/Microsoft.TestPlatform.CrossPlatEngine/DataCollection/ProxyOutOfProcDataCollectionManager.cs @@ -32,8 +32,8 @@ internal class ProxyOutOfProcDataCollectionManager /// /// The data collection test case event sender. /// - /// - /// The data collection test case event manager. + /// + /// Test events publisher. /// public ProxyOutOfProcDataCollectionManager(IDataCollectionTestCaseEventSender dataCollectionTestCaseEventSender, ITestEventsPublisher testEventsPublisher) { diff --git a/src/Microsoft.TestPlatform.CrossPlatEngine/Discovery/DiscovererEnumerator.cs b/src/Microsoft.TestPlatform.CrossPlatEngine/Discovery/DiscovererEnumerator.cs index 418d5a32d4..882e06fcbd 100644 --- a/src/Microsoft.TestPlatform.CrossPlatEngine/Discovery/DiscovererEnumerator.cs +++ b/src/Microsoft.TestPlatform.CrossPlatEngine/Discovery/DiscovererEnumerator.cs @@ -45,6 +45,7 @@ internal class DiscovererEnumerator /// /// The request data for providing discovery services and data. /// The discovery result cache. + /// Cancellation token. public DiscovererEnumerator(IRequestData requestData, DiscoveryResultCache discoveryResultCache, CancellationToken token) : this(requestData, discoveryResultCache, TestPlatformEventSource.Instance, token) { @@ -346,6 +347,7 @@ private static void SetAdapterLoggingSettings(IMessageLogger messageLogger, IRun /// The extension assembly. /// The sources. /// The logger instance. + /// Assembly properties /// The map between an extension type and a source. internal static Dictionary, IEnumerable>? GetDiscovererToSourcesMap( string extensionAssembly, @@ -448,7 +450,7 @@ private static void SetAdapterLoggingSettings(IMessageLogger messageLogger, IRun /// Get assembly type to sources map. /// /// Sources. - /// Assembly type. + /// Assembly properties. /// Sources with matching assembly type. private static IDictionary> GetAssemblyTypeToSoucesMap(IEnumerable sources, IAssemblyProperties assemblyProperties) { diff --git a/src/Microsoft.TestPlatform.CrossPlatEngine/Discovery/DiscoveryManager.cs b/src/Microsoft.TestPlatform.CrossPlatEngine/Discovery/DiscoveryManager.cs index 7651367a15..d572894568 100644 --- a/src/Microsoft.TestPlatform.CrossPlatEngine/Discovery/DiscoveryManager.cs +++ b/src/Microsoft.TestPlatform.CrossPlatEngine/Discovery/DiscoveryManager.cs @@ -71,6 +71,7 @@ protected DiscoveryManager(IRequestData requestData, ITestPlatformEventSource te /// Initializes the discovery manager. /// /// The path to additional extensions. + /// Handler of discovery events. public void Initialize(IEnumerable? pathToAdditionalExtensions, ITestDiscoveryEventsHandler2? eventHandler) { // Clear the request data metrics left over from a potential previous run. diff --git a/src/Microsoft.TestPlatform.CrossPlatEngine/Execution/ExecutionManager.cs b/src/Microsoft.TestPlatform.CrossPlatEngine/Execution/ExecutionManager.cs index a8a53fefa7..04c0065d76 100644 --- a/src/Microsoft.TestPlatform.CrossPlatEngine/Execution/ExecutionManager.cs +++ b/src/Microsoft.TestPlatform.CrossPlatEngine/Execution/ExecutionManager.cs @@ -49,6 +49,7 @@ public ExecutionManager(IRequestData requestData) /// Initializes a new instance of the class. /// /// Test platform event source. + /// Request data protected ExecutionManager(ITestPlatformEventSource testPlatformEventSource, IRequestData requestData) { _testPlatformEventSource = testPlatformEventSource; @@ -61,6 +62,7 @@ protected ExecutionManager(ITestPlatformEventSource testPlatformEventSource, IRe /// Initializes the execution manager. /// /// The path to additional extensions. + /// Handler of test messages public void Initialize(IEnumerable? pathToAdditionalExtensions, ITestMessageEventHandler? testMessageEventsHandler) { // Clear the request data metrics left over from a potential previous run. diff --git a/src/Microsoft.TestPlatform.CrossPlatEngine/Execution/RunTestsWithSources.cs b/src/Microsoft.TestPlatform.CrossPlatEngine/Execution/RunTestsWithSources.cs index 36c157c4c1..98fe1799f1 100644 --- a/src/Microsoft.TestPlatform.CrossPlatEngine/Execution/RunTestsWithSources.cs +++ b/src/Microsoft.TestPlatform.CrossPlatEngine/Execution/RunTestsWithSources.cs @@ -48,7 +48,6 @@ public RunTestsWithSources(IRequestData requestData, Dictionary /// /// - /// internal RunTestsWithSources(IRequestData requestData, Dictionary> adapterSourceMap, string? package, string? runSettings, TestExecutionContext testExecutionContext, ITestCaseEventsHandler? testCaseEventsHandler, IInternalTestRunEventsHandler testRunEventsHandler, Dictionary, IEnumerable>? executorUriVsSourceList) : base(requestData, package, runSettings, testExecutionContext, testCaseEventsHandler, testRunEventsHandler, TestPlatformEventSource.Instance) { diff --git a/src/Microsoft.TestPlatform.CrossPlatEngine/Execution/RunTestsWithTests.cs b/src/Microsoft.TestPlatform.CrossPlatEngine/Execution/RunTestsWithTests.cs index 2049a17bcf..17cf101666 100644 --- a/src/Microsoft.TestPlatform.CrossPlatEngine/Execution/RunTestsWithTests.cs +++ b/src/Microsoft.TestPlatform.CrossPlatEngine/Execution/RunTestsWithTests.cs @@ -34,7 +34,7 @@ public RunTestsWithTests(IRequestData requestData, IEnumerable testCas /// /// /// The user input test source(package) if it differ from actual test source otherwise null. - /// + /// /// /// /// diff --git a/src/Microsoft.TestPlatform.CrossPlatEngine/TestSession/ProxyTestSessionManager.cs b/src/Microsoft.TestPlatform.CrossPlatEngine/TestSession/ProxyTestSessionManager.cs index 74e2e22db1..ccb312023b 100644 --- a/src/Microsoft.TestPlatform.CrossPlatEngine/TestSession/ProxyTestSessionManager.cs +++ b/src/Microsoft.TestPlatform.CrossPlatEngine/TestSession/ProxyTestSessionManager.cs @@ -76,6 +76,7 @@ private enum TestSessionState /// The test session criteria. /// The testhost count. /// The proxy creator. + /// Runtime providers. public ProxyTestSessionManager( StartTestSessionCriteria criteria, int maxTesthostCount, diff --git a/src/Microsoft.TestPlatform.Extensions.BlameDataCollector/BlameCollector.cs b/src/Microsoft.TestPlatform.Extensions.BlameDataCollector/BlameCollector.cs index 3628a29c89..b3bcbf9d99 100644 --- a/src/Microsoft.TestPlatform.Extensions.BlameDataCollector/BlameCollector.cs +++ b/src/Microsoft.TestPlatform.Extensions.BlameDataCollector/BlameCollector.cs @@ -91,6 +91,7 @@ public BlameCollector() /// /// Filehelper instance. /// + /// Process helper instance. internal BlameCollector( IBlameReaderWriter blameReaderWriter, IProcessDumpUtility processDumpUtility, diff --git a/src/Microsoft.TestPlatform.Extensions.BlameDataCollector/Interfaces/IProcessDumpUtility.cs b/src/Microsoft.TestPlatform.Extensions.BlameDataCollector/Interfaces/IProcessDumpUtility.cs index a5a559197d..121fc0ffee 100644 --- a/src/Microsoft.TestPlatform.Extensions.BlameDataCollector/Interfaces/IProcessDumpUtility.cs +++ b/src/Microsoft.TestPlatform.Extensions.BlameDataCollector/Interfaces/IProcessDumpUtility.cs @@ -36,6 +36,7 @@ public interface IProcessDumpUtility /// /// Collect the dump on process exit even if there is no exception /// + /// Action to log a warning. void StartTriggerBasedProcessDump(int processId, string testResultsDirectory, bool isFullDump, string targetFramework, bool collectAlways, Action logWarning); /// diff --git a/src/Microsoft.TestPlatform.Extensions.TrxLogger/ObjectModel/TestResult.cs b/src/Microsoft.TestPlatform.Extensions.TrxLogger/ObjectModel/TestResult.cs index d2ca29bae7..07c66ea347 100644 --- a/src/Microsoft.TestPlatform.Extensions.TrxLogger/ObjectModel/TestResult.cs +++ b/src/Microsoft.TestPlatform.Extensions.TrxLogger/ObjectModel/TestResult.cs @@ -212,12 +212,18 @@ internal class TestResult : ITestResult, IXmlTestStore /// /// The run id. /// - /// - /// The test. + /// Execution id. + /// Parent execution id. + /// Result name. + /// + /// The test id. /// /// /// The outcome. /// + /// + /// + /// public TestResult( Guid runId, Guid testId, diff --git a/src/Microsoft.TestPlatform.Extensions.TrxLogger/TrxLogger.cs b/src/Microsoft.TestPlatform.Extensions.TrxLogger/TrxLogger.cs index 2b37511660..7809c0acd1 100644 --- a/src/Microsoft.TestPlatform.Extensions.TrxLogger/TrxLogger.cs +++ b/src/Microsoft.TestPlatform.Extensions.TrxLogger/TrxLogger.cs @@ -591,7 +591,7 @@ private void CreateTestRun() /// /// /// - /// + /// /// Trx test element private ITestElement GetOrCreateTestElement(Guid executionId, Guid parentExecutionId, TestType testType, ITestElement? parentTestElement, ObjectModel.TestResult rockSteadyTestResult) { diff --git a/src/Microsoft.TestPlatform.Extensions.TrxLogger/Utility/Converter.cs b/src/Microsoft.TestPlatform.Extensions.TrxLogger/Utility/Converter.cs index 3a8a7b69c1..5967dbb202 100644 --- a/src/Microsoft.TestPlatform.Extensions.TrxLogger/Utility/Converter.cs +++ b/src/Microsoft.TestPlatform.Extensions.TrxLogger/Utility/Converter.cs @@ -43,7 +43,7 @@ public Converter(IFileHelper fileHelper, TrxFileHelper trxFileHelper) /// /// /// - /// + /// /// /// /// Trx test element diff --git a/src/Microsoft.TestPlatform.ObjectModel/Adapter/Interfaces/ITestExecutor.cs b/src/Microsoft.TestPlatform.ObjectModel/Adapter/Interfaces/ITestExecutor.cs index 2b043cd81f..785a65ac16 100644 --- a/src/Microsoft.TestPlatform.ObjectModel/Adapter/Interfaces/ITestExecutor.cs +++ b/src/Microsoft.TestPlatform.ObjectModel/Adapter/Interfaces/ITestExecutor.cs @@ -19,7 +19,7 @@ public interface ITestExecutor /// /// Tests to be run. /// Context to use when executing the tests. - /// Handle to the framework to record results and to do framework operations. + /// Handle to the framework to record results and to do framework operations. void RunTests(IEnumerable? tests, IRunContext? runContext, IFrameworkHandle? frameworkHandle); /// @@ -27,7 +27,7 @@ public interface ITestExecutor /// /// Path to test container files to look for tests in. /// Context to use when executing the tests. - /// Handle to the framework to record results and to do framework operations. + /// Handle to the framework to record results and to do framework operations. void RunTests(IEnumerable? sources, IRunContext? runContext, IFrameworkHandle? frameworkHandle); /// diff --git a/src/Microsoft.TestPlatform.ObjectModel/Client/Events/TestRunCompleteEventArgs.cs b/src/Microsoft.TestPlatform.ObjectModel/Client/Events/TestRunCompleteEventArgs.cs index 8ae21a7809..58a6b412b2 100644 --- a/src/Microsoft.TestPlatform.ObjectModel/Client/Events/TestRunCompleteEventArgs.cs +++ b/src/Microsoft.TestPlatform.ObjectModel/Client/Events/TestRunCompleteEventArgs.cs @@ -58,7 +58,7 @@ public TestRunCompleteEventArgs( /// Specifies whether the test run is aborted. /// Specifies the error encountered during the execution of the test run. /// Attachment sets associated with the run. - /// Invoked data collectors + /// Invoked data collectors /// Time elapsed in just running tests public TestRunCompleteEventArgs( ITestRunStatistics? stats, diff --git a/src/Microsoft.TestPlatform.ObjectModel/Client/FilterOptions.cs b/src/Microsoft.TestPlatform.ObjectModel/Client/FilterOptions.cs index 86c40e5b77..7c087014c9 100644 --- a/src/Microsoft.TestPlatform.ObjectModel/Client/FilterOptions.cs +++ b/src/Microsoft.TestPlatform.ObjectModel/Client/FilterOptions.cs @@ -20,7 +20,7 @@ public class FilterOptions public string? FilterRegEx { get; set; } /// - /// Gets or sets the optional regular expression replacement string. When this property is set, + /// Gets or sets the optional regular expression replacement string. When this property is set, /// will be called upon property value instead of before matching. /// [DataMember] diff --git a/src/Microsoft.TestPlatform.ObjectModel/Client/Interfaces/IInternalTestRunEventsHandler.cs b/src/Microsoft.TestPlatform.ObjectModel/Client/Interfaces/IInternalTestRunEventsHandler.cs index b35e59c2cc..58023601b0 100644 --- a/src/Microsoft.TestPlatform.ObjectModel/Client/Interfaces/IInternalTestRunEventsHandler.cs +++ b/src/Microsoft.TestPlatform.ObjectModel/Client/Interfaces/IInternalTestRunEventsHandler.cs @@ -39,7 +39,7 @@ public interface IInternalTestRunEventsHandler : ITestMessageEventHandler /// /// Attach debugger to an already running process. /// - /// Process ID of the process to which the debugger should be attached. + /// Process ID of the process and tfm to which the debugger should be attached. /// if the debugger was successfully attached to the requested process, otherwise. bool AttachDebuggerToProcess(AttachDebuggerInfo attachDebuggerInfo); } diff --git a/src/Microsoft.TestPlatform.ObjectModel/Client/Interfaces/ITestPlatform.cs b/src/Microsoft.TestPlatform.ObjectModel/Client/Interfaces/ITestPlatform.cs index edebdbce74..789a84d3f3 100644 --- a/src/Microsoft.TestPlatform.ObjectModel/Client/Interfaces/ITestPlatform.cs +++ b/src/Microsoft.TestPlatform.ObjectModel/Client/Interfaces/ITestPlatform.cs @@ -38,6 +38,8 @@ void UpdateExtensions( /// Providing common services and data for discovery. /// Specifies the discovery parameters. /// Test platform options. + /// Details of each dll (source). + /// Logger to use for warnings. /// /// A DiscoveryRequest object. IDiscoveryRequest CreateDiscoveryRequest( @@ -54,6 +56,8 @@ IDiscoveryRequest CreateDiscoveryRequest( /// Providing common services and data for execution. /// Specifies the test run criteria. /// Test platform options. + /// Details of each dll (source). + /// Logger to use for warnings. /// /// A RunRequest object. ITestRunRequest CreateTestRunRequest( @@ -72,6 +76,8 @@ ITestRunRequest CreateTestRunRequest( /// /// Specifies the start test session criteria. /// Events handler for handling session events. + /// Details of each dll (source). + /// Logger to use for warnings. /// /// True if the operation succeeded, false otherwise. bool StartTestSession( diff --git a/src/Microsoft.TestPlatform.ObjectModel/Client/Interfaces/ITestRunAttachmentsProcessingEventsHandler.cs b/src/Microsoft.TestPlatform.ObjectModel/Client/Interfaces/ITestRunAttachmentsProcessingEventsHandler.cs index c586949c2d..be41a6689c 100644 --- a/src/Microsoft.TestPlatform.ObjectModel/Client/Interfaces/ITestRunAttachmentsProcessingEventsHandler.cs +++ b/src/Microsoft.TestPlatform.ObjectModel/Client/Interfaces/ITestRunAttachmentsProcessingEventsHandler.cs @@ -14,7 +14,7 @@ public interface ITestRunAttachmentsProcessingEventsHandler : ITestMessageEventH /// Dispatch TestRunAttachmentsProcessingComplete event to listeners. /// /// AttachmentsProcessing Complete event args. - /// Last set of processed attachment sets. + /// Last set of processed attachment sets. void HandleTestRunAttachmentsProcessingComplete(TestRunAttachmentsProcessingCompleteEventArgs attachmentsProcessingCompleteEventArgs, IEnumerable? lastChunk); /// diff --git a/src/Microsoft.TestPlatform.ObjectModel/DataCollector/DataCollectionRunSettings.cs b/src/Microsoft.TestPlatform.ObjectModel/DataCollector/DataCollectionRunSettings.cs index 42f179557a..ef4d693cac 100644 --- a/src/Microsoft.TestPlatform.ObjectModel/DataCollector/DataCollectionRunSettings.cs +++ b/src/Microsoft.TestPlatform.ObjectModel/DataCollector/DataCollectionRunSettings.cs @@ -183,8 +183,9 @@ public static DataCollectionRunSettings CreateDataCollectionRunSettings( /// /// The reader. /// + /// Name of the datacollector. /// - /// The . + /// The . /// /// /// diff --git a/src/Microsoft.TestPlatform.ObjectModel/DataCollector/DataCollectorSettings.cs b/src/Microsoft.TestPlatform.ObjectModel/DataCollector/DataCollectorSettings.cs index dbc436744d..bedb92e5ba 100644 --- a/src/Microsoft.TestPlatform.ObjectModel/DataCollector/DataCollectorSettings.cs +++ b/src/Microsoft.TestPlatform.ObjectModel/DataCollector/DataCollectorSettings.cs @@ -137,7 +137,7 @@ public XmlElement ToXml(string dataCollectorName) /// The reader. /// /// - /// The . + /// The . /// /// /// Settings exception diff --git a/src/Microsoft.TestPlatform.ObjectModel/DataCollector/Events/SessionEvents.cs b/src/Microsoft.TestPlatform.ObjectModel/DataCollector/Events/SessionEvents.cs index bd5cd80fb5..773f3bd6b4 100644 --- a/src/Microsoft.TestPlatform.ObjectModel/DataCollector/Events/SessionEvents.cs +++ b/src/Microsoft.TestPlatform.ObjectModel/DataCollector/Events/SessionEvents.cs @@ -49,6 +49,7 @@ public SessionStartEventArgs(IDictionary properties) /// /// Context information for the session /// + /// Properties for the session. public SessionStartEventArgs(DataCollectionContext context, IDictionary properties) : base(context) { diff --git a/src/Microsoft.TestPlatform.ObjectModel/DefaultExecutorUriAttribute.cs b/src/Microsoft.TestPlatform.ObjectModel/DefaultExecutorUriAttribute.cs index 754881f19a..2e7fd6c0cc 100644 --- a/src/Microsoft.TestPlatform.ObjectModel/DefaultExecutorUriAttribute.cs +++ b/src/Microsoft.TestPlatform.ObjectModel/DefaultExecutorUriAttribute.cs @@ -14,7 +14,7 @@ public sealed class DefaultExecutorUriAttribute : Attribute /// /// Initializes with the Uri of the executor. /// - /// The Uri of the executor + /// The Uri of the executor public DefaultExecutorUriAttribute(string executorUri) { ValidateArg.NotNullOrWhiteSpace(executorUri, nameof(executorUri)); diff --git a/src/Microsoft.TestPlatform.ObjectModel/DirectoryBasedTestDiscovererAttribute.cs b/src/Microsoft.TestPlatform.ObjectModel/DirectoryBasedTestDiscovererAttribute.cs index 8ebfc8c0be..0114d5afe7 100644 --- a/src/Microsoft.TestPlatform.ObjectModel/DirectoryBasedTestDiscovererAttribute.cs +++ b/src/Microsoft.TestPlatform.ObjectModel/DirectoryBasedTestDiscovererAttribute.cs @@ -6,7 +6,7 @@ namespace Microsoft.VisualStudio.TestPlatform.ObjectModel; /// -/// This attribute is applied to s. It indicates the test discoverer discovers tests +/// This attribute is applied to s. It indicates the test discoverer discovers tests /// present inside a directory (as opposed to the which indicates that the /// discoverer discovers tests present in files with a specified extension). /// diff --git a/src/Microsoft.TestPlatform.ObjectModel/InvokedDataCollector.cs b/src/Microsoft.TestPlatform.ObjectModel/InvokedDataCollector.cs index 89d8ef2b61..9422e8e491 100644 --- a/src/Microsoft.TestPlatform.ObjectModel/InvokedDataCollector.cs +++ b/src/Microsoft.TestPlatform.ObjectModel/InvokedDataCollector.cs @@ -12,6 +12,7 @@ public sealed class InvokedDataCollector : IEquatable /// Initialize an InvokedDataCollector /// /// Data collector Uri + /// Friendly name of the datacollector. /// Data collector assembly qualified name /// Data collector file path /// True if data collector registers an attachment processor diff --git a/src/Microsoft.TestPlatform.ObjectModel/Nuget.Frameworks/NuGetFrameworkUtility.cs b/src/Microsoft.TestPlatform.ObjectModel/Nuget.Frameworks/NuGetFrameworkUtility.cs index b5367a43b5..b01fe1ab34 100644 --- a/src/Microsoft.TestPlatform.ObjectModel/Nuget.Frameworks/NuGetFrameworkUtility.cs +++ b/src/Microsoft.TestPlatform.ObjectModel/Nuget.Frameworks/NuGetFrameworkUtility.cs @@ -27,6 +27,7 @@ internal static class NuGetFrameworkUtility /// project target framework /// retrieves the framework from the group /// framework mappings + /// compatibility provider public static T? GetNearest(IEnumerable items, NuGetFramework framework, IFrameworkNameProvider frameworkMappings, @@ -66,6 +67,8 @@ internal static class NuGetFrameworkUtility /// /// framework specific groups or items /// project target framework + /// framework mappings + /// compatibility provider public static T? GetNearest(IEnumerable items, NuGetFramework framework, IFrameworkNameProvider frameworkMappings, diff --git a/src/Microsoft.TestPlatform.ObjectModel/RegistryFreeActivationContext.cs b/src/Microsoft.TestPlatform.ObjectModel/RegistryFreeActivationContext.cs index 6ab0cd3b74..2558cb3d39 100644 --- a/src/Microsoft.TestPlatform.ObjectModel/RegistryFreeActivationContext.cs +++ b/src/Microsoft.TestPlatform.ObjectModel/RegistryFreeActivationContext.cs @@ -113,6 +113,7 @@ private void DeactivateContext() } } +/// /// ActivationContextNativeMethods class needed for registry-free context /// internal static class ActivationContextNativeMethods diff --git a/src/Microsoft.TestPlatform.ObjectModel/Utilities/FilterHelper.cs b/src/Microsoft.TestPlatform.ObjectModel/Utilities/FilterHelper.cs index eda82c44ca..f2f6239863 100644 --- a/src/Microsoft.TestPlatform.ObjectModel/Utilities/FilterHelper.cs +++ b/src/Microsoft.TestPlatform.ObjectModel/Utilities/FilterHelper.cs @@ -15,7 +15,7 @@ public static class FilterHelper private static readonly HashSet SpecialCharactersSet = new(SpecialCharacters); /// - /// Escapes a set of special characters for filter (%, (, ), &, |, =, !, ~) by replacing them with their escape sequences. + /// Escapes a set of special characters for filter (%, (, ), &, |, =, !, ~) by replacing them with their escape sequences. /// /// The input string that contains the text to convert. /// A string of characters with special characters converted to their escaped form. diff --git a/src/Microsoft.TestPlatform.ObjectModel/Utilities/Sha1Helper.cs b/src/Microsoft.TestPlatform.ObjectModel/Utilities/Sha1Helper.cs index f424fbba41..7b2a249fa3 100644 --- a/src/Microsoft.TestPlatform.ObjectModel/Utilities/Sha1Helper.cs +++ b/src/Microsoft.TestPlatform.ObjectModel/Utilities/Sha1Helper.cs @@ -44,17 +44,17 @@ internal class Sha1Implementation /// /// A sequence of logical functions to be used in SHA-1. - /// Each f(t), 0 <= t <= 79, operates on three 32-bit words B, C, D and produces a 32-bit word as output. + /// Each f(t), 0 <= t <= 79, operates on three 32-bit words B, C, D and produces a 32-bit word as output. /// - /// Function index. 0 <= t <= 79 + /// Function index. 0 <= t <= 79 /// Word B /// Word C /// Word D /// - /// f(t;B,C,D) = (B AND C) OR ((NOT B) AND D) ( 0 <= t <= 19) - /// f(t;B,C,D) = B XOR C XOR D (20 <= t <= 39) - /// f(t;B,C,D) = (B AND C) OR (B AND D) OR (C AND D) (40 <= t <= 59) - /// f(t;B,C,D) = B XOR C XOR D (60 <= t <= 79) + /// f(t;B,C,D) = (B AND C) OR ((NOT B) AND D) ( 0 <= t <= 19) + /// f(t;B,C,D) = B XOR C XOR D (20 <= t <= 39) + /// f(t;B,C,D) = (B AND C) OR (B AND D) OR (C AND D) (40 <= t <= 59) + /// f(t;B,C,D) = B XOR C XOR D (60 <= t <= 79) /// private static uint F(int t, uint b, uint c, uint d) { @@ -73,10 +73,10 @@ private static uint F(int t, uint b, uint c, uint d) /// /// Word index. /// - /// K(t) = 0x5A827999 ( 0 <= t <= 19) - /// K(t) = 0x6ED9EBA1 (20 <= t <= 39) - /// K(t) = 0x8F1BBCDC (40 <= t <= 59) - /// K(t) = 0xCA62C1D6 (60 <= t <= 79) + /// K(t) = 0x5A827999 ( 0 <= t <= 19) + /// K(t) = 0x6ED9EBA1 (20 <= t <= 39) + /// K(t) = 0x8F1BBCDC (40 <= t <= 59) + /// K(t) = 0xCA62C1D6 (60 <= t <= 79) /// private static uint K(int t) { @@ -95,8 +95,8 @@ private static uint K(int t) /// The circular left shift operation. /// /// An uint word. - /// 0 <= n < 32 - /// S^n(X) = (X << n) OR (X >> 32-n) + /// 0 <= n < 32 + /// S^n(X) = (X << n) OR (X >> 32-n) private static uint S(uint x, byte n) { return n > 32 ? throw new ArgumentOutOfRangeException(nameof(n)) : (x << n) | (x >> (32 - n)); diff --git a/src/Microsoft.TestPlatform.ObjectModel/Utilities/XmlReaderUtilities.cs b/src/Microsoft.TestPlatform.ObjectModel/Utilities/XmlReaderUtilities.cs index 833143fe88..02e723b398 100644 --- a/src/Microsoft.TestPlatform.ObjectModel/Utilities/XmlReaderUtilities.cs +++ b/src/Microsoft.TestPlatform.ObjectModel/Utilities/XmlReaderUtilities.cs @@ -42,7 +42,6 @@ public static void SkipToNextElement(this XmlReader reader) /// /// Reads to the root node of the run settings and verifies that it is a "RunSettings" node. /// - /// Path to the file. /// XmlReader for the file. public static void ReadToRootNode(XmlReader reader) { diff --git a/src/Microsoft.TestPlatform.PlatformAbstractions/Interfaces/System/IProcessHelper.cs b/src/Microsoft.TestPlatform.PlatformAbstractions/Interfaces/System/IProcessHelper.cs index 6d468d0dd2..0824fd314c 100644 --- a/src/Microsoft.TestPlatform.PlatformAbstractions/Interfaces/System/IProcessHelper.cs +++ b/src/Microsoft.TestPlatform.PlatformAbstractions/Interfaces/System/IProcessHelper.cs @@ -17,10 +17,10 @@ public interface IProcessHelper /// The full file name of the process. /// The command-line arguments. /// The working directory for this process. - /// Environment variables to set while bootstrapping the process. + /// Environment variables to set while bootstrapping the process. /// Call back for to read error stream data /// Call back for on process exit - /// Call back for on process output + /// Call back for on process output /// The process created. object LaunchProcess(string processPath, string? arguments, string? workingDirectory, IDictionary? envVariables, Action? errorCallback, Action? exitCallBack, Action? outputCallBack); diff --git a/src/Microsoft.TestPlatform.PlatformAbstractions/Interfaces/System/ThreadApartmentStateNotSupportedException.cs b/src/Microsoft.TestPlatform.PlatformAbstractions/Interfaces/System/ThreadApartmentStateNotSupportedException.cs index eee94a5adf..5fca45c871 100644 --- a/src/Microsoft.TestPlatform.PlatformAbstractions/Interfaces/System/ThreadApartmentStateNotSupportedException.cs +++ b/src/Microsoft.TestPlatform.PlatformAbstractions/Interfaces/System/ThreadApartmentStateNotSupportedException.cs @@ -14,7 +14,6 @@ public class ThreadApartmentStateNotSupportedException : Exception /// Initializes a new instance of the class. /// Initializes with the message. /// - /// Message for the exception. public ThreadApartmentStateNotSupportedException() { } diff --git a/src/Microsoft.TestPlatform.PlatformAbstractions/netcore/Runtime/PlatformAssemblyResolver.cs b/src/Microsoft.TestPlatform.PlatformAbstractions/netcore/Runtime/PlatformAssemblyResolver.cs index ff39358c97..914e93f998 100644 --- a/src/Microsoft.TestPlatform.PlatformAbstractions/netcore/Runtime/PlatformAssemblyResolver.cs +++ b/src/Microsoft.TestPlatform.PlatformAbstractions/netcore/Runtime/PlatformAssemblyResolver.cs @@ -22,7 +22,6 @@ public class PlatformAssemblyResolver : IAssemblyResolver /// /// Initializes a new instance of the class. /// - /// The search directories. public PlatformAssemblyResolver() { AssemblyLoadContext.Default.Resolving += AssemblyResolverEvent; diff --git a/src/Microsoft.TestPlatform.TestHostProvider/Hosting/DefaultTestHostManager.cs b/src/Microsoft.TestPlatform.TestHostProvider/Hosting/DefaultTestHostManager.cs index 9d5fd5e4ef..21b343dad7 100644 --- a/src/Microsoft.TestPlatform.TestHostProvider/Hosting/DefaultTestHostManager.cs +++ b/src/Microsoft.TestPlatform.TestHostProvider/Hosting/DefaultTestHostManager.cs @@ -89,6 +89,7 @@ public DefaultTestHostManager() /// Process helper instance. /// File helper instance. /// Instance of platform environment. + /// The environment helper. /// Instance of dotnet host helper. internal DefaultTestHostManager( IProcessHelper processHelper, diff --git a/src/Microsoft.TestPlatform.Utilities/InferRunSettingsHelper.cs b/src/Microsoft.TestPlatform.Utilities/InferRunSettingsHelper.cs index 8d28e6c5dc..86a694fa1a 100644 --- a/src/Microsoft.TestPlatform.Utilities/InferRunSettingsHelper.cs +++ b/src/Microsoft.TestPlatform.Utilities/InferRunSettingsHelper.cs @@ -402,7 +402,7 @@ public static bool TryGetLegacySettingElements(string runsettingsXml, out Dictio /// /// Returns a dictionary of environment variables given in run settings /// - /// The run settings xml string + /// The run settings xml string /// Environment Variables Dictionary public static Dictionary? GetEnvironmentVariables(string? runSettings) { diff --git a/src/Microsoft.TestPlatform.Utilities/ParallelRunSettingsUtilities.cs b/src/Microsoft.TestPlatform.Utilities/ParallelRunSettingsUtilities.cs index 6e1a602818..1eca08118f 100644 --- a/src/Microsoft.TestPlatform.Utilities/ParallelRunSettingsUtilities.cs +++ b/src/Microsoft.TestPlatform.Utilities/ParallelRunSettingsUtilities.cs @@ -29,7 +29,7 @@ public static class ParallelRunSettingsUtilities /// /// This will update the RunSetting with MaxCpuCount 0 if RunSetting doesn't configured with this setting. /// - /// RunSetting file. + /// XPATH navigator. public static void UpdateRunSettingsWithParallelSettingIfNotConfigured(XPathNavigator navigator) { var node = navigator.SelectSingleNode(XpathOfMaxCpuCount); diff --git a/src/testhost.x86/AppDomainEngineInvoker.cs b/src/testhost.x86/AppDomainEngineInvoker.cs index 344790949b..f26ac8557b 100644 --- a/src/testhost.x86/AppDomainEngineInvoker.cs +++ b/src/testhost.x86/AppDomainEngineInvoker.cs @@ -93,8 +93,7 @@ private AppDomain CreateNewAppDomain(string testSourcePath) /// /// Create the Engine Invoker in new AppDomain based on test source path /// - /// Test Source to run/discover tests for - /// Merged config file if there is any merging of test config and test host config + /// The appdomain in which the invoker should be created. /// private static IEngineInvoker CreateInvokerInAppDomain(AppDomain appDomain) { diff --git a/src/vstest.console/Processors/EnableBlameArgumentProcessor.cs b/src/vstest.console/Processors/EnableBlameArgumentProcessor.cs index 139eb92e86..6afdcd808e 100644 --- a/src/vstest.console/Processors/EnableBlameArgumentProcessor.cs +++ b/src/vstest.console/Processors/EnableBlameArgumentProcessor.cs @@ -176,8 +176,6 @@ public void Initialize(string? argument) /// /// Initialize blame. /// - /// Enable dump. - /// Blame parameters. private void InitializeBlame(bool enableCrashDump, bool enableHangDump, bool monitorPostMortemDebugger, Dictionary? collectDumpParameters) { // Add Blame Logger @@ -333,9 +331,6 @@ private static void AddMonitorPostMortemDebuggerNode(Dictionary /// /// Adds node in outer node. /// - /// Parameters. - /// Xml document. - /// Outer node. private static void AddNode(Dictionary? parameters, XmlDocument xmlDocument, XmlElement outernode, string nodeName) { var dumpNode = xmlDocument.CreateElement(nodeName); diff --git a/src/vstest.console/Processors/EnableCodeCoverageArgumentProcessor.cs b/src/vstest.console/Processors/EnableCodeCoverageArgumentProcessor.cs index 21b04d3976..db2ce05372 100644 --- a/src/vstest.console/Processors/EnableCodeCoverageArgumentProcessor.cs +++ b/src/vstest.console/Processors/EnableCodeCoverageArgumentProcessor.cs @@ -192,7 +192,6 @@ public ArgumentProcessorResult Execute() /// /// Updates with code coverage settings if not configured. /// - /// The run settings document. private void UpdateWithCodeCoverageSettingsIfNotConfigured() { var runsettingsXml = _runSettingsManager.ActiveRunSettings?.SettingsXml; diff --git a/src/vstest.console/Processors/EnableDiagArgumentProcessor.cs b/src/vstest.console/Processors/EnableDiagArgumentProcessor.cs index c5cee215fe..d3bc5e6a6b 100644 --- a/src/vstest.console/Processors/EnableDiagArgumentProcessor.cs +++ b/src/vstest.console/Processors/EnableDiagArgumentProcessor.cs @@ -101,6 +101,7 @@ internal class EnableDiagArgumentExecutor : IArgumentExecutor /// Default constructor. /// /// The file helper. + /// Process helper public EnableDiagArgumentExecutor(IFileHelper fileHelper, IProcessHelper processHelper) { _fileHelper = fileHelper; diff --git a/src/vstest.console/Processors/ListFullyQualifiedTestsArgumentProcessor.cs b/src/vstest.console/Processors/ListFullyQualifiedTestsArgumentProcessor.cs index f6580388e6..8bd9581d09 100644 --- a/src/vstest.console/Processors/ListFullyQualifiedTestsArgumentProcessor.cs +++ b/src/vstest.console/Processors/ListFullyQualifiedTestsArgumentProcessor.cs @@ -107,6 +107,8 @@ internal class ListFullyQualifiedTestsArgumentExecutor : IArgumentExecutor /// /// The options. /// + /// Runsettings provider. + /// Test request manager. public ListFullyQualifiedTestsArgumentExecutor( CommandLineOptions options, IRunSettingsProvider runSettingsProvider, @@ -121,6 +123,9 @@ public ListFullyQualifiedTestsArgumentExecutor( /// /// The options. /// + /// Runsettings provider. + /// Test request manager. + /// Output such as console. internal ListFullyQualifiedTestsArgumentExecutor( CommandLineOptions options, IRunSettingsProvider runSettingsProvider, diff --git a/src/vstest.console/Processors/ListTestsArgumentProcessor.cs b/src/vstest.console/Processors/ListTestsArgumentProcessor.cs index a8e3a84d7c..18dcba4914 100644 --- a/src/vstest.console/Processors/ListTestsArgumentProcessor.cs +++ b/src/vstest.console/Processors/ListTestsArgumentProcessor.cs @@ -111,6 +111,8 @@ internal class ListTestsArgumentExecutor : IArgumentExecutor /// /// The options. /// + /// Runsettings provider. + /// Test request manager. public ListTestsArgumentExecutor( CommandLineOptions options, IRunSettingsProvider runSettingsProvider, @@ -125,6 +127,9 @@ public ListTestsArgumentExecutor( /// /// The options. /// + /// Run setting provider. + /// Output such as console. + /// Test request manager internal ListTestsArgumentExecutor( CommandLineOptions options, IRunSettingsProvider runSettingsProvider, diff --git a/src/vstest.console/Processors/ResultsDirectoryArgumentProcessor.cs b/src/vstest.console/Processors/ResultsDirectoryArgumentProcessor.cs index 3855941ce0..b7e03835fd 100644 --- a/src/vstest.console/Processors/ResultsDirectoryArgumentProcessor.cs +++ b/src/vstest.console/Processors/ResultsDirectoryArgumentProcessor.cs @@ -83,7 +83,7 @@ internal class ResultsDirectoryArgumentExecutor : IArgumentExecutor /// Default constructor. /// /// The options. - /// The test platform + /// Runsettings manager. public ResultsDirectoryArgumentExecutor(CommandLineOptions options, IRunSettingsProvider runSettingsManager) { ValidateArg.NotNull(options, nameof(options)); diff --git a/src/vstest.console/Processors/TestAdapterLoadingStrategyArgumentProcessor.cs b/src/vstest.console/Processors/TestAdapterLoadingStrategyArgumentProcessor.cs index 5fcb2d2b99..91ee48d550 100644 --- a/src/vstest.console/Processors/TestAdapterLoadingStrategyArgumentProcessor.cs +++ b/src/vstest.console/Processors/TestAdapterLoadingStrategyArgumentProcessor.cs @@ -100,7 +100,9 @@ internal class TestAdapterLoadingStrategyArgumentExecutor : IArgumentExecutor /// Default constructor. /// /// The options. - /// The test platform + /// Run setting manager. + /// Output such as console. + /// File helper public TestAdapterLoadingStrategyArgumentExecutor(CommandLineOptions options, IRunSettingsProvider runSettingsManager, IOutput output, IFileHelper fileHelper) { _commandLineOptions = options ?? throw new ArgumentNullException(nameof(options)); diff --git a/src/vstest.console/Processors/TestAdapterPathArgumentProcessor.cs b/src/vstest.console/Processors/TestAdapterPathArgumentProcessor.cs index 701d1b37ce..8ae3214634 100644 --- a/src/vstest.console/Processors/TestAdapterPathArgumentProcessor.cs +++ b/src/vstest.console/Processors/TestAdapterPathArgumentProcessor.cs @@ -104,7 +104,9 @@ internal class TestAdapterPathArgumentExecutor : IArgumentExecutor /// Default constructor. /// /// The options. - /// The test platform + /// Run setting manager. + /// Output such as console. + /// File helper public TestAdapterPathArgumentExecutor(CommandLineOptions options, IRunSettingsProvider runSettingsManager, IOutput output, IFileHelper fileHelper) { _commandLineOptions = options ?? throw new ArgumentNullException(nameof(options)); diff --git a/src/vstest.console/Processors/Utilities/ArgumentProcessorFactory.cs b/src/vstest.console/Processors/Utilities/ArgumentProcessorFactory.cs index 321df61125..81f6123af8 100644 --- a/src/vstest.console/Processors/Utilities/ArgumentProcessorFactory.cs +++ b/src/vstest.console/Processors/Utilities/ArgumentProcessorFactory.cs @@ -23,14 +23,12 @@ internal class ArgumentProcessorFactory private Dictionary? _commandToProcessorMap; private Dictionary? _specialCommandToProcessorMap; + /// /// Initializes the argument processor factory. /// /// /// The argument Processors. /// - /// - /// The feature flag support. - /// /// /// This is not public because the static Create method should be used to access the instance. /// @@ -298,7 +296,7 @@ public static IArgumentProcessor WrapLazyProcessorToInitializeOnInstantiation(IA /// Decorates a lazy argument processor so that the real processor is initialized when the lazy value is obtained. /// /// The lazy processor. - /// The argument with which the real processor should be initialized. + /// The argument with which the real processor should be initialized. /// The decorated lazy processor. private static IArgumentProcessor WrapLazyProcessorToInitializeOnInstantiation( IArgumentProcessor processor, diff --git a/src/vstest.console/TestPlatformHelpers/TestRequestManager.cs b/src/vstest.console/TestPlatformHelpers/TestRequestManager.cs index 4a8134cd03..d95891c425 100644 --- a/src/vstest.console/TestPlatformHelpers/TestRequestManager.cs +++ b/src/vstest.console/TestPlatformHelpers/TestRequestManager.cs @@ -1278,7 +1278,6 @@ private void RunTests( /// This method either looks at runsettings directly when running as a server (DesignMode / IDE / via VSTestConsoleWrapper, or how you wanna call it) /// or uses the pre-parsed runsettings when in console mode. /// - /// /// private bool IsFrameworkSetByRunSettings( XPathNavigator navigator, @@ -1314,7 +1313,6 @@ private bool IsFrameworkSetByRunSettings( /// This method either looks at runsettings directly when running as a server (DesignMode / IDE / via VSTestConsoleWrapper, or how you wanna call it) /// or uses the pre-parsed runsettings when in console mode. /// - /// /// private bool IsPlatformSetByRunSettings( XPathNavigator navigator, out Architecture chosenPlatform) diff --git a/test/Microsoft.TestPlatform.Acceptance.IntegrationTests/Extension/NetCoreRunnerAttribute.cs b/test/Microsoft.TestPlatform.Acceptance.IntegrationTests/Extension/NetCoreRunnerAttribute.cs index 7af2fedb77..a1362f1c56 100644 --- a/test/Microsoft.TestPlatform.Acceptance.IntegrationTests/Extension/NetCoreRunnerAttribute.cs +++ b/test/Microsoft.TestPlatform.Acceptance.IntegrationTests/Extension/NetCoreRunnerAttribute.cs @@ -25,7 +25,7 @@ public class NetCoreRunnerAttribute : Attribute, ITestDataSource private readonly string _targetFrameworks; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// /// To run tests with desktop runner(vstest.console.exe), use AcceptanceTestBase.Net462TargetFramework or alike values. public NetCoreRunnerAttribute(string targetFrameworks = AcceptanceTestBase.NETFX462_NET50) diff --git a/test/Microsoft.TestPlatform.Acceptance.IntegrationTests/Extension/RunnnerInfo.cs b/test/Microsoft.TestPlatform.Acceptance.IntegrationTests/Extension/RunnnerInfo.cs index b052591c78..c25929c04b 100644 --- a/test/Microsoft.TestPlatform.Acceptance.IntegrationTests/Extension/RunnnerInfo.cs +++ b/test/Microsoft.TestPlatform.Acceptance.IntegrationTests/Extension/RunnnerInfo.cs @@ -9,12 +9,6 @@ namespace Microsoft.TestPlatform.AcceptanceTests; -/// -/// -/// -/// -/// -/// Supported value = /InIsolation. [Serializable] // Type should be serializable to allow the tree-view behavior of test discovery in Test Explorer public class RunnerInfo { diff --git a/test/Microsoft.TestPlatform.Acceptance.IntegrationTests/Performance/PerfInstrumentation/PerfAnalyzer.cs b/test/Microsoft.TestPlatform.Acceptance.IntegrationTests/Performance/PerfInstrumentation/PerfAnalyzer.cs index ff51365afb..3e89d97d85 100644 --- a/test/Microsoft.TestPlatform.Acceptance.IntegrationTests/Performance/PerfInstrumentation/PerfAnalyzer.cs +++ b/test/Microsoft.TestPlatform.Acceptance.IntegrationTests/Performance/PerfInstrumentation/PerfAnalyzer.cs @@ -148,7 +148,7 @@ public double GetElapsedTimeByTaskName(string taskName) /// The task name. /// /// - /// The . + /// The . /// public IDictionary GetEventDataByTaskName(string taskName) { diff --git a/test/Microsoft.TestPlatform.Acceptance.IntegrationTests/Performance/TranslationLayer/TelemetryPerfTestBase.cs b/test/Microsoft.TestPlatform.Acceptance.IntegrationTests/Performance/TranslationLayer/TelemetryPerfTestBase.cs index d1a72e3716..cb4a59b220 100644 --- a/test/Microsoft.TestPlatform.Acceptance.IntegrationTests/Performance/TranslationLayer/TelemetryPerfTestBase.cs +++ b/test/Microsoft.TestPlatform.Acceptance.IntegrationTests/Performance/TranslationLayer/TelemetryPerfTestBase.cs @@ -34,8 +34,6 @@ public TelemetryPerfTestBase() /// /// Used for posting the telemetry to AppInsights /// - /// - /// public void PostTelemetry(IDictionary handlerMetrics, PerfAnalyzer perfAnalyzer, string projectName, [CallerMemberName] string? scenario = null) { var properties = new Dictionary @@ -114,8 +112,6 @@ private static string GetAdapterName(string projectName) /// /// Returns the full path to the test asset dll /// - /// Name of the directory of the test dll - /// Name of the test project without extension /// public string[] GetPerfAssetFullPath(string name, string framework = "net48") { diff --git a/test/Microsoft.TestPlatform.Acceptance.IntegrationTests/RunsettingsTests.cs b/test/Microsoft.TestPlatform.Acceptance.IntegrationTests/RunsettingsTests.cs index 9675f8766c..3546759ab5 100644 --- a/test/Microsoft.TestPlatform.Acceptance.IntegrationTests/RunsettingsTests.cs +++ b/test/Microsoft.TestPlatform.Acceptance.IntegrationTests/RunsettingsTests.cs @@ -94,9 +94,6 @@ public void CLIRunsettingsShouldWinBetweenCLISwitchesAndCLIRunsettings(RunnerInf /// /// Command line switches should have high precedence if runsetting file and command line switch specified /// - /// - /// - /// [TestMethod] [NetFullTargetFrameworkDataSource] [NetCoreTargetFrameworkDataSource] diff --git a/test/Microsoft.TestPlatform.Extensions.BlameDataCollector.UnitTests/BlameCollectorTests.cs b/test/Microsoft.TestPlatform.Extensions.BlameDataCollector.UnitTests/BlameCollectorTests.cs index e1f1970f0c..e2d3e41e48 100644 --- a/test/Microsoft.TestPlatform.Extensions.BlameDataCollector.UnitTests/BlameCollectorTests.cs +++ b/test/Microsoft.TestPlatform.Extensions.BlameDataCollector.UnitTests/BlameCollectorTests.cs @@ -761,6 +761,7 @@ internal class TestableBlameCollector : BlameCollector /// /// MockFileHelper instance. /// + /// Mockd process helper internal TestableBlameCollector(IBlameReaderWriter blameReaderWriter, IProcessDumpUtility processDumpUtility, IInactivityTimer? inactivityTimer, IFileHelper mockFileHelper, IProcessHelper mockProcessHelper) : base(blameReaderWriter, processDumpUtility, inactivityTimer, mockFileHelper, mockProcessHelper) diff --git a/test/Microsoft.TestPlatform.TestUtilities/IntegrationTestBase.cs b/test/Microsoft.TestPlatform.TestUtilities/IntegrationTestBase.cs index 123a0167a7..cdbe0a44d1 100644 --- a/test/Microsoft.TestPlatform.TestUtilities/IntegrationTestBase.cs +++ b/test/Microsoft.TestPlatform.TestUtilities/IntegrationTestBase.cs @@ -100,8 +100,9 @@ public void TempDirectoryCleanup() /// List of test assemblies. /// Path to test adapter. /// Text of run settings. - /// - /// + /// Framework to use. + /// If we should run in a separate process. + /// The directory where results are stored. /// Command line arguments string. public static string PrepareArguments(string[] testAssemblies, string? testAdapterPath, string? runSettings, string framework, string? inIsolation = "", string? resultsDirectory = null) @@ -169,8 +170,9 @@ public static string PrepareArguments(string[] testAssemblies, string? testAdapt /// Name of the test assembly. /// Path to test adapter. /// Text of run settings. - /// - /// + /// The framework to use. + /// If we should run in separate process. + /// The directory in which results will be stored. /// Command line arguments string. public static string PrepareArguments(string testAssembly, string? testAdapterPath, string? runSettings, string framework, string? inIsolation = "", string? resultsDirectory = null) @@ -181,6 +183,7 @@ public static string PrepareArguments(string testAssembly, string? testAdapterPa /// Invokes vstest.console with specified arguments. /// /// Arguments provided to vstest.console.exe + /// Environment variables to set to the started process. public void InvokeVsTest(string? arguments, Dictionary? environmentVariables = null) { var debugEnvironmentVariables = AddDebugEnvironmentVariables(environmentVariables); @@ -192,6 +195,7 @@ public void InvokeVsTest(string? arguments, Dictionary? environ /// Invokes our local copy of dotnet that is patched with artifacts from the build with specified arguments. /// /// Arguments provided to vstest.console.exe + /// Environment variables to set to the started process. public void InvokeDotnetTest(string arguments, Dictionary? environmentVariables = null) { var debugEnvironmentVariables = AddDebugEnvironmentVariables(environmentVariables); @@ -229,6 +233,7 @@ public void InvokeDotnetTest(string arguments, Dictionary? envi /// Path to test adapters. /// Dotnet Framework of test assembly. /// Run settings for execution. + /// Environment variables to set to the started process. public void InvokeVsTestForExecution(string testAssembly, string? testAdapterPath, string framework, @@ -275,6 +280,8 @@ public void InvokeVsTestForExecution(string testAssembly, /// A test assembly. /// Path to test adapters. /// Run settings for execution. + /// The target framework to use. + /// Environment variables to set to the started process. public void InvokeVsTestForDiscovery(string testAssembly, string testAdapterPath, string runSettings = "", string targetFramework = "", Dictionary? environmentVariables = null) { @@ -782,6 +789,7 @@ protected void ExecuteVsTestConsole(string? args, out string stdOut, out string /// /// /// + /// Environment variables to set to the started process. private static void ExecutePatchedDotnet(string command, string args, out string stdOut, out string stdError, out int exitCode, Dictionary? environmentVariables = null) { diff --git a/test/vstest.ProgrammerTests/Fakes/FakeTestBatchBuilder.cs b/test/vstest.ProgrammerTests/Fakes/FakeTestBatchBuilder.cs index 03b1a781d6..e3c40d179a 100644 --- a/test/vstest.ProgrammerTests/Fakes/FakeTestBatchBuilder.cs +++ b/test/vstest.ProgrammerTests/Fakes/FakeTestBatchBuilder.cs @@ -49,7 +49,7 @@ internal FakeTestBatchBuilder WithBatchSize(int batchSize) /// /// Sets the dll path (source) to be the provided value. /// - /// + /// /// internal FakeTestBatchBuilder WithDllPath(string path) { diff --git a/test/vstest.ProgrammerTests/Fakes/FakeTestDllBuilder.cs b/test/vstest.ProgrammerTests/Fakes/FakeTestDllBuilder.cs index 7b05974c8a..a8703938ec 100644 --- a/test/vstest.ProgrammerTests/Fakes/FakeTestDllBuilder.cs +++ b/test/vstest.ProgrammerTests/Fakes/FakeTestDllBuilder.cs @@ -46,7 +46,6 @@ internal FakeTestDllBuilder WithTestBatches(List> testBatches) /// /// Use this to get basic test batch, or use WithTestBatches together with TestBatchBuilder, to get a custom batch. /// - /// /// internal FakeTestDllBuilder WithTestCount(int totalCount, int? batchSize = null) { diff --git a/test/vstest.ProgrammerTests/Fakes/FakeTestHostResponsesBuilder.cs b/test/vstest.ProgrammerTests/Fakes/FakeTestHostResponsesBuilder.cs index a0f53bd5e9..bfb459fc84 100644 --- a/test/vstest.ProgrammerTests/Fakes/FakeTestHostResponsesBuilder.cs +++ b/test/vstest.ProgrammerTests/Fakes/FakeTestHostResponsesBuilder.cs @@ -41,7 +41,6 @@ internal FakeTestHostResponsesBuilder VersionCheck(FakeMessage message) /// For VersionCheck message it does the given before action and responds with the given FakeMessage and then does the given after action. /// Use FakeMessage.NoResponse to not respond. /// - /// /// internal FakeTestHostResponsesBuilder VersionCheck(FakeMessage message, Action? beforeAction = null, Action? afterAction = null) {