Update xml comments

mdsol · Dec 16, 2024 · 112065f · 112065f
1 parent 228b791
commit 112065f
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 0 deletions.
diff --git a/src/Medidata.MAuth.AspNetCore/MAuthAspNetCoreExtensions.cs b/src/Medidata.MAuth.AspNetCore/MAuthAspNetCoreExtensions.cs
@@ -8,6 +8,9 @@
 
 namespace Medidata.MAuth.AspNetCore
 {
+    /// <summary>
+    /// MAuth extension methods.
+    /// </summary>
     public static class MAuthAspNetCoreExtensions
     {
         /// <summary>

diff --git a/src/Medidata.MAuth.Core/IMAuthAuthenticator.cs b/src/Medidata.MAuth.Core/IMAuthAuthenticator.cs
@@ -3,6 +3,9 @@
 
 namespace Medidata.MAuth.Core;
 
+/// <summary>
+/// MAuth authenticator.
+/// </summary>
 public interface IMAuthAuthenticator
 {
     /// <summary>

diff --git a/src/Medidata.MAuth.Core/MAuthAuthenticator.cs b/src/Medidata.MAuth.Core/MAuthAuthenticator.cs
@@ -11,6 +11,9 @@
 
 namespace Medidata.MAuth.Core
 {
+    /// <summary>
+    /// MAuth service class to process authentication.
+    /// </summary>
     public class MAuthAuthenticator : IMAuthAuthenticator
     {
         private const int AllowedDriftSeconds = 300;
@@ -22,8 +25,17 @@ public class MAuthAuthenticator : IMAuthAuthenticator
         private readonly IDateTimeOffsetWrapper _dateTimeOffsetWrapper;
         private readonly Lazy<HttpClient> _lazyHttpClient;
 
+        /// <summary>
+        /// MAuth application uuid.
+        /// </summary>
         public Guid ApplicationUuid => _options.ApplicationUuid;
 
+        /// <summary>
+        /// Create a new instance <see cref="MAuthAuthenticator"/>
+        /// </summary>
+        /// <param name="options">MAuth options</param>
+        /// <param name="logger">Logger</param>
+        /// <param name="cacheService">Cache service. (Optional)</param>
         public MAuthAuthenticator(MAuthOptionsBase options, ILogger logger, ICacheService cacheService = null)
         {
             if (options.ApplicationUuid == default)
@@ -42,6 +54,13 @@ public MAuthAuthenticator(MAuthOptionsBase options, ILogger logger, ICacheServic
             _dateTimeOffsetWrapper = options.DateTimeOffsetWrapper;
         }
 
+        /// <summary>
+        /// Create a new instance <see cref="MAuthAuthenticator"/>
+        /// </summary>
+        /// <param name="options">MAuth options</param>
+        /// <param name="logger">Logger</param>
+        /// <param name="httpClient">Http Client</param>
+        /// <param name="cacheService">Cache service. (Optional)</param>
         public MAuthAuthenticator(MAuthOptionsBase options, ILogger logger, HttpClient httpClient, ICacheService cacheService = null)
         {
             if (options.ApplicationUuid == default)