Revize a155a763

re #9570 Commented HttpClient.cs, IHttpClient.cs, and IApiClient.cs

ld_client/LDClient/network/HttpClient.cs

@@ -9 +9 @@
 using LDClient.network.data;
 
 namespace LDClient.network {
+    
+    /// <summary>
+    /// Implementation of IHttpClient which defines the functionality
+    /// of a HTTP client that is used by the API client to send data to the server. 
+    /// </summary>
     public class HttpClient : IHttpClient{
 
+        /// <summary>
+        /// Instance of System.Net.Http.HttpClient
+        /// </summary>
         private readonly System.Net.Http.HttpClient _httpClient;
 
+        /// <summary>
+        /// URL to which the HTTP client will connect
+        /// </summary>
         private readonly string _uri;
+        
+        /// <summary>
+        /// Creates an instance of the class
+        /// </summary>
+        /// <param name="uri">URL to which the HTTP client will connect</param>
         public HttpClient(string uri) {
-
             _httpClient = new System.Net.Http.HttpClient();
             _uri = uri;
         }
 
+        /// <summary>
+        /// Asynchronically sends data in JSON format to the server.
+        /// </summary>
+        /// <param name="payload">Payload to be sent to the server</param>
+        /// <returns></returns>
         public Task<HttpResponseMessage> PostAsJsonAsync(Payload payload) {
+            // Serialize the payload and send it to the server as JSON.
             return _httpClient.PostAsJsonAsync(_uri, payload, new JsonSerializerOptions {
                 Converters = {
                     new JsonStringEnumConverter( JsonNamingPolicy.CamelCase)

ld_client/LDClient/network/IApiClient.cs

@@ -2 +2 @@
 
 namespace LDClient.network {
     
+    /// <summary>
+    /// This interface defines the functionality of an API client
+    /// which is used to send information (payloads) to the server.
+    /// </summary>
     public interface IApiClient {
         
+        /// <summary>
+        /// Sends a payload to the server (API).
+        /// </summary>
+        /// <param name="payload">instance of a payload to be sent off to the server</param>
         public Task SendPayloadAsync(Payload payload);
+        
+        /// <summary>
+        /// Runs the periodical retrieval of failed payloads stored
+        /// in a file-based cache. This method is instantiated as a thread.
+        /// </summary>
         public void Run();
     }
 }

ld_client/LDClient/network/IHttpClient.cs

@@ -6 +6 @@
 using LDClient.network.data;
 
 namespace LDClient.network {
+    
+    /// <summary>
+    /// This interface defines the functionality of a HTTP client
+    /// through which the API client sends data (payloads) to the server.
+    /// </summary>
     public interface IHttpClient {
 
+        /// <summary>
+        /// Asynchronically sends data in JSON format to the server.
+        /// </summary>
+        /// <param name="payload">Payload to be sent to the server</param>
+        /// <returns></returns>
         public Task<HttpResponseMessage> PostAsJsonAsync(Payload payload);
     }
 }