Enabled xml doc generation

This commit is contained in:
Ajay Bhargav Baaskaran 2016-03-04 15:49:20 -08:00
parent ef6dd41384
commit 9dfe4d9699
38 changed files with 86 additions and 72 deletions

View File

@ -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"
]
}
}

View File

@ -19,6 +19,7 @@ namespace Microsoft.AspNetCore.Authentication.Cookies
/// <param name="context">The HTTP request context</param>
/// <param name="options">The cookie middleware options</param>
/// <param name="redirectUri">The initial redirect URI</param>
/// <param name="properties">The <see cref="AuthenticationProperties"/>.</param>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings", MessageId = "2#", Justification = "Represents header value")]
public CookieRedirectContext(HttpContext context, CookieAuthenticationOptions options, string redirectUri, AuthenticationProperties properties)
: base(context, options)

View File

@ -17,6 +17,7 @@ namespace Microsoft.AspNetCore.Authentication.Cookies
/// </summary>
/// <param name="context"></param>
/// <param name="options"></param>
/// <param name="properties"></param>
/// <param name="cookieOptions"></param>
public CookieSigningOutContext(
HttpContext context,

View File

@ -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.
/// </summary>
/// <param name="identity">The identity used as the replacement</param>
/// <param name="principal">The <see cref="ClaimsPrincipal"/> used as the replacement</param>
public void ReplacePrincipal(ClaimsPrincipal principal)
{
Principal = principal;

View File

@ -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-*",

View File

@ -27,7 +27,6 @@ namespace Microsoft.AspNetCore.Authentication.Facebook
/// <param name="encoder"></param>
/// <param name="sharedOptions"></param>
/// <param name="options">Configuration options for the middleware.</param>
/// <param name="configureOptions"></param>
public FacebookMiddleware(
RequestDelegate next,
IDataProtectionProvider dataProtectionProvider,
@ -79,9 +78,9 @@ namespace Microsoft.AspNetCore.Authentication.Facebook
}
/// <summary>
/// Provides the <see cref="AuthenticationHandler"/> object for processing authentication-related requests.
/// Provides the <see cref="AuthenticationHandler{T}"/> object for processing authentication-related requests.
/// </summary>
/// <returns>An <see cref="AuthenticationHandler"/> configured with the <see cref="FacebookOptions"/> supplied to the constructor.</returns>
/// <returns>An <see cref="AuthenticationHandler{T}"/> configured with the <see cref="FacebookOptions"/> supplied to the constructor.</returns>
protected override AuthenticationHandler<FacebookOptions> CreateHandler()
{
return new FacebookHandler(Backchannel);

View File

@ -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-*"

View File

@ -28,7 +28,6 @@ namespace Microsoft.AspNetCore.Authentication.Google
/// <param name="encoder"></param>
/// <param name="sharedOptions"></param>
/// <param name="options">Configuration options for the middleware.</param>
/// <param name="configureOptions"></param>
public GoogleMiddleware(
RequestDelegate next,
IDataProtectionProvider dataProtectionProvider,
@ -70,9 +69,9 @@ namespace Microsoft.AspNetCore.Authentication.Google
}
/// <summary>
/// Provides the <see cref="AuthenticationHandler"/> object for processing authentication-related requests.
/// Provides the <see cref="AuthenticationHandler{T}"/> object for processing authentication-related requests.
/// </summary>
/// <returns>An <see cref="AuthenticationHandler"/> configured with the <see cref="GoogleOptions"/> supplied to the constructor.</returns>
/// <returns>An <see cref="AuthenticationHandler{T}"/> configured with the <see cref="GoogleOptions"/> supplied to the constructor.</returns>
protected override AuthenticationHandler<GoogleOptions> CreateHandler()
{
return new GoogleHandler(Backchannel);

View File

@ -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-*"

View File

@ -3,13 +3,10 @@
using System.Threading.Tasks;
/// <summary>
/// Specifies events which the <see cref="JwtBearerAuthenticationMiddleware"></see> invokes to enable developer control over the authentication process. />
/// </summary>
namespace Microsoft.AspNetCore.Authentication.JwtBearer
{
/// <summary>
/// OpenIdConnect bearer token middleware events.
/// Specifies events which the <see cref="JwtBearerMiddleware"/> invokes to enable developer control over the authentication process.
/// </summary>
public interface IJwtBearerEvents
{

View File

@ -3,15 +3,11 @@
using System;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
/// <summary>
/// Specifies events which the <see cref="JwtBearerAuthenticationMiddleware"></see> invokes to enable developer control over the authentication process. />
/// </summary>
namespace Microsoft.AspNetCore.Authentication.JwtBearer
{
/// <summary>
/// OpenIdConnect bearer token middleware events.
/// Specifies events which the <see cref="JwtBearerMiddleware"/> invokes to enable developer control over the authentication process.
/// </summary>
public class JwtBearerEvents : IJwtBearerEvents
{

View File

@ -113,7 +113,7 @@ namespace Microsoft.AspNetCore.Builder
/// <summary>
/// Defines whether the bearer token should be stored in the
/// <see cref="AuthenticationProperties"/> after a successful authorization.
/// <see cref="Http.Authentication.AuthenticationProperties"/> after a successful authorization.
/// </summary>
public bool SaveToken { get; set; } = true;
}

View File

@ -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-*",

View File

@ -26,7 +26,6 @@ namespace Microsoft.AspNetCore.Authentication.MicrosoftAccount
/// <param name="encoder"></param>
/// <param name="sharedOptions"></param>
/// <param name="options">Configuration options for the middleware.</param>
/// <param name="configureOptions"></param>
public MicrosoftAccountMiddleware(
RequestDelegate next,
IDataProtectionProvider dataProtectionProvider,
@ -68,9 +67,9 @@ namespace Microsoft.AspNetCore.Authentication.MicrosoftAccount
}
/// <summary>
/// Provides the <see cref="AuthenticationHandler"/> object for processing authentication-related requests.
/// Provides the <see cref="AuthenticationHandler{T}"/> object for processing authentication-related requests.
/// </summary>
/// <returns>An <see cref="AuthenticationHandler"/> configured with the <see cref="MicrosoftAccountOptions"/> supplied to the constructor.</returns>
/// <returns>An <see cref="AuthenticationHandler{T}"/> configured with the <see cref="MicrosoftAccountOptions"/> supplied to the constructor.</returns>
protected override AuthenticationHandler<MicrosoftAccountOptions> CreateHandler()
{
return new MicrosoftAccountHandler(Backchannel);

View File

@ -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-*"

View File

@ -6,7 +6,7 @@ using System.Threading.Tasks;
namespace Microsoft.AspNetCore.Authentication.OAuth
{
/// <summary>
/// Specifies callback methods which the <see cref="OAuthMiddleware"/> invokes to enable developer control over the authentication process.
/// Specifies callback methods which the <see cref="OAuthMiddleware{T}"/> invokes to enable developer control over the authentication process.
/// </summary>
public interface IOAuthEvents : IRemoteAuthenticationEvents
{
@ -21,7 +21,7 @@ namespace Microsoft.AspNetCore.Authentication.OAuth
/// <summary>
/// Called when a Challenge causes a redirect to the authorize endpoint.
/// </summary>
/// <param name="context">Contains redirect URI and <see cref="AuthenticationProperties"/> of the challenge.</param>
/// <param name="context">Contains redirect URI and <see cref="Http.Authentication.AuthenticationProperties"/> of the challenge.</param>
Task RedirectToAuthorizationEndpoint(OAuthRedirectToAuthorizationContext context);
}
}

View File

@ -28,14 +28,14 @@ namespace Microsoft.AspNetCore.Authentication.OAuth
/// <summary>
/// Invoked after the provider successfully authenticates a user.
/// </summary>
/// <param name="context">Contains information about the login session as well as the user <see cref="ClaimsIdentity"/>.</param>
/// <param name="context">Contains information about the login session as well as the user <see cref="System.Security.Claims.ClaimsIdentity"/>.</param>
/// <returns>A <see cref="Task"/> representing the completed operation.</returns>
public virtual Task CreatingTicket(OAuthCreatingTicketContext context) => OnCreatingTicket(context);
/// <summary>
/// Called when a Challenge causes a redirect to authorize endpoint in the OAuth middleware.
/// </summary>
/// <param name="context">Contains redirect URI and <see cref="AuthenticationProperties"/> of the challenge.</param>
/// <param name="context">Contains redirect URI and <see cref="Http.Authentication.AuthenticationProperties"/> of the challenge.</param>
public virtual Task RedirectToAuthorizationEndpoint(OAuthRedirectToAuthorizationContext context) => OnRedirectToAuthorizationEndpoint(context);
}
}

View File

@ -16,6 +16,7 @@ namespace Microsoft.AspNetCore.Authentication.OAuth
/// Creates a new context object.
/// </summary>
/// <param name="context">The HTTP request context.</param>
/// <param name="options">The <see cref="OAuthOptions"/>.</param>
/// <param name="properties">The authentication properties of the challenge.</param>
/// <param name="redirectUri">The initial redirect URI.</param>
public OAuthRedirectToAuthorizationContext(HttpContext context, OAuthOptions options, AuthenticationProperties properties, string redirectUri)

View File

@ -21,11 +21,13 @@ namespace Microsoft.AspNetCore.Authentication.OAuth
public class OAuthMiddleware<TOptions> : AuthenticationMiddleware<TOptions> where TOptions : OAuthOptions, new()
{
/// <summary>
/// Initializes a new <see cref="OAuthAuthenticationMiddleware"/>.
/// Initializes a new <see cref="OAuthMiddleware{T}"/>.
/// </summary>
/// <param name="next">The next middleware in the HTTP pipeline to invoke.</param>
/// <param name="dataProtectionProvider"></param>
/// <param name="loggerFactory"></param>
/// <param name="encoder">The <see cref="UrlEncoder"/>.</param>
/// <param name="sharedOptions">The <see cref="SharedAuthenticationOptions"/> configuration options for this middleware.</param>
/// <param name="options">Configuration options for the middleware.</param>
public OAuthMiddleware(
RequestDelegate next,
@ -127,9 +129,9 @@ namespace Microsoft.AspNetCore.Authentication.OAuth
protected HttpClient Backchannel { get; private set; }
/// <summary>
/// Provides the <see cref="AuthenticationHandler"/> object for processing authentication-related requests.
/// Provides the <see cref="AuthenticationHandler{T}"/> object for processing authentication-related requests.
/// </summary>
/// <returns>An <see cref="AuthenticationHandler"/> configured with the <see cref="OAuthOptions"/> supplied to the constructor.</returns>
/// <returns>An <see cref="AuthenticationHandler{T}"/> configured with the <see cref="OAuthOptions"/> supplied to the constructor.</returns>
protected override AuthenticationHandler<TOptions> CreateHandler()
{
return new OAuthHandler<TOptions>(Backchannel);

View File

@ -10,7 +10,7 @@ using Microsoft.AspNetCore.Http.Authentication;
namespace Microsoft.AspNetCore.Builder
{
/// <summary>
/// Configuration options for <see cref="OAuthMiddleware"/>.
/// Configuration options for <see cref="OAuthMiddleware{T}"/>.
/// </summary>
public class OAuthOptions : RemoteAuthenticationOptions
{

View File

@ -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-*",

View File

@ -31,7 +31,7 @@ namespace Microsoft.AspNetCore.Builder
/// Adds the <see cref="OpenIdConnectMiddleware"/> middleware to the specified <see cref="IApplicationBuilder"/>, which enables OpenID Connect authentication capabilities.
/// </summary>
/// <param name="app">The <see cref="IApplicationBuilder"/> to add the middleware to.</param>
/// <param name="configureOptions">A <see cref="OpenIdConnectOptions"/> that specifies options for the middleware.</param>
/// <param name="options">A <see cref="OpenIdConnectOptions"/> that specifies options for the middleware.</param>
/// <returns>A reference to this instance after the operation has completed.</returns>
public static IApplicationBuilder UseOpenIdConnectAuthentication(this IApplicationBuilder app, OpenIdConnectOptions options)
{

View File

@ -579,8 +579,7 @@ namespace Microsoft.AspNetCore.Authentication.OpenIdConnect
/// <summary>
/// Redeems the authorization code for tokens at the token endpoint
/// </summary>
/// <param name="authorizationCode">The authorization code to redeem.</param>
/// <param name="redirectUri">Uri that was passed in the request sent for the authorization code.</param>
/// <param name="tokenEndpointRequest">The request that will be sent to the token endpoint and is available for customization.</param>
/// <returns>OpenIdConnect message that has tokens inside it.</returns>
protected virtual async Task<OpenIdConnectMessage> 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.
/// </summary>
/// <param name="message">message that is being processed</param>
/// <param name="jwt">The <see cref="JwtSecurityToken"/>.</param>
/// <param name="ticket">authentication ticket with claims principal and identities</param>
/// <returns>Authentication ticket with identity with additional claims, if any.</returns>
protected virtual async Task<AuthenticateResult> GetUserInformationAsync(OpenIdConnectMessage message, JwtSecurityToken jwt, AuthenticationTicket ticket)
@ -689,7 +689,7 @@ namespace Microsoft.AspNetCore.Authentication.OpenIdConnect
/// <summary>
/// Save the tokens contained in the <see cref="OpenIdConnectMessage"/> in the <see cref="ClaimsPrincipal"/>.
/// </summary>
/// <param name="principal">The principal in which tokens are saved.</param>
/// <param name="properties">The <see cref="AuthenticationProperties"/> in which tokens are saved.</param>
/// <param name="message">The OpenID Connect response.</param>
private void SaveTokens(AuthenticationProperties properties, OpenIdConnectMessage message)
{
@ -734,7 +734,7 @@ namespace Microsoft.AspNetCore.Authentication.OpenIdConnect
/// Adds the nonce to <see cref="HttpResponse.Cookies"/>.
/// </summary>
/// <param name="nonce">the nonce to remember.</param>
/// <remarks><see cref="HttpResponse.Cookies.Append"/>is called to add a cookie with the name: 'OpenIdConnectAuthenticationDefaults.Nonce + <see cref="OpenIdConnectOptions.StringDataFormat.Protect"/>(nonce)'.
/// <remarks><see cref="M:IResponseCookies.Append"/> of <see cref="HttpResponse.Cookies"/> is called to add a cookie with the name: 'OpenIdConnectAuthenticationDefaults.Nonce + <see cref="M:ISecureDataFormat{TData}.Protect"/>(nonce)' of <see cref="OpenIdConnectOptions.StringDataFormat"/>.
/// The value of the cookie is: "N".</remarks>
private void WriteNonceCookie(string nonce)
{
@ -759,8 +759,8 @@ namespace Microsoft.AspNetCore.Authentication.OpenIdConnect
/// </summary>
/// <param name="nonce">the nonce that we are looking for.</param>
/// <returns>echos 'nonce' if a cookie is found that matches, null otherwise.</returns>
/// <remarks>Examine <see cref="HttpRequest.Cookies.Keys"/> that start with the prefix: 'OpenIdConnectAuthenticationDefaults.Nonce'.
/// <see cref="OpenIdConnectOptions.StringDataFormat.Unprotect"/> is used to obtain the actual 'nonce'. If the nonce is found, then <see cref="HttpResponse.Cookies.Delete"/> is called.</remarks>
/// <remarks>Examine <see cref="IRequestCookieCollection.Keys"/> of <see cref="HttpRequest.Cookies"/> that start with the prefix: 'OpenIdConnectAuthenticationDefaults.Nonce'.
/// <see cref="M:ISecureDataFormat{TData}.Unprotect"/> of <see cref="OpenIdConnectOptions.StringDataFormat"/> is used to obtain the actual 'nonce'. If the nonce is found, then <see cref="M:IResponseCookies.Delete"/> of <see cref="HttpResponse.Cookies"/> is called.</remarks>
private string ReadNonceCookie(string nonce)
{
if (nonce == null)

View File

@ -31,6 +31,7 @@ namespace Microsoft.AspNetCore.Authentication.OpenIdConnect
/// <param name="services"></param>
/// <param name="sharedOptions"></param>
/// <param name="options"></param>
/// <param name="htmlEncoder">The <see cref="HtmlEncoder"/>.</param>
[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; }
/// <summary>
/// Provides the <see cref="AuthenticationHandler"/> object for processing authentication-related requests.
/// Provides the <see cref="AuthenticationHandler{T}"/> object for processing authentication-related requests.
/// </summary>
/// <returns>An <see cref="AuthenticationHandler"/> configured with the <see cref="OpenIdConnectOptions"/> supplied to the constructor.</returns>
/// <returns>An <see cref="AuthenticationHandler{T}"/> configured with the <see cref="OpenIdConnectOptions"/> supplied to the constructor.</returns>
protected override AuthenticationHandler<OpenIdConnectOptions> CreateHandler()
{
return new OpenIdConnectHandler(Backchannel, HtmlEncoder);

View File

@ -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-*",

View File

@ -20,7 +20,7 @@ namespace Microsoft.AspNetCore.Authentication.Twitter
/// <summary>
/// Called when a Challenge causes a redirect to authorize endpoint in the Twitter middleware
/// </summary>
/// <param name="context">Contains redirect URI and <see cref="AuthenticationProperties"/> of the challenge </param>
/// <param name="context">Contains redirect URI and <see cref="Http.Authentication.AuthenticationProperties"/> of the challenge </param>
Task RedirectToAuthorizationEndpoint(TwitterRedirectToAuthorizationEndpointContext context);
}
}

View File

@ -17,6 +17,7 @@ namespace Microsoft.AspNetCore.Authentication.Twitter
/// Initializes a <see cref="TwitterCreatingTicketContext"/>
/// </summary>
/// <param name="context">The HTTP environment</param>
/// <param name="options">The options for Twitter</param>
/// <param name="userId">Twitter user ID</param>
/// <param name="screenName">Twitter screen name</param>
/// <param name="accessToken">Twitter access token</param>

View File

@ -35,7 +35,7 @@ namespace Microsoft.AspNetCore.Authentication.Twitter
/// <summary>
/// Called when a Challenge causes a redirect to authorize endpoint in the Twitter middleware
/// </summary>
/// <param name="context">Contains redirect URI and <see cref="AuthenticationProperties"/> of the challenge </param>
/// <param name="context">Contains redirect URI and <see cref="Http.Authentication.AuthenticationProperties"/> of the challenge </param>
public virtual Task RedirectToAuthorizationEndpoint(TwitterRedirectToAuthorizationEndpointContext context) => OnRedirectToAuthorizationEndpoint(context);
}
}

View File

@ -31,7 +31,6 @@ namespace Microsoft.AspNetCore.Authentication.Twitter
/// <param name="encoder"></param>
/// <param name="sharedOptions"></param>
/// <param name="options">Configuration options for the middleware</param>
/// <param name="configureOptions"></param>
public TwitterMiddleware(
RequestDelegate next,
IDataProtectionProvider dataProtectionProvider,
@ -115,9 +114,9 @@ namespace Microsoft.AspNetCore.Authentication.Twitter
}
/// <summary>
/// Provides the <see cref="AuthenticationHandler"/> object for processing authentication-related requests.
/// Provides the <see cref="AuthenticationHandler{T}"/> object for processing authentication-related requests.
/// </summary>
/// <returns>An <see cref="AuthenticationHandler"/> configured with the <see cref="TwitterOptions"/> supplied to the constructor.</returns>
/// <returns>An <see cref="AuthenticationHandler{T}"/> configured with the <see cref="TwitterOptions"/> supplied to the constructor.</returns>
protected override AuthenticationHandler<TwitterOptions> CreateHandler()
{
return new TwitterHandler(_httpClient);

View File

@ -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-*"

View File

@ -64,6 +64,7 @@ namespace Microsoft.AspNetCore.Authentication
/// <param name="options">The original options passed by the application control behavior</param>
/// <param name="context">The utility object to observe the current request and response</param>
/// <param name="logger">The logging factory used to create loggers</param>
/// <param name="encoder">The <see cref="UrlEncoder"/>.</param>
/// <returns>async completion</returns>
public async Task InitializeAsync(TOptions options, HttpContext context, ILogger logger, UrlEncoder encoder)
{

View File

@ -9,7 +9,7 @@ using Microsoft.AspNetCore.Authentication;
namespace Microsoft.AspNetCore.Builder
{
/// <summary>
/// Contains the options used by the <see cref="RemoteAuthenticationHandler"/>.
/// Contains the options used by the <see cref="RemoteAuthenticationHandler{T}"/>.
/// </summary>
public class RemoteAuthenticationOptions : AuthenticationOptions
{
@ -60,7 +60,7 @@ namespace Microsoft.AspNetCore.Builder
/// <summary>
/// Defines whether access and refresh tokens should be stored in the
/// <see cref="AuthenticationProperties"/> after a successful authorization.
/// <see cref="Http.Authentication.AuthenticationProperties"/> after a successful authorization.
/// This property is set to <c>false</c> by default to reduce
/// the size of the final authentication cookie.
/// </summary>

View File

@ -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-*",

View File

@ -13,6 +13,7 @@ namespace Microsoft.AspNetCore.Authorization
/// <summary>
/// Checks if a user meets a specific requirement for the specified resource
/// </summary>
/// <param name="service">The <see cref="IAuthorizationService"/>.</param>
/// <param name="user"></param>
/// <param name="resource"></param>
/// <param name="requirement"></param>

View File

@ -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-*",

View File

@ -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-*",

View File

@ -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")]

View File

@ -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-*",