add xml docs, copyright

Author: leastprivilege

src/IdentityModel.OidcClient/Browser/BrowserOptions.cs

@@ -6,15 +6,56 @@
 
 namespace IdentityModel.OidcClient.Browser
 {
+    /// <summary>
+    /// Options for the browser used for login.
+    /// </summary>
     public class BrowserOptions
     {
+        /// <summary>
+        /// Gets the start URL.
+        /// </summary>
+        /// <value>
+        /// The start URL.
+        /// </value>
         public string StartUrl { get; }
+
+        /// <summary>
+        /// Gets the end URL.
+        /// </summary>
+        /// <value>
+        /// The end URL.
+        /// </value>
         public string EndUrl { get; }
 
+        /// <summary>
+        /// Gets or sets the OpenID Connect response mode.
+        /// </summary>
+        /// <value>
+        /// The response mode.
+        /// </value>
         public OidcClientOptions.AuthorizeResponseMode ResponseMode { get; set; } = OidcClientOptions.AuthorizeResponseMode.FormPost;
+
+        /// <summary>
+        /// Gets or sets the browser display mode.
+        /// </summary>
+        /// <value>
+        /// The display mode.
+        /// </value>
         public DisplayMode DisplayMode { get; set; } = DisplayMode.Visible;
+
+        /// <summary>
+        /// Gets or sets the browser timeout.
+        /// </summary>
+        /// <value>
+        /// The timeout.
+        /// </value>
         public TimeSpan Timeout { get; set; } = TimeSpan.FromMinutes(5);
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="BrowserOptions"/> class.
+        /// </summary>
+        /// <param name="startUrl">The start URL.</param>
+        /// <param name="endUrl">The end URL.</param>
         public BrowserOptions(string startUrl, string endUrl)
         {
             StartUrl = startUrl;

src/IdentityModel.OidcClient/Browser/BrowserResult.cs

@@ -4,9 +4,26 @@
 
 namespace IdentityModel.OidcClient.Browser
 {
+    /// <summary>
+    /// The result from a browser login.
+    /// </summary>
+    /// <seealso cref="IdentityModel.OidcClient.Result" />
     public class BrowserResult : Result
     {
+        /// <summary>
+        /// Gets or sets the type of the result.
+        /// </summary>
+        /// <value>
+        /// The type of the result.
+        /// </value>
         public BrowserResultType ResultType { get; set; }
+
+        /// <summary>
+        /// Gets or sets the response.
+        /// </summary>
+        /// <value>
+        /// The response.
+        /// </value>
         public string Response { get; set; }
     }
 }

src/IdentityModel.OidcClient/Browser/BrowserResultType.cs

@@ -4,12 +4,30 @@
 
 namespace IdentityModel.OidcClient.Browser
 {
+    /// <summary>
+    /// Possible browser results.
+    /// </summary>
     public enum BrowserResultType
     {
+        /// <summary>
+        /// success
+        /// </summary>
         Success,
+        /// <summary>
+        /// HTTP error
+        /// </summary>
         HttpError,
+        /// <summary>
+        /// user cancel
+        /// </summary>
         UserCancel,
+        /// <summary>
+        /// timeout
+        /// </summary>
         Timeout,
+        /// <summary>
+        /// unknown error
+        /// </summary>
         UnknownError
     }
 }

src/IdentityModel.OidcClient/Browser/DisplayMode.cs

@@ -4,9 +4,18 @@
 
 namespace IdentityModel.OidcClient.Browser
 {
+    /// <summary>
+    /// Browser display mode
+    /// </summary>
     public enum DisplayMode
     {
+        /// <summary>
+        /// visible
+        /// </summary>
         Visible,
+        /// <summary>
+        /// hidden
+        /// </summary>
         Hidden
     }
 }

src/IdentityModel.OidcClient/Browser/IBrowser.cs

@@ -6,8 +6,16 @@
 
 namespace IdentityModel.OidcClient.Browser
 {
+    /// <summary>
+    /// Models a browser
+    /// </summary>
     public interface IBrowser
     {
+        /// <summary>
+        /// Invokes the browser.
+        /// </summary>
+        /// <param name="options">The options.</param>
+        /// <returns></returns>
         Task<BrowserResult> InvokeAsync(BrowserOptions options);
     }
 }

src/IdentityModel.OidcClient/LoginRequest.cs

@@ -6,12 +6,41 @@
 
 namespace IdentityModel.OidcClient
 {
+    /// <summary>
+    /// A login request.
+    /// </summary>
     public class LoginRequest
     {
+        /// <summary>
+        /// Gets or sets the browser display mode.
+        /// </summary>
+        /// <value>
+        /// The browser display mode.
+        /// </value>
         public DisplayMode BrowserDisplayMode { get; set; } = DisplayMode.Visible;
+
+        /// <summary>
+        /// Gets or sets the browser timeout.
+        /// </summary>
+        /// <value>
+        /// The browser timeout.
+        /// </value>
         public int BrowserTimeout { get; set; } = 300;
 
+        /// <summary>
+        /// Gets or sets the front channel extra parameters.
+        /// </summary>
+        /// <value>
+        /// The front channel extra parameters.
+        /// </value>
         public object FrontChannelExtraParameters { get; set; }
+
+        /// <summary>
+        /// Gets or sets the back channel extra parameters.
+        /// </summary>
+        /// <value>
+        /// The back channel extra parameters.
+        /// </value>
         public object BackChannelExtraParameters { get; set; }
     }
 }

src/IdentityModel.OidcClient/LogoutRequest.cs

@@ -6,11 +6,33 @@
 
 namespace IdentityModel.OidcClient
 {
+    /// <summary>
+    /// A logout request
+    /// </summary>
     public class LogoutRequest
     {
+        /// <summary>
+        /// Gets or sets the browser display mode.
+        /// </summary>
+        /// <value>
+        /// The browser display mode.
+        /// </value>
         public DisplayMode BrowserDisplayMode { get; set; } = DisplayMode.Visible;
+
+        /// <summary>
+        /// Gets or sets the browser timeout.
+        /// </summary>
+        /// <value>
+        /// The browser timeout.
+        /// </value>
         public int BrowserTimeout { get; set; } = 300;
 
+        /// <summary>
+        /// Gets or sets the id_token_hint.
+        /// </summary>
+        /// <value>
+        /// The identifier token hint.
+        /// </value>
         public string IdTokenHint { get; set; }
     }
 }

src/IdentityModel.OidcClient/OidClientOptions.cs

@@ -221,13 +221,28 @@ public class OidcClientOptions
         /// </summary>
         public enum AuthenticationFlow
         {
+            /// <summary>
+            /// authorization code
+            /// </summary>
             AuthorizationCode,
+            /// <summary>
+            /// hybrid
+            /// </summary>
             Hybrid
         }
 
+        /// <summary>
+        /// The response mode
+        /// </summary>
         public enum AuthorizeResponseMode
         {
+            /// <summary>
+            /// form post
+            /// </summary>
             FormPost,
+            /// <summary>
+            /// redirect
+            /// </summary>
             Redirect
         }
     }

src/IdentityModel.OidcClient/OidcClient.cs

@@ -27,6 +27,12 @@ public class OidcClient
         private readonly bool useDiscovery;
         private readonly ResponseProcessor _processor;
 
+        /// <summary>
+        /// Gets the options.
+        /// </summary>
+        /// <value>
+        /// The options.
+        /// </value>
         public OidcClientOptions Options
         {
             get { return _options; }
@@ -53,6 +59,13 @@ public OidcClient(OidcClientOptions options)
             _processor = new ResponseProcessor(options, EnsureProviderInformationAsync);
         }
 
+        /// <summary>
+        /// Starts a login.
+        /// </summary>
+        /// <param name="displayMode">The browser display mode.</param>
+        /// <param name="timeout">The browser timeout.</param>
+        /// <param name="extraParameters">The extra parameters.</param>
+        /// <returns></returns>
         [Obsolete("This method will be removed in a future version. Please change your code to use LoginRequest")]
         public async Task<LoginResult> LoginAsync(DisplayMode displayMode = DisplayMode.Visible, int timeout = 300, object extraParameters = null)
         {
@@ -64,6 +77,11 @@ public async Task<LoginResult> LoginAsync(DisplayMode displayMode = DisplayMode.
             });
         }
 
+        /// <summary>
+        /// Starts a login.
+        /// </summary>
+        /// <param name="request">The login request.</param>
+        /// <returns></returns>
         public async Task<LoginResult> LoginAsync(LoginRequest request)
         {
             _logger.LogTrace("LoginAsync");
@@ -90,6 +108,11 @@ public async Task<LoginResult> LoginAsync(LoginRequest request)
             return result;
         }
 
+        /// <summary>
+        /// Starts a logout.
+        /// </summary>
+        /// <param name="request">The logout request.</param>
+        /// <returns></returns>
         public async Task LogoutAsync(LogoutRequest request = null)
         {
             if (request == null) request = new LogoutRequest();
@@ -115,7 +138,10 @@ public async Task<AuthorizeState> PrepareLoginAsync(object extraParameters = nul
         /// </summary>
         /// <param name="data">The response data.</param>
         /// <param name="state">The state.</param>
-        /// <returns>Result of the login response validation</returns>
+        /// <param name="extraParameters">The extra parameters.</param>
+        /// <returns>
+        /// Result of the login response validation
+        /// </returns>
         public async Task<LoginResult> ProcessResponseAsync(string data, AuthorizeState state, object extraParameters = null)
         {
             _logger.LogTrace("ProcessResponseAsync");

src/IdentityModel.OidcClient/ProviderInformation.cs

@@ -69,7 +69,20 @@ public class ProviderInformation
         public IEnumerable<string> TokenEndPointAuthenticationMethods { get; set; } = new string[] { };
 
 
+        /// <summary>
+        /// Gets a value indicating whether [supports user information].
+        /// </summary>
+        /// <value>
+        ///   <c>true</c> if [supports user information]; otherwise, <c>false</c>.
+        /// </value>
         public bool SupportsUserInfo => UserInfoEndpoint.IsPresent();
+        
+        /// <summary>
+        /// Gets a value indicating whether [supports end session].
+        /// </summary>
+        /// <value>
+        ///   <c>true</c> if [supports end session]; otherwise, <c>false</c>.
+        /// </value>
         public bool SupportsEndSession => EndSessionEndpoint.IsPresent();
     }
 }