Add code docs

Author: ldstr

HttpClientFactory/CachedHttpClientFactory.cs

@@ -2,14 +2,26 @@
 
 namespace HttpClientFactory;
 
+/// <summary>
+/// Represents a cached implementation of the IHttpClientFactory interface.
+/// </summary>
 public class CachedHttpClientFactory : IHttpClientFactory
 {
     private readonly IHttpClientFactory _httpClientFactory;
     private readonly Dictionary<int, HttpClient> _cache = new();
 
+    /// <summary>
+    /// Initializes a new instance of the CachedHttpClientFactory class with the specified IHttpClientFactory implementation.
+    /// </summary>
+    /// <param name="httpClientFactory">An instance of IHttpClientFactory used to create HttpClient instances.</param>
     public CachedHttpClientFactory(IHttpClientFactory httpClientFactory) =>
         _httpClientFactory = httpClientFactory;
 
+    /// <summary>
+    /// Creates an HttpClient instance with the specified web proxy. If the same web proxy has been used before, a cached instance will be returned.
+    /// </summary>
+    /// <param name="webProxy">The web proxy to be used by the HttpClient.</param>
+    /// <returns>An instance of HttpClient configured with the provided web proxy.</returns>
     public HttpClient CreateClientWithProxy(IWebProxy webProxy)
     {
         var key = webProxy.GetHashCode();

HttpClientFactory/HClientFactory.cs

@@ -2,13 +2,25 @@
 
 namespace HttpClientFactory;
 
+/// <summary>
+/// Represents a concrete implementation of the IHttpClientFactory interface.
+/// </summary>
 public class HClientFactory : IHttpClientFactory
 {
     private readonly Func<HttpClientHandler> _makeHandler;
 
+    /// <summary>
+    /// Initializes a new instance of the HClientFactory class with the specified HttpClientHandler factory function.
+    /// </summary>
+    /// <param name="makeHandler">A factory function that creates instances of HttpClientHandler.</param>
     public HClientFactory(Func<HttpClientHandler> makeHandler) =>
         _makeHandler = makeHandler;
 
+    /// <summary>
+    /// Creates an HttpClient instance with the specified web proxy.
+    /// </summary>
+    /// <param name="webProxy">The web proxy to be used by the HttpClient.</param>
+    /// <returns>An instance of HttpClient configured with the provided web proxy.</returns>
     public HttpClient CreateClientWithProxy(IWebProxy webProxy)
     {
         var handler = _makeHandler();

HttpClientFactory/IHttpClientFactory.cs

@@ -2,7 +2,15 @@
 
 namespace HttpClientFactory;
 
+/// <summary>
+/// Represents a factory for creating HttpClient instances.
+/// </summary>
 public interface IHttpClientFactory
 {
+    /// <summary>
+    /// Creates an HttpClient instance with the specified web proxy.
+    /// </summary>
+    /// <param name="webProxy">The web proxy to be used by the HttpClient.</param>
+    /// <returns>An instance of HttpClient configured with the provided web proxy.</returns>
     HttpClient CreateClientWithProxy(IWebProxy webProxy);
 }