Skip to content
This repository was archived by the owner on Dec 24, 2020. It is now read-only.

Commit a47380c

Browse files
committed
Add missing XML documentation
1 parent ebecb8b commit a47380c

14 files changed

+86
-2
lines changed

src/AspNet.Security.OAuth.Introspection/OAuthIntrospectionExtensions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ namespace Microsoft.AspNetCore.Builder
1313
{
1414
/// <summary>
1515
/// Provides extension methods used to configure the OAuth2
16-
/// introspection middleware in an ASP.NET 5 pipeline.
16+
/// introspection middleware in an ASP.NET Core pipeline.
1717
/// </summary>
1818
public static class OAuthIntrospectionExtensions
1919
{

src/AspNet.Security.OAuth.Introspection/OAuthIntrospectionHandler.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@
2525

2626
namespace AspNet.Security.OAuth.Introspection
2727
{
28+
/// <summary>
29+
/// Provides the logic necessary to extract and validate tokens from HTTP requests.
30+
/// </summary>
2831
public class OAuthIntrospectionHandler : AuthenticationHandler<OAuthIntrospectionOptions>
2932
{
3033
protected override async Task<AuthenticateResult> HandleAuthenticateAsync()

src/AspNet.Security.OAuth.Introspection/OAuthIntrospectionMiddleware.cs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,15 @@
1818

1919
namespace AspNet.Security.OAuth.Introspection
2020
{
21+
/// <summary>
22+
/// Provides the entry point necessary to register the
23+
/// OAuth2 introspection handler in an ASP.NET Core pipeline.
24+
/// </summary>
2125
public class OAuthIntrospectionMiddleware : AuthenticationMiddleware<OAuthIntrospectionOptions>
2226
{
27+
/// <summary>
28+
/// Creates a new instance of the <see cref="OAuthIntrospectionMiddleware"/> class.
29+
/// </summary>
2330
public OAuthIntrospectionMiddleware(
2431
[NotNull] RequestDelegate next,
2532
[NotNull] IOptions<OAuthIntrospectionOptions> options,
@@ -126,6 +133,10 @@ public OAuthIntrospectionMiddleware(
126133
}
127134
}
128135

136+
/// <summary>
137+
/// Returns a new <see cref="OAuthIntrospectionHandler"/> instance.
138+
/// </summary>
139+
/// <returns>A new instance of the <see cref="OAuthIntrospectionHandler"/> class.</returns>
129140
protected override AuthenticationHandler<OAuthIntrospectionOptions> CreateHandler()
130141
{
131142
return new OAuthIntrospectionHandler();

src/AspNet.Security.OAuth.Introspection/OAuthIntrospectionOptions.cs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,15 @@
1616

1717
namespace AspNet.Security.OAuth.Introspection
1818
{
19+
/// <summary>
20+
/// Exposes various settings needed to control
21+
/// the behavior of the introspection middleware.
22+
/// </summary>
1923
public class OAuthIntrospectionOptions : AuthenticationOptions
2024
{
25+
/// <summary>
26+
/// Creates a new instance of the <see cref="OAuthIntrospectionOptions"/> class.
27+
/// </summary>
2128
public OAuthIntrospectionOptions()
2229
{
2330
AuthenticationScheme = OAuthIntrospectionDefaults.AuthenticationScheme;

src/AspNet.Security.OAuth.Validation/OAuthValidationExtensions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ namespace Microsoft.AspNetCore.Builder
1313
{
1414
/// <summary>
1515
/// Provides extension methods used to configure the OAuth2
16-
/// validation middleware in an ASP.NET 5 pipeline.
16+
/// validation middleware in an ASP.NET Core pipeline.
1717
/// </summary>
1818
public static class OAuthValidationExtensions
1919
{

src/AspNet.Security.OAuth.Validation/OAuthValidationHandler.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@
1818

1919
namespace AspNet.Security.OAuth.Validation
2020
{
21+
/// <summary>
22+
/// Provides the logic necessary to extract and validate tokens from HTTP requests.
23+
/// </summary>
2124
public class OAuthValidationHandler : AuthenticationHandler<OAuthValidationOptions>
2225
{
2326
protected override async Task<AuthenticateResult> HandleAuthenticateAsync()

src/AspNet.Security.OAuth.Validation/OAuthValidationMiddleware.cs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,15 @@
1414

1515
namespace AspNet.Security.OAuth.Validation
1616
{
17+
/// <summary>
18+
/// Provides the entry point necessary to register the
19+
/// OAuth2 validation handler in an ASP.NET Core pipeline.
20+
/// </summary>
1721
public class OAuthValidationMiddleware : AuthenticationMiddleware<OAuthValidationOptions>
1822
{
23+
/// <summary>
24+
/// Creates a new instance of the <see cref="OAuthValidationMiddleware"/> class.
25+
/// </summary>
1926
public OAuthValidationMiddleware(
2027
[NotNull] RequestDelegate next,
2128
[NotNull] IOptions<OAuthValidationOptions> options,
@@ -44,6 +51,10 @@ public OAuthValidationMiddleware(
4451
}
4552
}
4653

54+
/// <summary>
55+
/// Returns a new <see cref="OAuthValidationHandler"/> instance.
56+
/// </summary>
57+
/// <returns>A new instance of the <see cref="OAuthValidationHandler"/> class.</returns>
4758
protected override AuthenticationHandler<OAuthValidationOptions> CreateHandler()
4859
{
4960
return new OAuthValidationHandler();

src/AspNet.Security.OAuth.Validation/OAuthValidationOptions.cs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,15 @@
1313

1414
namespace AspNet.Security.OAuth.Validation
1515
{
16+
/// <summary>
17+
/// Exposes various settings needed to control
18+
/// the behavior of the validation middleware.
19+
/// </summary>
1620
public class OAuthValidationOptions : AuthenticationOptions
1721
{
22+
/// <summary>
23+
/// Creates a new instance of the <see cref="OAuthValidationOptions"/> class.
24+
/// </summary>
1825
public OAuthValidationOptions()
1926
{
2027
AuthenticationScheme = OAuthValidationDefaults.AuthenticationScheme;

src/Owin.Security.OAuth.Introspection/OAuthIntrospectionHandler.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@
2222

2323
namespace Owin.Security.OAuth.Introspection
2424
{
25+
/// <summary>
26+
/// Provides the logic necessary to extract and validate tokens from HTTP requests.
27+
/// </summary>
2528
public class OAuthIntrospectionHandler : AuthenticationHandler<OAuthIntrospectionOptions>
2629
{
2730
protected override async Task<AuthenticationTicket> AuthenticateCoreAsync()

src/Owin.Security.OAuth.Introspection/OAuthIntrospectionMiddleware.cs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,15 @@
2020

2121
namespace Owin.Security.OAuth.Introspection
2222
{
23+
/// <summary>
24+
/// Provides the entry point necessary to register the
25+
/// OAuth2 introspection handler in an OWIN/Katana pipeline.
26+
/// </summary>
2327
public class OAuthIntrospectionMiddleware : AuthenticationMiddleware<OAuthIntrospectionOptions>
2428
{
29+
/// <summary>
30+
/// Creates a new instance of the <see cref="OAuthIntrospectionMiddleware"/> class.
31+
/// </summary>
2532
public OAuthIntrospectionMiddleware(
2633
[NotNull] OwinMiddleware next,
2734
[NotNull] IDictionary<string, object> properties,
@@ -145,6 +152,10 @@ public OAuthIntrospectionMiddleware(
145152
}
146153
}
147154

155+
/// <summary>
156+
/// Returns a new <see cref="OAuthIntrospectionHandler"/> instance.
157+
/// </summary>
158+
/// <returns>A new instance of the <see cref="OAuthIntrospectionHandler"/> class.</returns>
148159
protected override AuthenticationHandler<OAuthIntrospectionOptions> CreateHandler()
149160
{
150161
return new OAuthIntrospectionHandler();

0 commit comments

Comments
 (0)