From 33eb8ba552c7452f441e2a223457d39f271d01b7 Mon Sep 17 00:00:00 2001 From: Ryan Brandenburg Date: Wed, 3 Jul 2019 10:21:13 -0700 Subject: [PATCH] More doc comment additions (#11697) More doc comment additions --- src/Antiforgery/src/IAntiforgery.cs | 2 + .../ConfigurationModel/SecretExtensions.cs | 5 +- .../src/GenericHostBuilderExtensions.cs | 2 +- .../JsonPatch/src/JsonPatchDocument.cs | 12 ++--- .../JsonPatch/src/JsonPatchDocumentOfT.cs | 52 +++++++++---------- src/Hosting/Abstractions/src/IWebHost.cs | 6 ++- src/Hosting/Hosting/src/WebHostExtensions.cs | 3 +- src/Hosting/TestHost/src/RequestBuilder.cs | 10 ++-- .../src/AuthenticateResult.cs | 3 ++ .../AuthenticationHttpContextExtensions.cs | 2 +- .../src/IAuthenticationRequestHandler.cs | 2 +- src/Http/Http.Abstractions/src/HostString.cs | 45 ++++++++-------- src/Http/Http.Extensions/src/UriHelper.cs | 23 ++++---- .../src/IdentityRoleClaim.cs | 4 +- .../WsFederation/src/WsFederationHandler.cs | 8 +-- 15 files changed, 96 insertions(+), 83 deletions(-) diff --git a/src/Antiforgery/src/IAntiforgery.cs b/src/Antiforgery/src/IAntiforgery.cs index 89630a46d0..425f5d5920 100644 --- a/src/Antiforgery/src/IAntiforgery.cs +++ b/src/Antiforgery/src/IAntiforgery.cs @@ -29,6 +29,7 @@ namespace Microsoft.AspNetCore.Antiforgery /// Generates an for this request. /// /// The associated with the current request. + /// The for this request. /// /// Unlike , this method has no side effect. The caller /// is responsible for setting the response cookie and injecting the returned @@ -51,6 +52,7 @@ namespace Microsoft.AspNetCore.Antiforgery /// Validates an antiforgery token that was supplied as part of the request. /// /// The associated with the current request. + /// A that completes when validation has completed. /// /// Thrown when the request does not include a valid antiforgery token. /// diff --git a/src/DataProtection/DataProtection/src/AuthenticatedEncryption/ConfigurationModel/SecretExtensions.cs b/src/DataProtection/DataProtection/src/AuthenticatedEncryption/ConfigurationModel/SecretExtensions.cs index 75444140c8..4876247762 100644 --- a/src/DataProtection/DataProtection/src/AuthenticatedEncryption/ConfigurationModel/SecretExtensions.cs +++ b/src/DataProtection/DataProtection/src/AuthenticatedEncryption/ConfigurationModel/SecretExtensions.cs @@ -12,7 +12,8 @@ namespace Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.Configurat /// Converts an to an <masterKey> element which is marked /// as requiring encryption. /// - /// + /// The secret for accessing the master key. + /// The master key . public static XElement ToMasterKeyElement(this ISecret secret) { // Technically we'll be keeping the unprotected secret around in memory as @@ -43,7 +44,7 @@ namespace Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.Configurat /// /// Converts a base64-encoded string into an . /// - /// + /// The . public static Secret ToSecret(this string base64String) { byte[] unprotectedSecret = Convert.FromBase64String(base64String); diff --git a/src/DefaultBuilder/src/GenericHostBuilderExtensions.cs b/src/DefaultBuilder/src/GenericHostBuilderExtensions.cs index 2b8d3df275..4e11e3c2ca 100644 --- a/src/DefaultBuilder/src/GenericHostBuilderExtensions.cs +++ b/src/DefaultBuilder/src/GenericHostBuilderExtensions.cs @@ -21,7 +21,7 @@ namespace Microsoft.Extensions.Hosting /// /// The instance to configure /// The configure callback - /// + /// The for chaining. public static IHostBuilder ConfigureWebHostDefaults(this IHostBuilder builder, Action configure) { return builder.ConfigureWebHost(webHostBuilder => diff --git a/src/Features/JsonPatch/src/JsonPatchDocument.cs b/src/Features/JsonPatch/src/JsonPatchDocument.cs index 1888ea6b4b..80c39a6e6c 100644 --- a/src/Features/JsonPatch/src/JsonPatchDocument.cs +++ b/src/Features/JsonPatch/src/JsonPatchDocument.cs @@ -52,7 +52,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// /// target location /// value - /// + /// The for chaining. public JsonPatchDocument Add(string path, object value) { if (path == null) @@ -69,7 +69,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// { "op": "remove", "path": "/a/b/c" } /// /// target location - /// + /// The for chaining. public JsonPatchDocument Remove(string path) { if (path == null) @@ -87,7 +87,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// /// target location /// value - /// + /// The for chaining. public JsonPatchDocument Replace(string path, object value) { if (path == null) @@ -105,7 +105,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// /// target location /// value - /// + /// The for chaining. public JsonPatchDocument Test(string path, object value) { if (path == null) @@ -123,7 +123,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// /// source location /// target location - /// + /// The for chaining. public JsonPatchDocument Move(string from, string path) { if (from == null) @@ -146,7 +146,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// /// source location /// target location - /// + /// The for chaining. public JsonPatchDocument Copy(string from, string path) { if (from == null) diff --git a/src/Features/JsonPatch/src/JsonPatchDocumentOfT.cs b/src/Features/JsonPatch/src/JsonPatchDocumentOfT.cs index e0b4fca240..1b5e6ce0fc 100644 --- a/src/Features/JsonPatch/src/JsonPatchDocumentOfT.cs +++ b/src/Features/JsonPatch/src/JsonPatchDocumentOfT.cs @@ -48,7 +48,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// value type /// target location /// value - /// + /// The for chaining. public JsonPatchDocument Add(Expression> path, TProp value) { if (path == null) @@ -72,7 +72,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// target location /// value /// position - /// + /// The for chaining. public JsonPatchDocument Add( Expression>> path, TProp value, @@ -98,7 +98,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// value type /// target location /// value - /// + /// The for chaining. public JsonPatchDocument Add(Expression>> path, TProp value) { if (path == null) @@ -120,7 +120,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// { "op": "remove", "path": "/a/b/c" } /// /// target location - /// + /// The for chaining. public JsonPatchDocument Remove(Expression> path) { if (path == null) @@ -139,7 +139,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// value type /// target location /// position - /// + /// The for chaining. public JsonPatchDocument Remove(Expression>> path, int position) { if (path == null) @@ -160,7 +160,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// /// value type /// target location - /// + /// The for chaining. public JsonPatchDocument Remove(Expression>> path) { if (path == null) @@ -182,7 +182,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// /// target location /// value - /// + /// The for chaining. public JsonPatchDocument Replace(Expression> path, TProp value) { if (path == null) @@ -206,7 +206,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// target location /// value /// position - /// + /// The for chaining. public JsonPatchDocument Replace(Expression>> path, TProp value, int position) { @@ -230,7 +230,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// value type /// target location /// value - /// + /// The for chaining. public JsonPatchDocument Replace(Expression>> path, TProp value) { if (path == null) @@ -253,7 +253,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// /// target location /// value - /// + /// The for chaining. public JsonPatchDocument Test(Expression> path, TProp value) { if (path == null) @@ -277,7 +277,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// target location /// value /// position - /// + /// The for chaining. public JsonPatchDocument Test(Expression>> path, TProp value, int position) { @@ -301,7 +301,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// value type /// target location /// value - /// + /// The for chaining. public JsonPatchDocument Test(Expression>> path, TProp value) { if (path == null) @@ -324,7 +324,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// /// source location /// target location - /// + /// The for chaining. public JsonPatchDocument Move( Expression> from, Expression> path) @@ -354,7 +354,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// source location /// position /// target location - /// + /// The for chaining. public JsonPatchDocument Move( Expression>> from, int positionFrom, @@ -385,7 +385,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// source location /// target location /// position - /// + /// The for chaining. public JsonPatchDocument Move( Expression> from, Expression>> path, @@ -417,7 +417,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// position (source) /// target location /// position (target) - /// + /// The for chaining. public JsonPatchDocument Move( Expression>> from, int positionFrom, @@ -449,7 +449,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// source location /// position /// target location - /// + /// The for chaining. public JsonPatchDocument Move( Expression>> from, int positionFrom, @@ -479,7 +479,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// /// source location /// target location - /// + /// The for chaining. public JsonPatchDocument Move( Expression> from, Expression>> path) @@ -508,7 +508,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// /// source location /// target location - /// + /// The for chaining. public JsonPatchDocument Copy( Expression> from, Expression> path) @@ -538,7 +538,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// source location /// position /// target location - /// + /// The for chaining. public JsonPatchDocument Copy( Expression>> from, int positionFrom, @@ -569,7 +569,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// source location /// target location /// position - /// + /// The for chaining. public JsonPatchDocument Copy( Expression> from, Expression>> path, @@ -601,7 +601,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// position (source) /// target location /// position (target) - /// + /// The for chaining. public JsonPatchDocument Copy( Expression>> from, int positionFrom, @@ -633,7 +633,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// source location /// position /// target location - /// + /// The for chaining. public JsonPatchDocument Copy( Expression>> from, int positionFrom, @@ -663,7 +663,7 @@ namespace Microsoft.AspNetCore.JsonPatch /// /// source location /// target location - /// + /// The for chaining. public JsonPatchDocument Copy( Expression> from, Expression>> path) @@ -868,7 +868,7 @@ namespace Microsoft.AspNetCore.JsonPatch } - // Evaluates the value of the key or index which may be an int or a string, + // Evaluates the value of the key or index which may be an int or a string, // or some other expression type. // The expression is converted to a delegate and the result of executing the delegate is returned as a string. private static string EvaluateExpression(Expression expression) @@ -881,4 +881,4 @@ namespace Microsoft.AspNetCore.JsonPatch return Convert.ToString(func(null), CultureInfo.InvariantCulture); } } -} \ No newline at end of file +} diff --git a/src/Hosting/Abstractions/src/IWebHost.cs b/src/Hosting/Abstractions/src/IWebHost.cs index 97331e4768..a9f84eecdc 100644 --- a/src/Hosting/Abstractions/src/IWebHost.cs +++ b/src/Hosting/Abstractions/src/IWebHost.cs @@ -31,13 +31,15 @@ namespace Microsoft.AspNetCore.Hosting /// /// Starts listening on the configured addresses. /// + /// Used to abort program start. + /// A that completes when the starts. Task StartAsync(CancellationToken cancellationToken = default); /// /// Attempt to gracefully stop the host. /// - /// - /// + /// Used to indicate when stop should no longer be graceful. + /// A that completes when the stops. Task StopAsync(CancellationToken cancellationToken = default); } } diff --git a/src/Hosting/Hosting/src/WebHostExtensions.cs b/src/Hosting/Hosting/src/WebHostExtensions.cs index a356f58489..0b594be84f 100644 --- a/src/Hosting/Hosting/src/WebHostExtensions.cs +++ b/src/Hosting/Hosting/src/WebHostExtensions.cs @@ -18,7 +18,7 @@ namespace Microsoft.AspNetCore.Hosting /// /// The timeout for stopping gracefully. Once expired the /// server may terminate any remaining active connections. - /// + /// A that completes when the stops. public static Task StopAsync(this IWebHost host, TimeSpan timeout) { return host.StopAsync(new CancellationTokenSource(timeout).Token); @@ -38,6 +38,7 @@ namespace Microsoft.AspNetCore.Hosting /// /// The running . /// The token to trigger shutdown. + /// A that completes when shutdown is triggered via Ctrl+C or SIGTERM. public static async Task WaitForShutdownAsync(this IWebHost host, CancellationToken token = default) { var done = new ManualResetEventSlim(false); diff --git a/src/Hosting/TestHost/src/RequestBuilder.cs b/src/Hosting/TestHost/src/RequestBuilder.cs index 644257992e..c8499fc025 100644 --- a/src/Hosting/TestHost/src/RequestBuilder.cs +++ b/src/Hosting/TestHost/src/RequestBuilder.cs @@ -35,7 +35,7 @@ namespace Microsoft.AspNetCore.TestHost /// Configure any HttpRequestMessage properties. /// /// - /// + /// This for chaining. public RequestBuilder And(Action configure) { if (configure == null) @@ -52,7 +52,7 @@ namespace Microsoft.AspNetCore.TestHost /// /// /// - /// + /// This for chaining. public RequestBuilder AddHeader(string name, string value) { if (!_req.Headers.TryAddWithoutValidation(name, value)) @@ -74,7 +74,7 @@ namespace Microsoft.AspNetCore.TestHost /// Set the request method and start processing the request. /// /// - /// + /// The resulting . public Task SendAsync(string method) { _req.Method = new HttpMethod(method); @@ -84,7 +84,7 @@ namespace Microsoft.AspNetCore.TestHost /// /// Set the request method to GET and start processing the request. /// - /// + /// The resulting . public Task GetAsync() { _req.Method = HttpMethod.Get; @@ -94,7 +94,7 @@ namespace Microsoft.AspNetCore.TestHost /// /// Set the request method to POST and start processing the request. /// - /// + /// The resulting . public Task PostAsync() { _req.Method = HttpMethod.Post; diff --git a/src/Http/Authentication.Abstractions/src/AuthenticateResult.cs b/src/Http/Authentication.Abstractions/src/AuthenticateResult.cs index 5982143bcb..fe31859ed4 100644 --- a/src/Http/Authentication.Abstractions/src/AuthenticateResult.cs +++ b/src/Http/Authentication.Abstractions/src/AuthenticateResult.cs @@ -11,6 +11,9 @@ namespace Microsoft.AspNetCore.Authentication /// public class AuthenticateResult { + /// + /// Creates a new instance. + /// protected AuthenticateResult() { } /// diff --git a/src/Http/Authentication.Abstractions/src/AuthenticationHttpContextExtensions.cs b/src/Http/Authentication.Abstractions/src/AuthenticationHttpContextExtensions.cs index bb50c6534f..0b40426098 100644 --- a/src/Http/Authentication.Abstractions/src/AuthenticationHttpContextExtensions.cs +++ b/src/Http/Authentication.Abstractions/src/AuthenticationHttpContextExtensions.cs @@ -171,7 +171,7 @@ namespace Microsoft.AspNetCore.Authentication /// The context. /// The name of the authentication scheme. /// The properties. - /// + /// The task. public static Task SignOutAsync(this HttpContext context, string scheme, AuthenticationProperties properties) => context.RequestServices.GetRequiredService().SignOutAsync(context, scheme, properties); diff --git a/src/Http/Authentication.Abstractions/src/IAuthenticationRequestHandler.cs b/src/Http/Authentication.Abstractions/src/IAuthenticationRequestHandler.cs index fb1b227ad7..d2822cdc88 100644 --- a/src/Http/Authentication.Abstractions/src/IAuthenticationRequestHandler.cs +++ b/src/Http/Authentication.Abstractions/src/IAuthenticationRequestHandler.cs @@ -13,7 +13,7 @@ namespace Microsoft.AspNetCore.Authentication /// /// Returns true if request processing should stop. /// - /// + /// true if request processing should stop. Task HandleRequestAsync(); } diff --git a/src/Http/Http.Abstractions/src/HostString.cs b/src/Http/Http.Abstractions/src/HostString.cs index 0e3da28c41..23850231bf 100644 --- a/src/Http/Http.Abstractions/src/HostString.cs +++ b/src/Http/Http.Abstractions/src/HostString.cs @@ -51,7 +51,7 @@ namespace Microsoft.AspNetCore.Http && host.IndexOf(':', index + 1) >= 0) { // IPv6 without brackets ::1 is the only type of host with 2 or more colons - host = $"[{host}]"; + host = $"[{host}]"; } _value = host + ":" + port.ToString(CultureInfo.InvariantCulture); @@ -74,7 +74,7 @@ namespace Microsoft.AspNetCore.Http /// Returns the value of the host part of the value. The port is removed if it was present. /// IPv6 addresses will have brackets added if they are missing. /// - /// + /// The host portion of the value. public string Host { get @@ -88,7 +88,7 @@ namespace Microsoft.AspNetCore.Http /// /// Returns the value of the port part of the host, or null if none is found. /// - /// + /// The port portion of the value. public int? Port { get @@ -108,7 +108,7 @@ namespace Microsoft.AspNetCore.Http /// /// Returns the value as normalized by ToUriComponent(). /// - /// + /// The value as normalized by . public override string ToString() { return ToUriComponent(); @@ -118,7 +118,7 @@ namespace Microsoft.AspNetCore.Http /// Returns the value properly formatted and encoded for use in a URI in a HTTP header. /// Any Unicode is converted to punycode. IPv6 addresses will have brackets added if they are missing. /// - /// + /// The value formated for use in a URI or HTTP header. public string ToUriComponent() { if (string.IsNullOrEmpty(_value)) @@ -154,8 +154,8 @@ namespace Microsoft.AspNetCore.Http /// Creates a new HostString from the given URI component. /// Any punycode will be converted to Unicode. /// - /// - /// + /// The URI component string to create a from. + /// The that was created. public static HostString FromUriComponent(string uriComponent) { if (!string.IsNullOrEmpty(uriComponent)) @@ -195,8 +195,8 @@ namespace Microsoft.AspNetCore.Http /// Creates a new HostString from the host and port of the give Uri instance. /// Punycode will be converted to Unicode. /// - /// - /// + /// The to create a from. + /// The that was created. public static HostString FromUriComponent(Uri uri) { if (uri == null) @@ -223,7 +223,7 @@ namespace Microsoft.AspNetCore.Http /// "abc.example.com:443" but not "example.com:443". /// Matching is case insensitive. /// - /// + /// true if matches any of the patterns. public static bool MatchesAny(StringSegment value, IList patterns) { if (value == null) @@ -281,8 +281,8 @@ namespace Microsoft.AspNetCore.Http /// /// Compares the equality of the Value property, ignoring case. /// - /// - /// + /// The to compare against. + /// true if they have the same value. public bool Equals(HostString other) { if (!HasValue && !other.HasValue) @@ -295,8 +295,8 @@ namespace Microsoft.AspNetCore.Http /// /// Compares against the given object only if it is a HostString. /// - /// - /// + /// The to compare against. + /// true if they have the same value. public override bool Equals(object obj) { if (ReferenceEquals(null, obj)) @@ -309,7 +309,7 @@ namespace Microsoft.AspNetCore.Http /// /// Gets a hash code for the value. /// - /// + /// The hash code as an . public override int GetHashCode() { return (HasValue ? StringComparer.OrdinalIgnoreCase.GetHashCode(_value) : 0); @@ -318,9 +318,9 @@ namespace Microsoft.AspNetCore.Http /// /// Compares the two instances for equality. /// - /// - /// - /// + /// The left parameter. + /// The right parameter. + /// true if both 's have the same value. public static bool operator ==(HostString left, HostString right) { return left.Equals(right); @@ -329,9 +329,9 @@ namespace Microsoft.AspNetCore.Http /// /// Compares the two instances for inequality. /// - /// - /// - /// + /// The left parameter. + /// The right parameter. + /// true if both 's values are not equal. public static bool operator !=(HostString left, HostString right) { return !left.Equals(right); @@ -340,6 +340,9 @@ namespace Microsoft.AspNetCore.Http /// /// Parses the current value. IPv6 addresses will have brackets added if they are missing. /// + /// The value to get the parts of. + /// The portion of the which represents the host. + /// The portion of the which represents the port. private static void GetParts(StringSegment value, out StringSegment host, out StringSegment port) { int index; diff --git a/src/Http/Http.Extensions/src/UriHelper.cs b/src/Http/Http.Extensions/src/UriHelper.cs index 5cb0a12f26..8db49359bb 100644 --- a/src/Http/Http.Extensions/src/UriHelper.cs +++ b/src/Http/Http.Extensions/src/UriHelper.cs @@ -23,7 +23,7 @@ namespace Microsoft.AspNetCore.Http.Extensions /// The portion of the request path that identifies the requested resource. /// The query, if any. /// The fragment, if any. - /// + /// The combined URI components, properly encoded for use in HTTP headers. public static string BuildRelative( PathString pathBase = new PathString(), PathString path = new PathString(), @@ -44,7 +44,7 @@ namespace Microsoft.AspNetCore.Http.Extensions /// The portion of the request path that identifies the requested resource. /// The query, if any. /// The fragment, if any. - /// + /// The combined URI components, properly encoded for use in HTTP headers. public static string BuildAbsolute( string scheme, HostString host, @@ -90,9 +90,9 @@ namespace Microsoft.AspNetCore.Http.Extensions public static void FromAbsolute( string uri, out string scheme, - out HostString host, + out HostString host, out PathString path, - out QueryString query, + out QueryString query, out FragmentString fragment) { if (uri == null) @@ -134,7 +134,7 @@ namespace Microsoft.AspNetCore.Http.Extensions path = PathString.FromUriComponent(uri.Substring(searchIndex, limit - searchIndex)); limit = searchIndex; } - + host = HostString.FromUriComponent(uri.Substring(startIndex, limit - startIndex)); } @@ -143,7 +143,7 @@ namespace Microsoft.AspNetCore.Http.Extensions /// HTTP headers. Note that a unicode host name will be encoded as punycode. /// /// The Uri to encode. - /// + /// The encoded string version of . public static string Encode(Uri uri) { if (uri == null) @@ -171,16 +171,16 @@ namespace Microsoft.AspNetCore.Http.Extensions /// and other HTTP operations. /// /// The request to assemble the uri pieces from. - /// + /// The encoded string version of the URL from . public static string GetEncodedUrl(this HttpRequest request) { return BuildAbsolute(request.Scheme, request.Host, request.PathBase, request.Path, request.QueryString); } /// - /// Returns the relative url + /// Returns the relative URI. /// /// The request to assemble the uri pieces from. - /// + /// The path and query off of . public static string GetEncodedPathAndQuery(this HttpRequest request) { return BuildRelative(request.PathBase, request.Path, request.QueryString); @@ -191,10 +191,11 @@ namespace Microsoft.AspNetCore.Http.Extensions /// suitable only for display. This format should not be used in HTTP headers or other HTTP operations. /// /// The request to assemble the uri pieces from. - /// + /// The combined components of the request URL in a fully un-escaped form (except for the QueryString) + /// suitable only for display. public static string GetDisplayUrl(this HttpRequest request) { - var scheme = request.Scheme ?? string.Empty; + var scheme = request.Scheme ?? string.Empty; var host = request.Host.Value ?? string.Empty; var pathBase = request.PathBase.Value ?? string.Empty; var path = request.Path.Value ?? string.Empty; diff --git a/src/Identity/Extensions.Stores/src/IdentityRoleClaim.cs b/src/Identity/Extensions.Stores/src/IdentityRoleClaim.cs index ff257d59ed..3f59b2665e 100644 --- a/src/Identity/Extensions.Stores/src/IdentityRoleClaim.cs +++ b/src/Identity/Extensions.Stores/src/IdentityRoleClaim.cs @@ -35,7 +35,7 @@ namespace Microsoft.AspNetCore.Identity /// /// Constructs a new claim with the type and value. /// - /// + /// The that was produced. public virtual Claim ToClaim() { return new Claim(ClaimType, ClaimValue); @@ -51,4 +51,4 @@ namespace Microsoft.AspNetCore.Identity ClaimValue = other?.Value; } } -} \ No newline at end of file +} diff --git a/src/Security/Authentication/WsFederation/src/WsFederationHandler.cs b/src/Security/Authentication/WsFederation/src/WsFederationHandler.cs index 6e1f59a44f..27bb332ccf 100644 --- a/src/Security/Authentication/WsFederation/src/WsFederationHandler.cs +++ b/src/Security/Authentication/WsFederation/src/WsFederationHandler.cs @@ -54,7 +54,7 @@ namespace Microsoft.AspNetCore.Authentication.WsFederation /// /// Overridden to handle remote signout requests /// - /// + /// true if request processing should stop. public override Task HandleRequestAsync() { // RemoteSignOutPath and CallbackPath may be the same, fall through if the message doesn't match. @@ -149,7 +149,7 @@ namespace Microsoft.AspNetCore.Authentication.WsFederation && Request.Body.CanRead) { var form = await Request.ReadFormAsync(); - + wsFederationMessage = new WsFederationMessage(form.Select(pair => new KeyValuePair(pair.Key, pair.Value))); } @@ -163,7 +163,7 @@ namespace Microsoft.AspNetCore.Authentication.WsFederation return HandleRequestResult.Fail("No message."); } - + try { // Retrieve our cached redirect uri @@ -422,4 +422,4 @@ namespace Microsoft.AspNetCore.Authentication.WsFederation return BuildRedirectUri(uri); } } -} \ No newline at end of file +}