Skip to content

Commit

Permalink
XML comments fixed
Browse files Browse the repository at this point in the history
  • Loading branch information
mihirdilip committed Aug 16, 2020
1 parent 27859f6 commit 12531dd
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 3 deletions.
1 change: 0 additions & 1 deletion src/AspNetCore.Authentication.Basic/BasicHandler.cs
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ internal class BasicHandler : AuthenticationHandler<BasicOptions>
/// <param name="logger"></param>
/// <param name="encoder"></param>
/// <param name="clock"></param>
/// <param name="basicUserValidationService"></param>
public BasicHandler(IOptionsMonitor<BasicOptions> options, ILoggerFactory logger, UrlEncoder encoder, ISystemClock clock)
: base(options, logger, encoder, clock)
{
Expand Down
3 changes: 3 additions & 0 deletions src/AspNetCore.Authentication.Basic/BasicOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ namespace AspNetCore.Authentication.Basic
/// </summary>
public class BasicOptions : AuthenticationSchemeOptions
{
/// <summary>
/// Constructor.
/// </summary>
public BasicOptions()
{
Events = new BasicEvents();
Expand Down
2 changes: 1 addition & 1 deletion src/AspNetCore.Authentication.Basic/Events/BasicEvents.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public class BasicEvents
/// <remarks>
/// You must provide a delegate for this property for authentication to occur.
/// In your delegate you should either call context.ValidationSucceeded() which will handle construction of authentication principal from the user details which will be assiged the context.Principal property and call context.Success(),
/// or construct an authentication principal from the user details & attach it to the context.Principal property and finally call context.Success() method.
/// or construct an authentication principal from the user details &amp; attach it to the context.Principal property and finally call context.Success() method.
/// If only context.Principal property set without calling context.Success() method then, Success() method is automaticalled called.
/// </remarks>
public Func<BasicValidateCredentialsContext, Task> OnValidateCredentials { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public BasicValidateCredentialsContext(HttpContext context, AuthenticationScheme
public string Password { get; }

/// <summary>
/// Calling this method will handle construction of authentication principal (<see cref="ClaimsPrincipal">) from the user details
/// Calling this method will handle construction of authentication principal (<see cref="ClaimsPrincipal" />) from the user details
/// which will be assiged to the <see cref="ResultContext{TOptions}.Principal"/> property
/// and <see cref="ResultContext{TOptions}.Success"/> method will also be called.
/// </summary>
Expand Down

0 comments on commit 12531dd

Please sign in to comment.