add descriptions to public API metadata

Author: justcoding121

Titanium.Web.Proxy/Compression/CompressionFactory.cs

@@ -12,7 +12,7 @@ internal static class CompressionFactory
         private static readonly ICompression gzip = new GZipCompression();
         private static readonly ICompression deflate = new DeflateCompression();
 
-        public static ICompression GetCompression(string type)
+        internal static ICompression GetCompression(string type)
         {
             switch (type)
             {

Titanium.Web.Proxy/Decompression/DecompressionFactory.cs

@@ -13,7 +13,7 @@ internal class DecompressionFactory
 
         private static readonly IDecompression deflate = new DeflateDecompression();
 
-        public static IDecompression Create(string type)
+        internal static IDecompression Create(string type)
         {
             switch (type)
             {

Titanium.Web.Proxy/EventArguments/AsyncEventHandler.cs

@@ -3,9 +3,9 @@
 namespace Titanium.Web.Proxy.EventArguments
 {
     /// <summary>
-    /// A generic asynchronous event handler used by this proxy.
+    /// A generic asynchronous event handler used by the proxy.
     /// </summary>
-    /// <typeparam name="TEventArgs"></typeparam>
+    /// <typeparam name="TEventArgs">Event argument type.</typeparam>
     /// <param name="sender">The proxy server instance.</param>
     /// <param name="e">The event arguments.</param>
     /// <returns></returns>

Titanium.Web.Proxy/EventArguments/BeforeSslAuthenticateEventArgs.cs

@@ -16,7 +16,7 @@ internal BeforeSslAuthenticateEventArgs(CancellationTokenSource taskCancellation
         }
 
         /// <summary>
-        /// The server name indication hostname.
+        /// The server name indication hostname if available. Otherwise the generic certificate hostname of TransparentEndPoint.
         /// </summary>
         public string SniHostName { get; internal set; }
 
@@ -28,7 +28,7 @@ internal BeforeSslAuthenticateEventArgs(CancellationTokenSource taskCancellation
         public bool DecryptSsl { get; set; } = true;
 
         /// <summary>
-        /// Terminate the request abruptly.
+        /// Terminate the request abruptly by closing client/server connections.
         /// </summary>
         public void TerminateSession()
         {

Titanium.Web.Proxy/EventArguments/CertificateSelectionEventArgs.cs

@@ -14,27 +14,27 @@ public class CertificateSelectionEventArgs : EventArgs
         public object Sender { get; internal set; }
 
         /// <summary>
-        ///     The host to which we are authenticating against.
+        ///     The remote hostname to which we are authenticating against.
         /// </summary>
         public string TargetHost { get; internal set; }
 
         /// <summary>
-        ///     Local certificates with matching issuers.
+        ///     Local certificates in store with matching issuers requested by TargetHost website.
         /// </summary>
         public X509CertificateCollection LocalCertificates { get; internal set; }
 
         /// <summary>
-        ///     Remote certificate of the server.
+        ///     Certificate of the remote server.
         /// </summary>
         public X509Certificate RemoteCertificate { get; internal set; }
 
         /// <summary>
-        ///     Acceptable issuers mentioned by server.
+        ///     Acceptable issuers as listed by remoted server.
         /// </summary>
         public string[] AcceptableIssuers { get; internal set; }
 
         /// <summary>
-        ///     Client Certificate we selected.
+        ///     Client Certificate we selected. Set this value to override.
         /// </summary>
         public X509Certificate ClientCertificate { get; set; }
     }

Titanium.Web.Proxy/EventArguments/CertificateValidationEventArgs.cs

@@ -26,7 +26,7 @@ public class CertificateValidationEventArgs : EventArgs
         public SslPolicyErrors SslPolicyErrors { get; internal set; }
 
         /// <summary>
-        ///     Is the given server certificate is valid?
+        ///     Is the given server certificate valid?
         /// </summary>
         public bool IsValid { get; set; }
     }

Titanium.Web.Proxy/EventArguments/DataEventArgs.cs

@@ -20,12 +20,12 @@ internal DataEventArgs(byte[] buffer, int offset, int count)
         public byte[] Buffer { get; }
 
         /// <summary>
-        /// Offset in Buffer where valid data begins.
+        /// Offset in buffer from which valid data begins.
         /// </summary>
         public int Offset { get; }
 
         /// <summary>
-        /// Length from offset in Buffer with valid data.
+        /// Length from offset in buffer with valid data.
         /// </summary>
         public int Count { get; }
     }

Titanium.Web.Proxy/EventArguments/LimitedStream.cs

@@ -54,7 +54,7 @@ private void GetNextChunk()
             readChunkTrail = true;
 
             string chunkHead = baseReader.ReadLineAsync().Result;
-            int idx = chunkHead.IndexOf(";");
+            int idx = chunkHead.IndexOf(";", StringComparison.Ordinal);
             if (idx >= 0)
             {
                 chunkHead = chunkHead.Substring(0, idx);
@@ -68,7 +68,7 @@ private void GetNextChunk()
                 bytesRemaining = -1;
 
                 //chunk trail
-                string s = baseReader.ReadLineAsync().Result;
+                baseReader.ReadLineAsync().Wait();
             }
         }
 

Titanium.Web.Proxy/EventArguments/MultipartRequestPartSentEventArgs.cs

@@ -8,14 +8,14 @@ namespace Titanium.Web.Proxy.EventArguments
     /// </summary>
     public class MultipartRequestPartSentEventArgs : EventArgs
     {
-        public MultipartRequestPartSentEventArgs(string boundary, HeaderCollection headers)
+        internal MultipartRequestPartSentEventArgs(string boundary, HeaderCollection headers)
         {
             Boundary = boundary;
             Headers = headers;
         }
 
         /// <summary>
-        /// Boundary
+        /// Boundary.
         /// </summary>
         public string Boundary { get; }
 

Titanium.Web.Proxy/EventArguments/SessionEventArgs.cs

@@ -348,7 +348,7 @@ private async Task<long> ReadUntilBoundaryAsync(CustomBinaryReader reader, long
         /// <summary>
         /// Gets the request body as bytes.
         /// </summary>
-        /// <param name="cancellationToken"></param>
+        /// <param name="cancellationToken">Optional cancellation token for this async task.</param>
         /// <returns>The body as bytes.</returns>
         public async Task<byte[]> GetRequestBody(CancellationToken cancellationToken = default)
         {
@@ -363,7 +363,7 @@ public async Task<byte[]> GetRequestBody(CancellationToken cancellationToken = d
         /// <summary>
         /// Gets the request body as string.
         /// </summary>
-        /// <param name="cancellationToken">Cancellation token for this async task is optional.</param>
+        /// <param name="cancellationToken">Optional cancellation token for this async task.</param>
         /// <returns>The body as string.</returns>
         public async Task<string> GetRequestBodyAsString(CancellationToken cancellationToken = default)
         {
@@ -404,10 +404,12 @@ public void SetRequestBodyString(string body)
             SetRequestBody(WebSession.Request.Encoding.GetBytes(body));
         }
 
+
         /// <summary>
         /// Gets the response body as bytes.
         /// </summary>
-        /// <returns></returns>
+        /// <param name="cancellationToken">Optional cancellation token for this async task.</param>
+        /// <returns>The resulting bytes.</returns>
         public async Task<byte[]> GetResponseBody(CancellationToken cancellationToken = default)
         {
             if (!WebSession.Response.IsBodyRead)
@@ -421,6 +423,7 @@ public async Task<byte[]> GetResponseBody(CancellationToken cancellationToken =
         /// <summary>
         /// Gets the response body as string.
         /// </summary>
+        /// <param name="cancellationToken">Optional cancellation token for this async task.</param>
         /// <returns>The string body.</returns>
         public async Task<string> GetResponseBodyAsString(CancellationToken cancellationToken = default)
         {
@@ -435,7 +438,7 @@ public async Task<string> GetResponseBodyAsString(CancellationToken cancellation
         /// <summary>
         /// Set the response body bytes.
         /// </summary>
-        /// <param name="body"></param>
+        /// <param name="body">The body bytes to set.</param>
         public void SetResponseBody(byte[] body)
         {
             if (!WebSession.Request.Locked)
@@ -450,7 +453,7 @@ public void SetResponseBody(byte[] body)
         /// <summary>
         /// Replace the response body with the specified string.
         /// </summary>
-        /// <param name="body"></param>
+        /// <param name="body">The body string to set.</param>
         public void SetResponseBodyString(string body)
         {
             if (!WebSession.Request.Locked)
@@ -467,8 +470,8 @@ public void SetResponseBodyString(string body)
         /// Before request is made to server respond with the specified HTML string to client
         /// and ignore the request. 
         /// </summary>
-        /// <param name="html"></param>
-        /// <param name="headers"></param>
+        /// <param name="html">HTML content to sent.</param>
+        /// <param name="headers">HTTP response headers.</param>
         public void Ok(string html, Dictionary<string, HttpHeader> headers = null)
         {
             var response = new OkResponse();
@@ -487,8 +490,8 @@ public void Ok(string html, Dictionary<string, HttpHeader> headers = null)
         /// Before request is made to server respond with the specified byte[] to client
         /// and ignore the request. 
         /// </summary>
-        /// <param name="result"></param>
-        /// <param name="headers"></param>
+        /// <param name="result">The html content bytes.</param>
+        /// <param name="headers">The HTTP headers.</param>
         public void Ok(byte[] result, Dictionary<string, HttpHeader> headers = null)
         {
             var response = new OkResponse();
@@ -504,9 +507,9 @@ public void Ok(byte[] result, Dictionary<string, HttpHeader> headers = null)
         /// respond with the specified HTML string and the specified status to client.
         /// And then ignore the request. 
         /// </summary>
-        /// <param name="html"></param>
-        /// <param name="status"></param>
-        /// <param name="headers"></param>
+        /// <param name="html">The html content.</param>
+        /// <param name="status">The HTTP status code.</param>
+        /// <param name="headers">The HTTP headers.</param>
         /// <returns></returns>
         public void GenericResponse(string html, HttpStatusCode status, Dictionary<string, HttpHeader> headers = null)
         {
@@ -522,9 +525,9 @@ public void GenericResponse(string html, HttpStatusCode status, Dictionary<strin
         /// Before request is made to server respond with the specified byte[],
         /// the specified status  to client. And then ignore the request.
         /// </summary>
-        /// <param name="result"></param>
-        /// <param name="status"></param>
-        /// <param name="headers"></param>
+        /// <param name="result">The bytes to sent.</param>
+        /// <param name="status">The HTTP status code.</param>
+        /// <param name="headers">The HTTP headers.</param>
         /// <returns></returns>
         public void GenericResponse(byte[] result, HttpStatusCode status, Dictionary<string, HttpHeader> headers)
         {
@@ -539,7 +542,7 @@ public void GenericResponse(byte[] result, HttpStatusCode status, Dictionary<str
         /// <summary>
         /// Redirect to provided URL.
         /// </summary>
-        /// <param name="url"></param>
+        /// <param name="url">The URL to redirect.</param>
         /// <returns></returns>
         public void Redirect(string url)
         {
@@ -551,7 +554,10 @@ public void Redirect(string url)
             Respond(response);
         }
 
-        /// a generic responder method 
+      /// <summary>
+      /// Respond with given response object to client.
+      /// </summary>
+      /// <param name="response">The response object.</param>
         public void Respond(Response response)
         {
             if (WebSession.Request.Locked)
@@ -576,13 +582,16 @@ public void Respond(Response response)
             }
         }
 
+        /// <summary>
+        /// Terminate the connection to server.
+        /// </summary>
         public void TerminateServerConnection()
         {
             WebSession.Response.TerminateResponse = true;
         }
 
         /// <summary>
-        /// implement any cleanup here
+        /// Implement any cleanup here
         /// </summary>
         public override void Dispose()
         {