Document configuration public APIs (#2291)

Author: Evangelink

src/Platform/Microsoft.Testing.Platform/Configurations/ConfigurationExtensions.cs

@@ -5,22 +5,40 @@
 
 namespace Microsoft.Testing.Platform.Configurations;
 
+/// <summary>
+/// Provides extension methods for the IConfiguration interface.
+/// </summary>
 public static class ConfigurationExtensions
 {
+    /// <summary>
+    /// Gets the test result directory from the configuration.
+    /// </summary>
+    /// <param name="configuration">The configuration.</param>
+    /// <returns>The test result directory.</returns>
     public static string GetTestResultDirectory(this IConfiguration configuration)
     {
         string? resultDirectory = configuration[PlatformConfigurationConstants.PlatformResultDirectory];
         ArgumentGuard.IsNotNull(resultDirectory);
         return resultDirectory;
     }
 
+    /// <summary>
+    /// Gets the current working directory from the configuration.
+    /// </summary>
+    /// <param name="configuration">The configuration.</param>
+    /// <returns>The current working directory.</returns>
     public static string GetCurrentWorkingDirectory(this IConfiguration configuration)
     {
         string? workingDirectory = configuration[PlatformConfigurationConstants.PlatformCurrentWorkingDirectory];
         ArgumentGuard.IsNotNull(workingDirectory);
         return workingDirectory;
     }
 
+    /// <summary>
+    /// Gets the test host working directory from the configuration.
+    /// </summary>
+    /// <param name="configuration">The configuration.</param>
+    /// <returns>The test host working directory.</returns>
     public static string GetTestHostWorkingDirectory(this IConfiguration configuration)
     {
         string? workingDirectory = configuration[PlatformConfigurationConstants.PlatformTestHostWorkingDirectory];

src/Platform/Microsoft.Testing.Platform/Configurations/IConfiguration.cs

@@ -3,7 +3,15 @@
 
 namespace Microsoft.Testing.Platform.Configurations;
 
+/// <summary>
+/// Represents a configuration interface.
+/// </summary>
 public interface IConfiguration
 {
+    /// <summary>
+    /// Gets or sets the value associated with the specified key.
+    /// </summary>
+    /// <param name="key">The key of the value to get or set.</param>
+    /// <returns>The value associated with the specified key.</returns>
     string? this[string key] { get; }
 }