Add Missing XML Definitions

brminnick · Nov 24, 2020 · 620d1fe · 620d1fe
1 parent 279d935
commit 620d1fe
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 1 deletion.
diff --git a/Src/GitHubApiStatus/Interfaces/IGitHubApiRateLimits.cs b/Src/GitHubApiStatus/Interfaces/IGitHubApiRateLimits.cs
@@ -1,5 +1,8 @@
 namespace GitHubApiStatus
 {
+    /// <summary>
+    /// Interface for GitHub API Rate Limits
+    /// </summary>
     public interface IGitHubApiRateLimits
     {
         /// <summary>

diff --git a/Src/GitHubApiStatus/Interfaces/IGitHubApiStatusService.cs b/Src/GitHubApiStatus/Interfaces/IGitHubApiStatusService.cs
@@ -5,6 +5,9 @@
 
 namespace GitHubApiStatus
 {
+    /// <summary>
+    /// Interface for GitHubApiStatusService
+    /// </summary>
     public interface IGitHubApiStatusService
     {
         /// <summary>

diff --git a/Src/GitHubApiStatus/Interfaces/IRateLimitStatus.cs b/Src/GitHubApiStatus/Interfaces/IRateLimitStatus.cs
@@ -1,6 +1,9 @@
 using System;
 namespace GitHubApiStatus
 {
+    /// <summary>
+    /// Interface for GitHub API Raite Limit Status
+    /// </summary>
     public interface IRateLimitStatus
     {
         /// <summary>

diff --git a/Src/GitHubApiStatus/Services/GitHubApiStatusService.cs b/Src/GitHubApiStatus/Services/GitHubApiStatusService.cs
@@ -37,7 +37,11 @@ public class GitHubApiStatusService : IGitHubApiStatusService
 #if NETSTANDARD
         readonly static Lazy<JsonSerializer> _serializerHolder = new(() => new JsonSerializer());
 #endif
-
+        /// <summary>
+        /// Initializes GitHubApiStatusService
+        /// </summary>
+        /// <param name="authenticationHeaderValue">GitHub Authentication Bearer Token</param>
+        /// <param name="productHeaderValue">User-Agent Name</param>
         public GitHubApiStatusService(AuthenticationHeaderValue authenticationHeaderValue, ProductHeaderValue? productHeaderValue = null)
         {
             if (authenticationHeaderValue is null)
@@ -56,6 +60,10 @@ public GitHubApiStatusService(AuthenticationHeaderValue authenticationHeaderValu
             Client.DefaultRequestHeaders.UserAgent.Add(new ProductInfoHeaderValue(productHeaderValue));
         }
 
+        /// <summary>
+        /// Initializes GitHubApiStatusService
+        /// </summary>
+        /// <param name="httpClient">GitHub API requires the following Headers: Authorization and User-Agent</param>
         public GitHubApiStatusService(HttpClient httpClient)
         {
             if (httpClient is null)