From 9dfe4d96996cf65a7013b5b0eb329aab80434199 Mon Sep 17 00:00:00 2001 From: Ajay Bhargav Baaskaran Date: Fri, 4 Mar 2016 15:49:20 -0800 Subject: [PATCH] Enabled xml doc generation --- NuGetPackageVerifier.json | 17 ++++------------- .../Events/CookieRedirectContext.cs | 1 + .../Events/CookieSigningOutContext.cs | 1 + .../Events/CookieValidatePrincipalContext.cs | 2 +- .../project.json | 4 +++- .../FacebookMiddleware.cs | 5 ++--- .../project.json | 4 +++- .../GoogleMiddleware.cs | 5 ++--- .../project.json | 4 +++- .../Events/IJwtBearerEvents.cs | 5 +---- .../Events/JwtBearerEvents.cs | 6 +----- .../JwtBearerOptions.cs | 2 +- .../project.json | 4 +++- .../MicrosoftAccountMiddleware.cs | 5 ++--- .../project.json | 4 +++- .../Events/IOAuthEvents.cs | 4 ++-- .../Events/OAuthEvents.cs | 4 ++-- .../OAuthRedirectToAuthorizationContext.cs | 1 + .../OAuthMiddleware.cs | 8 +++++--- .../OAuthOptions.cs | 2 +- .../project.json | 4 +++- .../OpenIdConnectAppBuilderExtensions.cs | 2 +- .../OpenIdConnectHandler.cs | 12 ++++++------ .../OpenIdConnectMiddleware.cs | 5 +++-- .../project.json | 4 +++- .../Events/ITwitterEvents.cs | 2 +- .../Events/TwitterCreatingTicketContext.cs | 1 + .../Events/TwitterEvents.cs | 2 +- .../TwitterMiddleware.cs | 5 ++--- .../project.json | 4 +++- .../AuthenticationHandler.cs | 1 + .../RemoteAuthenticationOptions.cs | 4 ++-- .../project.json | 4 +++- .../AuthorizationServiceExtensions.cs | 1 + .../project.json | 4 +++- .../project.json | 4 +++- .../Properties/AssemblyInfo.cs | 1 + .../project.json | 10 ++++++---- 38 files changed, 86 insertions(+), 72 deletions(-) diff --git a/NuGetPackageVerifier.json b/NuGetPackageVerifier.json index 4c7cf6982f..9f3414fbc4 100644 --- a/NuGetPackageVerifier.json +++ b/NuGetPackageVerifier.json @@ -1,12 +1,7 @@ { "adx": { // Packages written by the ADX team and that ship on NuGet.org "rules": [ - "AssemblyHasDocumentFileRule", - "AssemblyHasVersionAttributesRule", - "AssemblyHasServicingAttributeRule", - "AssemblyHasNeutralResourcesLanguageAttributeRule", - "SatellitePackageRule", - "StrictSemanticVersionValidationRule" + "AdxVerificationCompositeRule" ], "packages": { "Microsoft.AspNetCore.Authentication": { }, @@ -19,17 +14,13 @@ "Microsoft.AspNetCore.Authentication.OpenIdConnect": { }, "Microsoft.AspNetCore.Authentication.Twitter": { }, "Microsoft.AspNetCore.Authorization": { }, - "Microsoft.AspNetCore.CookiePolicy": { } + "Microsoft.AspNetCore.CookiePolicy": { }, + "Microsoft.Owin.Security.Interop": { } } }, "Default": { // Rules to run for packages not listed in any other set. "rules": [ - "AssemblyHasDocumentFileRule", - "AssemblyHasVersionAttributesRule", - "AssemblyHasServicingAttributeRule", - "AssemblyHasNeutralResourcesLanguageAttributeRule", - "SatellitePackageRule", - "StrictSemanticVersionValidationRule" + "DefaultCompositeRule" ] } } \ No newline at end of file diff --git a/src/Microsoft.AspNetCore.Authentication.Cookies/Events/CookieRedirectContext.cs b/src/Microsoft.AspNetCore.Authentication.Cookies/Events/CookieRedirectContext.cs index e946548f49..c26cd5d662 100644 --- a/src/Microsoft.AspNetCore.Authentication.Cookies/Events/CookieRedirectContext.cs +++ b/src/Microsoft.AspNetCore.Authentication.Cookies/Events/CookieRedirectContext.cs @@ -19,6 +19,7 @@ namespace Microsoft.AspNetCore.Authentication.Cookies /// The HTTP request context /// The cookie middleware options /// The initial redirect URI + /// The . [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings", MessageId = "2#", Justification = "Represents header value")] public CookieRedirectContext(HttpContext context, CookieAuthenticationOptions options, string redirectUri, AuthenticationProperties properties) : base(context, options) diff --git a/src/Microsoft.AspNetCore.Authentication.Cookies/Events/CookieSigningOutContext.cs b/src/Microsoft.AspNetCore.Authentication.Cookies/Events/CookieSigningOutContext.cs index ab5858e369..51c04a56b9 100644 --- a/src/Microsoft.AspNetCore.Authentication.Cookies/Events/CookieSigningOutContext.cs +++ b/src/Microsoft.AspNetCore.Authentication.Cookies/Events/CookieSigningOutContext.cs @@ -17,6 +17,7 @@ namespace Microsoft.AspNetCore.Authentication.Cookies /// /// /// + /// /// public CookieSigningOutContext( HttpContext context, diff --git a/src/Microsoft.AspNetCore.Authentication.Cookies/Events/CookieValidatePrincipalContext.cs b/src/Microsoft.AspNetCore.Authentication.Cookies/Events/CookieValidatePrincipalContext.cs index d2c1fd42f6..57a28191c8 100644 --- a/src/Microsoft.AspNetCore.Authentication.Cookies/Events/CookieValidatePrincipalContext.cs +++ b/src/Microsoft.AspNetCore.Authentication.Cookies/Events/CookieValidatePrincipalContext.cs @@ -62,7 +62,7 @@ namespace Microsoft.AspNetCore.Authentication.Cookies /// Called to replace the claims principal. The supplied principal will replace the value of the /// Principal property, which determines the identity of the authenticated request. /// - /// The identity used as the replacement + /// The used as the replacement public void ReplacePrincipal(ClaimsPrincipal principal) { Principal = principal; diff --git a/src/Microsoft.AspNetCore.Authentication.Cookies/project.json b/src/Microsoft.AspNetCore.Authentication.Cookies/project.json index 46666ed124..0029e6a897 100644 --- a/src/Microsoft.AspNetCore.Authentication.Cookies/project.json +++ b/src/Microsoft.AspNetCore.Authentication.Cookies/project.json @@ -7,7 +7,9 @@ }, "compilationOptions": { "warningsAsErrors": true, - "keyFile": "../../tools/Key.snk" + "keyFile": "../../tools/Key.snk", + "nowarn": [ "CS1591" ], + "xmlDoc": true }, "dependencies": { "Microsoft.AspNetCore.Authentication": "1.0.0-*", diff --git a/src/Microsoft.AspNetCore.Authentication.Facebook/FacebookMiddleware.cs b/src/Microsoft.AspNetCore.Authentication.Facebook/FacebookMiddleware.cs index 16b60e1dd4..e4a76e0e93 100644 --- a/src/Microsoft.AspNetCore.Authentication.Facebook/FacebookMiddleware.cs +++ b/src/Microsoft.AspNetCore.Authentication.Facebook/FacebookMiddleware.cs @@ -27,7 +27,6 @@ namespace Microsoft.AspNetCore.Authentication.Facebook /// /// /// Configuration options for the middleware. - /// public FacebookMiddleware( RequestDelegate next, IDataProtectionProvider dataProtectionProvider, @@ -79,9 +78,9 @@ namespace Microsoft.AspNetCore.Authentication.Facebook } /// - /// Provides the object for processing authentication-related requests. + /// Provides the object for processing authentication-related requests. /// - /// An configured with the supplied to the constructor. + /// An configured with the supplied to the constructor. protected override AuthenticationHandler CreateHandler() { return new FacebookHandler(Backchannel); diff --git a/src/Microsoft.AspNetCore.Authentication.Facebook/project.json b/src/Microsoft.AspNetCore.Authentication.Facebook/project.json index e93b2feb4d..3cd595a96e 100644 --- a/src/Microsoft.AspNetCore.Authentication.Facebook/project.json +++ b/src/Microsoft.AspNetCore.Authentication.Facebook/project.json @@ -7,7 +7,9 @@ }, "compilationOptions": { "warningsAsErrors": true, - "keyFile": "../../tools/Key.snk" + "keyFile": "../../tools/Key.snk", + "nowarn": [ "CS1591" ], + "xmlDoc": true }, "dependencies": { "Microsoft.AspNetCore.Authentication.OAuth": "1.0.0-*" diff --git a/src/Microsoft.AspNetCore.Authentication.Google/GoogleMiddleware.cs b/src/Microsoft.AspNetCore.Authentication.Google/GoogleMiddleware.cs index f81497f26a..190dc4b25a 100644 --- a/src/Microsoft.AspNetCore.Authentication.Google/GoogleMiddleware.cs +++ b/src/Microsoft.AspNetCore.Authentication.Google/GoogleMiddleware.cs @@ -28,7 +28,6 @@ namespace Microsoft.AspNetCore.Authentication.Google /// /// /// Configuration options for the middleware. - /// public GoogleMiddleware( RequestDelegate next, IDataProtectionProvider dataProtectionProvider, @@ -70,9 +69,9 @@ namespace Microsoft.AspNetCore.Authentication.Google } /// - /// Provides the object for processing authentication-related requests. + /// Provides the object for processing authentication-related requests. /// - /// An configured with the supplied to the constructor. + /// An configured with the supplied to the constructor. protected override AuthenticationHandler CreateHandler() { return new GoogleHandler(Backchannel); diff --git a/src/Microsoft.AspNetCore.Authentication.Google/project.json b/src/Microsoft.AspNetCore.Authentication.Google/project.json index d250dee275..702d45aefd 100644 --- a/src/Microsoft.AspNetCore.Authentication.Google/project.json +++ b/src/Microsoft.AspNetCore.Authentication.Google/project.json @@ -7,7 +7,9 @@ }, "compilationOptions": { "warningsAsErrors": true, - "keyFile": "../../tools/Key.snk" + "keyFile": "../../tools/Key.snk", + "nowarn": [ "CS1591" ], + "xmlDoc": true }, "dependencies": { "Microsoft.AspNetCore.Authentication.OAuth": "1.0.0-*" diff --git a/src/Microsoft.AspNetCore.Authentication.JwtBearer/Events/IJwtBearerEvents.cs b/src/Microsoft.AspNetCore.Authentication.JwtBearer/Events/IJwtBearerEvents.cs index 4ad6f7c21b..2e023db130 100644 --- a/src/Microsoft.AspNetCore.Authentication.JwtBearer/Events/IJwtBearerEvents.cs +++ b/src/Microsoft.AspNetCore.Authentication.JwtBearer/Events/IJwtBearerEvents.cs @@ -3,13 +3,10 @@ using System.Threading.Tasks; -/// -/// Specifies events which the invokes to enable developer control over the authentication process. /> -/// namespace Microsoft.AspNetCore.Authentication.JwtBearer { /// - /// OpenIdConnect bearer token middleware events. + /// Specifies events which the invokes to enable developer control over the authentication process. /// public interface IJwtBearerEvents { diff --git a/src/Microsoft.AspNetCore.Authentication.JwtBearer/Events/JwtBearerEvents.cs b/src/Microsoft.AspNetCore.Authentication.JwtBearer/Events/JwtBearerEvents.cs index 5fc8a6b6c9..a14f238078 100644 --- a/src/Microsoft.AspNetCore.Authentication.JwtBearer/Events/JwtBearerEvents.cs +++ b/src/Microsoft.AspNetCore.Authentication.JwtBearer/Events/JwtBearerEvents.cs @@ -3,15 +3,11 @@ using System; using System.Threading.Tasks; -using Microsoft.AspNetCore.Http; -/// -/// Specifies events which the invokes to enable developer control over the authentication process. /> -/// namespace Microsoft.AspNetCore.Authentication.JwtBearer { /// - /// OpenIdConnect bearer token middleware events. + /// Specifies events which the invokes to enable developer control over the authentication process. /// public class JwtBearerEvents : IJwtBearerEvents { diff --git a/src/Microsoft.AspNetCore.Authentication.JwtBearer/JwtBearerOptions.cs b/src/Microsoft.AspNetCore.Authentication.JwtBearer/JwtBearerOptions.cs index a4b5ef2ae2..c350c38baf 100644 --- a/src/Microsoft.AspNetCore.Authentication.JwtBearer/JwtBearerOptions.cs +++ b/src/Microsoft.AspNetCore.Authentication.JwtBearer/JwtBearerOptions.cs @@ -113,7 +113,7 @@ namespace Microsoft.AspNetCore.Builder /// /// Defines whether the bearer token should be stored in the - /// after a successful authorization. + /// after a successful authorization. /// public bool SaveToken { get; set; } = true; } diff --git a/src/Microsoft.AspNetCore.Authentication.JwtBearer/project.json b/src/Microsoft.AspNetCore.Authentication.JwtBearer/project.json index 21be97e4b8..091deca827 100644 --- a/src/Microsoft.AspNetCore.Authentication.JwtBearer/project.json +++ b/src/Microsoft.AspNetCore.Authentication.JwtBearer/project.json @@ -7,7 +7,9 @@ }, "compilationOptions": { "warningsAsErrors": true, - "keyFile": "../../tools/Key.snk" + "keyFile": "../../tools/Key.snk", + "nowarn": [ "CS1591" ], + "xmlDoc": true }, "dependencies": { "Microsoft.AspNetCore.Authentication": "1.0.0-*", diff --git a/src/Microsoft.AspNetCore.Authentication.MicrosoftAccount/MicrosoftAccountMiddleware.cs b/src/Microsoft.AspNetCore.Authentication.MicrosoftAccount/MicrosoftAccountMiddleware.cs index e7ba9f8117..fc9866826b 100644 --- a/src/Microsoft.AspNetCore.Authentication.MicrosoftAccount/MicrosoftAccountMiddleware.cs +++ b/src/Microsoft.AspNetCore.Authentication.MicrosoftAccount/MicrosoftAccountMiddleware.cs @@ -26,7 +26,6 @@ namespace Microsoft.AspNetCore.Authentication.MicrosoftAccount /// /// /// Configuration options for the middleware. - /// public MicrosoftAccountMiddleware( RequestDelegate next, IDataProtectionProvider dataProtectionProvider, @@ -68,9 +67,9 @@ namespace Microsoft.AspNetCore.Authentication.MicrosoftAccount } /// - /// Provides the object for processing authentication-related requests. + /// Provides the object for processing authentication-related requests. /// - /// An configured with the supplied to the constructor. + /// An configured with the supplied to the constructor. protected override AuthenticationHandler CreateHandler() { return new MicrosoftAccountHandler(Backchannel); diff --git a/src/Microsoft.AspNetCore.Authentication.MicrosoftAccount/project.json b/src/Microsoft.AspNetCore.Authentication.MicrosoftAccount/project.json index 468955a931..e0a2fceb0d 100644 --- a/src/Microsoft.AspNetCore.Authentication.MicrosoftAccount/project.json +++ b/src/Microsoft.AspNetCore.Authentication.MicrosoftAccount/project.json @@ -7,7 +7,9 @@ }, "compilationOptions": { "warningsAsErrors": true, - "keyFile": "../../tools/Key.snk" + "keyFile": "../../tools/Key.snk", + "nowarn": [ "CS1591" ], + "xmlDoc": true }, "dependencies": { "Microsoft.AspNetCore.Authentication.OAuth": "1.0.0-*" diff --git a/src/Microsoft.AspNetCore.Authentication.OAuth/Events/IOAuthEvents.cs b/src/Microsoft.AspNetCore.Authentication.OAuth/Events/IOAuthEvents.cs index 76a238e07d..29316732cc 100644 --- a/src/Microsoft.AspNetCore.Authentication.OAuth/Events/IOAuthEvents.cs +++ b/src/Microsoft.AspNetCore.Authentication.OAuth/Events/IOAuthEvents.cs @@ -6,7 +6,7 @@ using System.Threading.Tasks; namespace Microsoft.AspNetCore.Authentication.OAuth { /// - /// Specifies callback methods which the invokes to enable developer control over the authentication process. + /// Specifies callback methods which the invokes to enable developer control over the authentication process. /// public interface IOAuthEvents : IRemoteAuthenticationEvents { @@ -21,7 +21,7 @@ namespace Microsoft.AspNetCore.Authentication.OAuth /// /// Called when a Challenge causes a redirect to the authorize endpoint. /// - /// Contains redirect URI and of the challenge. + /// Contains redirect URI and of the challenge. Task RedirectToAuthorizationEndpoint(OAuthRedirectToAuthorizationContext context); } } diff --git a/src/Microsoft.AspNetCore.Authentication.OAuth/Events/OAuthEvents.cs b/src/Microsoft.AspNetCore.Authentication.OAuth/Events/OAuthEvents.cs index cf1528e280..44c4260516 100644 --- a/src/Microsoft.AspNetCore.Authentication.OAuth/Events/OAuthEvents.cs +++ b/src/Microsoft.AspNetCore.Authentication.OAuth/Events/OAuthEvents.cs @@ -28,14 +28,14 @@ namespace Microsoft.AspNetCore.Authentication.OAuth /// /// Invoked after the provider successfully authenticates a user. /// - /// Contains information about the login session as well as the user . + /// Contains information about the login session as well as the user . /// A representing the completed operation. public virtual Task CreatingTicket(OAuthCreatingTicketContext context) => OnCreatingTicket(context); /// /// Called when a Challenge causes a redirect to authorize endpoint in the OAuth middleware. /// - /// Contains redirect URI and of the challenge. + /// Contains redirect URI and of the challenge. public virtual Task RedirectToAuthorizationEndpoint(OAuthRedirectToAuthorizationContext context) => OnRedirectToAuthorizationEndpoint(context); } } \ No newline at end of file diff --git a/src/Microsoft.AspNetCore.Authentication.OAuth/Events/OAuthRedirectToAuthorizationContext.cs b/src/Microsoft.AspNetCore.Authentication.OAuth/Events/OAuthRedirectToAuthorizationContext.cs index 5dcbd568cb..63eaa35376 100644 --- a/src/Microsoft.AspNetCore.Authentication.OAuth/Events/OAuthRedirectToAuthorizationContext.cs +++ b/src/Microsoft.AspNetCore.Authentication.OAuth/Events/OAuthRedirectToAuthorizationContext.cs @@ -16,6 +16,7 @@ namespace Microsoft.AspNetCore.Authentication.OAuth /// Creates a new context object. /// /// The HTTP request context. + /// The . /// The authentication properties of the challenge. /// The initial redirect URI. public OAuthRedirectToAuthorizationContext(HttpContext context, OAuthOptions options, AuthenticationProperties properties, string redirectUri) diff --git a/src/Microsoft.AspNetCore.Authentication.OAuth/OAuthMiddleware.cs b/src/Microsoft.AspNetCore.Authentication.OAuth/OAuthMiddleware.cs index 401537e831..1a16d2aa3b 100644 --- a/src/Microsoft.AspNetCore.Authentication.OAuth/OAuthMiddleware.cs +++ b/src/Microsoft.AspNetCore.Authentication.OAuth/OAuthMiddleware.cs @@ -21,11 +21,13 @@ namespace Microsoft.AspNetCore.Authentication.OAuth public class OAuthMiddleware : AuthenticationMiddleware where TOptions : OAuthOptions, new() { /// - /// Initializes a new . + /// Initializes a new . /// /// The next middleware in the HTTP pipeline to invoke. /// /// + /// The . + /// The configuration options for this middleware. /// Configuration options for the middleware. public OAuthMiddleware( RequestDelegate next, @@ -127,9 +129,9 @@ namespace Microsoft.AspNetCore.Authentication.OAuth protected HttpClient Backchannel { get; private set; } /// - /// Provides the object for processing authentication-related requests. + /// Provides the object for processing authentication-related requests. /// - /// An configured with the supplied to the constructor. + /// An configured with the supplied to the constructor. protected override AuthenticationHandler CreateHandler() { return new OAuthHandler(Backchannel); diff --git a/src/Microsoft.AspNetCore.Authentication.OAuth/OAuthOptions.cs b/src/Microsoft.AspNetCore.Authentication.OAuth/OAuthOptions.cs index 22d5e35573..57ecba2f48 100644 --- a/src/Microsoft.AspNetCore.Authentication.OAuth/OAuthOptions.cs +++ b/src/Microsoft.AspNetCore.Authentication.OAuth/OAuthOptions.cs @@ -10,7 +10,7 @@ using Microsoft.AspNetCore.Http.Authentication; namespace Microsoft.AspNetCore.Builder { /// - /// Configuration options for . + /// Configuration options for . /// public class OAuthOptions : RemoteAuthenticationOptions { diff --git a/src/Microsoft.AspNetCore.Authentication.OAuth/project.json b/src/Microsoft.AspNetCore.Authentication.OAuth/project.json index dc073ab7ba..b8f056facb 100644 --- a/src/Microsoft.AspNetCore.Authentication.OAuth/project.json +++ b/src/Microsoft.AspNetCore.Authentication.OAuth/project.json @@ -7,7 +7,9 @@ }, "compilationOptions": { "warningsAsErrors": true, - "keyFile": "../../tools/Key.snk" + "keyFile": "../../tools/Key.snk", + "nowarn": [ "CS1591" ], + "xmlDoc": true }, "dependencies": { "Microsoft.AspNetCore.Authentication": "1.0.0-*", diff --git a/src/Microsoft.AspNetCore.Authentication.OpenIdConnect/OpenIdConnectAppBuilderExtensions.cs b/src/Microsoft.AspNetCore.Authentication.OpenIdConnect/OpenIdConnectAppBuilderExtensions.cs index 07aefec424..dde12494de 100644 --- a/src/Microsoft.AspNetCore.Authentication.OpenIdConnect/OpenIdConnectAppBuilderExtensions.cs +++ b/src/Microsoft.AspNetCore.Authentication.OpenIdConnect/OpenIdConnectAppBuilderExtensions.cs @@ -31,7 +31,7 @@ namespace Microsoft.AspNetCore.Builder /// Adds the middleware to the specified , which enables OpenID Connect authentication capabilities. /// /// The to add the middleware to. - /// A that specifies options for the middleware. + /// A that specifies options for the middleware. /// A reference to this instance after the operation has completed. public static IApplicationBuilder UseOpenIdConnectAuthentication(this IApplicationBuilder app, OpenIdConnectOptions options) { diff --git a/src/Microsoft.AspNetCore.Authentication.OpenIdConnect/OpenIdConnectHandler.cs b/src/Microsoft.AspNetCore.Authentication.OpenIdConnect/OpenIdConnectHandler.cs index 1e804ef314..9c157e57bf 100644 --- a/src/Microsoft.AspNetCore.Authentication.OpenIdConnect/OpenIdConnectHandler.cs +++ b/src/Microsoft.AspNetCore.Authentication.OpenIdConnect/OpenIdConnectHandler.cs @@ -579,8 +579,7 @@ namespace Microsoft.AspNetCore.Authentication.OpenIdConnect /// /// Redeems the authorization code for tokens at the token endpoint /// - /// The authorization code to redeem. - /// Uri that was passed in the request sent for the authorization code. + /// The request that will be sent to the token endpoint and is available for customization. /// OpenIdConnect message that has tokens inside it. protected virtual async Task RedeemAuthorizationCodeAsync(OpenIdConnectMessage tokenEndpointRequest) { @@ -598,6 +597,7 @@ namespace Microsoft.AspNetCore.Authentication.OpenIdConnect /// Goes to UserInfo endpoint to retrieve additional claims and add any unique claims to the given identity. /// /// message that is being processed + /// The . /// authentication ticket with claims principal and identities /// Authentication ticket with identity with additional claims, if any. protected virtual async Task GetUserInformationAsync(OpenIdConnectMessage message, JwtSecurityToken jwt, AuthenticationTicket ticket) @@ -689,7 +689,7 @@ namespace Microsoft.AspNetCore.Authentication.OpenIdConnect /// /// Save the tokens contained in the in the . /// - /// The principal in which tokens are saved. + /// The in which tokens are saved. /// The OpenID Connect response. private void SaveTokens(AuthenticationProperties properties, OpenIdConnectMessage message) { @@ -734,7 +734,7 @@ namespace Microsoft.AspNetCore.Authentication.OpenIdConnect /// Adds the nonce to . /// /// the nonce to remember. - /// is called to add a cookie with the name: 'OpenIdConnectAuthenticationDefaults.Nonce + (nonce)'. + /// of is called to add a cookie with the name: 'OpenIdConnectAuthenticationDefaults.Nonce + (nonce)' of . /// The value of the cookie is: "N". private void WriteNonceCookie(string nonce) { @@ -759,8 +759,8 @@ namespace Microsoft.AspNetCore.Authentication.OpenIdConnect /// /// the nonce that we are looking for. /// echos 'nonce' if a cookie is found that matches, null otherwise. - /// Examine that start with the prefix: 'OpenIdConnectAuthenticationDefaults.Nonce'. - /// is used to obtain the actual 'nonce'. If the nonce is found, then is called. + /// Examine of that start with the prefix: 'OpenIdConnectAuthenticationDefaults.Nonce'. + /// of is used to obtain the actual 'nonce'. If the nonce is found, then of is called. private string ReadNonceCookie(string nonce) { if (nonce == null) diff --git a/src/Microsoft.AspNetCore.Authentication.OpenIdConnect/OpenIdConnectMiddleware.cs b/src/Microsoft.AspNetCore.Authentication.OpenIdConnect/OpenIdConnectMiddleware.cs index 09901cf372..86ba433123 100644 --- a/src/Microsoft.AspNetCore.Authentication.OpenIdConnect/OpenIdConnectMiddleware.cs +++ b/src/Microsoft.AspNetCore.Authentication.OpenIdConnect/OpenIdConnectMiddleware.cs @@ -31,6 +31,7 @@ namespace Microsoft.AspNetCore.Authentication.OpenIdConnect /// /// /// + /// The . [SuppressMessage("Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Justification = "Managed by caller")] public OpenIdConnectMiddleware( RequestDelegate next, @@ -172,9 +173,9 @@ namespace Microsoft.AspNetCore.Authentication.OpenIdConnect protected HtmlEncoder HtmlEncoder { get; private set; } /// - /// Provides the object for processing authentication-related requests. + /// Provides the object for processing authentication-related requests. /// - /// An configured with the supplied to the constructor. + /// An configured with the supplied to the constructor. protected override AuthenticationHandler CreateHandler() { return new OpenIdConnectHandler(Backchannel, HtmlEncoder); diff --git a/src/Microsoft.AspNetCore.Authentication.OpenIdConnect/project.json b/src/Microsoft.AspNetCore.Authentication.OpenIdConnect/project.json index fc58e6a890..870884c4df 100644 --- a/src/Microsoft.AspNetCore.Authentication.OpenIdConnect/project.json +++ b/src/Microsoft.AspNetCore.Authentication.OpenIdConnect/project.json @@ -7,7 +7,9 @@ }, "compilationOptions": { "warningsAsErrors": true, - "keyFile": "../../tools/Key.snk" + "keyFile": "../../tools/Key.snk", + "nowarn": [ "CS1591" ], + "xmlDoc": true }, "dependencies": { "Microsoft.AspNetCore.Authentication": "1.0.0-*", diff --git a/src/Microsoft.AspNetCore.Authentication.Twitter/Events/ITwitterEvents.cs b/src/Microsoft.AspNetCore.Authentication.Twitter/Events/ITwitterEvents.cs index 76b487b966..006fafc731 100644 --- a/src/Microsoft.AspNetCore.Authentication.Twitter/Events/ITwitterEvents.cs +++ b/src/Microsoft.AspNetCore.Authentication.Twitter/Events/ITwitterEvents.cs @@ -20,7 +20,7 @@ namespace Microsoft.AspNetCore.Authentication.Twitter /// /// Called when a Challenge causes a redirect to authorize endpoint in the Twitter middleware /// - /// Contains redirect URI and of the challenge + /// Contains redirect URI and of the challenge Task RedirectToAuthorizationEndpoint(TwitterRedirectToAuthorizationEndpointContext context); } } diff --git a/src/Microsoft.AspNetCore.Authentication.Twitter/Events/TwitterCreatingTicketContext.cs b/src/Microsoft.AspNetCore.Authentication.Twitter/Events/TwitterCreatingTicketContext.cs index 97d1d176a9..04a45ac6d8 100644 --- a/src/Microsoft.AspNetCore.Authentication.Twitter/Events/TwitterCreatingTicketContext.cs +++ b/src/Microsoft.AspNetCore.Authentication.Twitter/Events/TwitterCreatingTicketContext.cs @@ -17,6 +17,7 @@ namespace Microsoft.AspNetCore.Authentication.Twitter /// Initializes a /// /// The HTTP environment + /// The options for Twitter /// Twitter user ID /// Twitter screen name /// Twitter access token diff --git a/src/Microsoft.AspNetCore.Authentication.Twitter/Events/TwitterEvents.cs b/src/Microsoft.AspNetCore.Authentication.Twitter/Events/TwitterEvents.cs index 99122e8553..21c5b57a7f 100644 --- a/src/Microsoft.AspNetCore.Authentication.Twitter/Events/TwitterEvents.cs +++ b/src/Microsoft.AspNetCore.Authentication.Twitter/Events/TwitterEvents.cs @@ -35,7 +35,7 @@ namespace Microsoft.AspNetCore.Authentication.Twitter /// /// Called when a Challenge causes a redirect to authorize endpoint in the Twitter middleware /// - /// Contains redirect URI and of the challenge + /// Contains redirect URI and of the challenge public virtual Task RedirectToAuthorizationEndpoint(TwitterRedirectToAuthorizationEndpointContext context) => OnRedirectToAuthorizationEndpoint(context); } } diff --git a/src/Microsoft.AspNetCore.Authentication.Twitter/TwitterMiddleware.cs b/src/Microsoft.AspNetCore.Authentication.Twitter/TwitterMiddleware.cs index 1a1e199cc1..7845b4bbcc 100644 --- a/src/Microsoft.AspNetCore.Authentication.Twitter/TwitterMiddleware.cs +++ b/src/Microsoft.AspNetCore.Authentication.Twitter/TwitterMiddleware.cs @@ -31,7 +31,6 @@ namespace Microsoft.AspNetCore.Authentication.Twitter /// /// /// Configuration options for the middleware - /// public TwitterMiddleware( RequestDelegate next, IDataProtectionProvider dataProtectionProvider, @@ -115,9 +114,9 @@ namespace Microsoft.AspNetCore.Authentication.Twitter } /// - /// Provides the object for processing authentication-related requests. + /// Provides the object for processing authentication-related requests. /// - /// An configured with the supplied to the constructor. + /// An configured with the supplied to the constructor. protected override AuthenticationHandler CreateHandler() { return new TwitterHandler(_httpClient); diff --git a/src/Microsoft.AspNetCore.Authentication.Twitter/project.json b/src/Microsoft.AspNetCore.Authentication.Twitter/project.json index 8dd3556bcc..3dbaf2bf6c 100644 --- a/src/Microsoft.AspNetCore.Authentication.Twitter/project.json +++ b/src/Microsoft.AspNetCore.Authentication.Twitter/project.json @@ -7,7 +7,9 @@ }, "compilationOptions": { "warningsAsErrors": true, - "keyFile": "../../tools/Key.snk" + "keyFile": "../../tools/Key.snk", + "nowarn": [ "CS1591" ], + "xmlDoc": true }, "dependencies": { "Microsoft.AspNetCore.Authentication": "1.0.0-*" diff --git a/src/Microsoft.AspNetCore.Authentication/AuthenticationHandler.cs b/src/Microsoft.AspNetCore.Authentication/AuthenticationHandler.cs index ff98a10318..f50fd3dbbd 100644 --- a/src/Microsoft.AspNetCore.Authentication/AuthenticationHandler.cs +++ b/src/Microsoft.AspNetCore.Authentication/AuthenticationHandler.cs @@ -64,6 +64,7 @@ namespace Microsoft.AspNetCore.Authentication /// The original options passed by the application control behavior /// The utility object to observe the current request and response /// The logging factory used to create loggers + /// The . /// async completion public async Task InitializeAsync(TOptions options, HttpContext context, ILogger logger, UrlEncoder encoder) { diff --git a/src/Microsoft.AspNetCore.Authentication/RemoteAuthenticationOptions.cs b/src/Microsoft.AspNetCore.Authentication/RemoteAuthenticationOptions.cs index d925be8ec4..a78c14bbec 100644 --- a/src/Microsoft.AspNetCore.Authentication/RemoteAuthenticationOptions.cs +++ b/src/Microsoft.AspNetCore.Authentication/RemoteAuthenticationOptions.cs @@ -9,7 +9,7 @@ using Microsoft.AspNetCore.Authentication; namespace Microsoft.AspNetCore.Builder { /// - /// Contains the options used by the . + /// Contains the options used by the . /// public class RemoteAuthenticationOptions : AuthenticationOptions { @@ -60,7 +60,7 @@ namespace Microsoft.AspNetCore.Builder /// /// Defines whether access and refresh tokens should be stored in the - /// after a successful authorization. + /// after a successful authorization. /// This property is set to false by default to reduce /// the size of the final authentication cookie. /// diff --git a/src/Microsoft.AspNetCore.Authentication/project.json b/src/Microsoft.AspNetCore.Authentication/project.json index 73f7ed80d2..8339dc0c31 100644 --- a/src/Microsoft.AspNetCore.Authentication/project.json +++ b/src/Microsoft.AspNetCore.Authentication/project.json @@ -7,7 +7,9 @@ }, "compilationOptions": { "warningsAsErrors": true, - "keyFile": "../../tools/Key.snk" + "keyFile": "../../tools/Key.snk", + "nowarn": [ "CS1591" ], + "xmlDoc": true }, "dependencies": { "Microsoft.AspNetCore.DataProtection": "1.0.0-*", diff --git a/src/Microsoft.AspNetCore.Authorization/AuthorizationServiceExtensions.cs b/src/Microsoft.AspNetCore.Authorization/AuthorizationServiceExtensions.cs index a2b0a755cf..8979c5c632 100644 --- a/src/Microsoft.AspNetCore.Authorization/AuthorizationServiceExtensions.cs +++ b/src/Microsoft.AspNetCore.Authorization/AuthorizationServiceExtensions.cs @@ -13,6 +13,7 @@ namespace Microsoft.AspNetCore.Authorization /// /// Checks if a user meets a specific requirement for the specified resource /// + /// The . /// /// /// diff --git a/src/Microsoft.AspNetCore.Authorization/project.json b/src/Microsoft.AspNetCore.Authorization/project.json index 511a05d56c..7a53cad1db 100644 --- a/src/Microsoft.AspNetCore.Authorization/project.json +++ b/src/Microsoft.AspNetCore.Authorization/project.json @@ -7,7 +7,9 @@ }, "compilationOptions": { "warningsAsErrors": true, - "keyFile": "../../tools/Key.snk" + "keyFile": "../../tools/Key.snk", + "nowarn": [ "CS1591" ], + "xmlDoc": true }, "dependencies": { "Microsoft.Extensions.Logging.Abstractions": "1.0.0-*", diff --git a/src/Microsoft.AspNetCore.CookiePolicy/project.json b/src/Microsoft.AspNetCore.CookiePolicy/project.json index ce4c552dc9..1c2a549bef 100644 --- a/src/Microsoft.AspNetCore.CookiePolicy/project.json +++ b/src/Microsoft.AspNetCore.CookiePolicy/project.json @@ -7,7 +7,9 @@ }, "compilationOptions": { "warningsAsErrors": true, - "keyFile": "../../tools/Key.snk" + "keyFile": "../../tools/Key.snk", + "nowarn": [ "CS1591" ], + "xmlDoc": true }, "dependencies": { "Microsoft.AspNetCore.Http": "1.0.0-*", diff --git a/src/Microsoft.Owin.Security.Interop/Properties/AssemblyInfo.cs b/src/Microsoft.Owin.Security.Interop/Properties/AssemblyInfo.cs index 1fe857fd92..56cb77fdc5 100644 --- a/src/Microsoft.Owin.Security.Interop/Properties/AssemblyInfo.cs +++ b/src/Microsoft.Owin.Security.Interop/Properties/AssemblyInfo.cs @@ -12,3 +12,4 @@ using System.Runtime.InteropServices; [assembly: Guid("a7922dd8-09f1-43e4-938b-cc523ea08898")] [assembly: AssemblyCompany("Microsoft Corporation.")] [assembly: AssemblyCopyright("© Microsoft Corporation. All rights reserved.")] +[assembly: AssemblyProduct("Microsoft ASP.NET Core")] diff --git a/src/Microsoft.Owin.Security.Interop/project.json b/src/Microsoft.Owin.Security.Interop/project.json index 953428b7b4..741385c83a 100644 --- a/src/Microsoft.Owin.Security.Interop/project.json +++ b/src/Microsoft.Owin.Security.Interop/project.json @@ -1,9 +1,11 @@ { "version": "1.0.0-*", - "compilationOptions": { - "warningsAsErrors": true, - "keyFile": "../../tools/Key.snk" - }, + "compilationOptions": { + "warningsAsErrors": true, + "keyFile": "../../tools/Key.snk", + "nowarn": [ "CS1591" ], + "xmlDoc": true + }, "description": "A compatibility layer for sharing authentication tickets between Microsoft.Owin.Security and Microsoft.AspNetCore.Authentication.", "dependencies": { "Microsoft.AspNetCore.DataProtection.Extensions": "1.0.0-*",