diff --git a/NuGetPackageVerifier.json b/NuGetPackageVerifier.json index 2ca5390939..b0b3e76a14 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.Identity": { }, @@ -15,12 +10,7 @@ }, "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.Identity.EntityFrameworkCore/RoleStore.cs b/src/Microsoft.AspNetCore.Identity.EntityFrameworkCore/RoleStore.cs index 76fa08a2c7..66176bc663 100644 --- a/src/Microsoft.AspNetCore.Identity.EntityFrameworkCore/RoleStore.cs +++ b/src/Microsoft.AspNetCore.Identity.EntityFrameworkCore/RoleStore.cs @@ -246,7 +246,7 @@ namespace Microsoft.AspNetCore.Identity.EntityFrameworkCore /// /// Finds the role who has the specified ID as an asynchronous operation. /// - /// The role ID to look for. + /// The role ID to look for. /// The used to propagate notifications that the operation should be canceled. /// A that result of the look up. public virtual Task FindByIdAsync(string id, CancellationToken cancellationToken = default(CancellationToken)) @@ -260,7 +260,7 @@ namespace Microsoft.AspNetCore.Identity.EntityFrameworkCore /// /// Finds the role who has the specified normalized name as an asynchronous operation. /// - /// The normalized role name to look for. + /// The normalized role name to look for. /// The used to propagate notifications that the operation should be canceled. /// A that result of the look up. public virtual Task FindByNameAsync(string normalizedName, CancellationToken cancellationToken = default(CancellationToken)) diff --git a/src/Microsoft.AspNetCore.Identity.EntityFrameworkCore/UserStore.cs b/src/Microsoft.AspNetCore.Identity.EntityFrameworkCore/UserStore.cs index 8d01f2131c..2dbd35c2c7 100644 --- a/src/Microsoft.AspNetCore.Identity.EntityFrameworkCore/UserStore.cs +++ b/src/Microsoft.AspNetCore.Identity.EntityFrameworkCore/UserStore.cs @@ -283,7 +283,7 @@ namespace Microsoft.AspNetCore.Identity.EntityFrameworkCore /// The user ID to search for. /// The used to propagate notifications that the operation should be canceled. /// - /// The that represents the asynchronous operation, containing the user matching the specified if it exists. + /// The that represents the asynchronous operation, containing the user matching the specified if it exists. /// public virtual Task FindByIdAsync(string userId, CancellationToken cancellationToken = default(CancellationToken)) { @@ -327,7 +327,7 @@ namespace Microsoft.AspNetCore.Identity.EntityFrameworkCore /// The normalized user name to search for. /// The used to propagate notifications that the operation should be canceled. /// - /// The that represents the asynchronous operation, containing the user matching the specified if it exists. + /// The that represents the asynchronous operation, containing the user matching the specified if it exists. /// public virtual Task FindByNameAsync(string normalizedUserName, CancellationToken cancellationToken = default(CancellationToken)) { @@ -542,10 +542,10 @@ namespace Microsoft.AspNetCore.Identity.EntityFrameworkCore } /// - /// Adds the given to the specified . + /// Adds the given to the specified . /// - /// The user to add the claim to. - /// The claim to add to the user. + /// The user to add the claim to. + /// The claim to add to the user. /// The used to propagate notifications that the operation should be canceled. /// The that represents the asynchronous operation. public virtual Task AddClaimsAsync(TUser user, IEnumerable claims, CancellationToken cancellationToken = default(CancellationToken)) @@ -627,7 +627,7 @@ namespace Microsoft.AspNetCore.Identity.EntityFrameworkCore } /// - /// Adds the given to the specified . + /// Adds the given to the specified . /// /// The user to add the login to. /// The login to add to the user. @@ -659,10 +659,11 @@ namespace Microsoft.AspNetCore.Identity.EntityFrameworkCore } /// - /// Removes the given from the specified . + /// Removes the given from the specified . /// /// The user to remove the login from. - /// The login to remove from the user. + /// The login to remove from the user. + /// The key provided by the to identify a user. /// The used to propagate notifications that the operation should be canceled. /// The that represents the asynchronous operation. public virtual async Task RemoveLoginAsync(TUser user, string loginProvider, string providerKey, diff --git a/src/Microsoft.AspNetCore.Identity.EntityFrameworkCore/project.json b/src/Microsoft.AspNetCore.Identity.EntityFrameworkCore/project.json index daace864a9..4d57794db5 100644 --- a/src/Microsoft.AspNetCore.Identity.EntityFrameworkCore/project.json +++ b/src/Microsoft.AspNetCore.Identity.EntityFrameworkCore/project.json @@ -3,7 +3,9 @@ "version": "1.0.0-*", "compilationOptions": { "warningsAsErrors": true, - "keyFile": "../../tools/Key.snk" + "keyFile": "../../tools/Key.snk", + "nowarn": [ "CS1591" ], + "xmlDoc": true }, "repository": { "type": "git", diff --git a/src/Microsoft.AspNetCore.Identity/DataProtectionTokenProvider.cs b/src/Microsoft.AspNetCore.Identity/DataProtectionTokenProvider.cs index ae9909580d..e7c7054ade 100644 --- a/src/Microsoft.AspNetCore.Identity/DataProtectionTokenProvider.cs +++ b/src/Microsoft.AspNetCore.Identity/DataProtectionTokenProvider.cs @@ -62,7 +62,7 @@ namespace Microsoft.AspNetCore.Identity /// /// The purpose the token will be used for. /// The to retrieve user properties from. - /// The the token will be generated from. + /// The the token will be generated from. /// A representing the generated token. public virtual async Task GenerateAsync(string purpose, UserManager manager, TUser user) { @@ -94,7 +94,7 @@ namespace Microsoft.AspNetCore.Identity /// The purpose the token was be used for. /// The token to validate. /// The to retrieve user properties from. - /// The the token was generated for. + /// The the token was generated for. /// /// A that represents the result of the asynchronous validation, /// containing true if the token is valid, otherwise false. @@ -147,11 +147,11 @@ namespace Microsoft.AspNetCore.Identity } /// - /// Returns a indicating whether a token generated by this instance + /// Returns a indicating whether a token generated by this instance /// can be used as a Two Factor Authentication token as an asynchronous operation. /// /// The to retrieve user properties from. - /// The the token was generated for. + /// The the token was generated for. /// /// A that represents the result of the asynchronous query, /// containing true if a token generated by this instance can be used as a Two Factor Authentication token, otherwise false. @@ -167,7 +167,7 @@ namespace Microsoft.AspNetCore.Identity /// /// The token to generate notifications for. /// The to retrieve user properties from. - /// The the token was generated for. + /// The the token was generated for. /// A that represents the asynchronous notification. public virtual Task NotifyAsync(string token, UserManager manager, TUser user) { diff --git a/src/Microsoft.AspNetCore.Identity/EmailTokenProvider.cs b/src/Microsoft.AspNetCore.Identity/EmailTokenProvider.cs index ccecea07b3..a6ee043876 100644 --- a/src/Microsoft.AspNetCore.Identity/EmailTokenProvider.cs +++ b/src/Microsoft.AspNetCore.Identity/EmailTokenProvider.cs @@ -13,7 +13,7 @@ namespace Microsoft.AspNetCore.Identity /// Checks if a two factor authentication token can be generated for the specified . /// /// The to retrieve the from. - /// The to check for the possibility of generating a two factor authentication token. + /// The to check for the possibility of generating a two factor authentication token. /// True if the user has an email address set, otherwise false. public override async Task CanGenerateTwoFactorTokenAsync(UserManager manager, TUser user) { @@ -26,7 +26,7 @@ namespace Microsoft.AspNetCore.Identity /// /// The purpose of the two factor authentication token. /// The to retrieve the from. - /// The to check for the possibility of generating a two factor authentication token. + /// The to check for the possibility of generating a two factor authentication token. /// A string suitable for use as entropy in token generation. public override async Task GetUserModifierAsync(string purpose, UserManager manager, TUser user) diff --git a/src/Microsoft.AspNetCore.Identity/ISecurityStampValidator.cs b/src/Microsoft.AspNetCore.Identity/ISecurityStampValidator.cs index 0530ca650a..f24b76a6ee 100644 --- a/src/Microsoft.AspNetCore.Identity/ISecurityStampValidator.cs +++ b/src/Microsoft.AspNetCore.Identity/ISecurityStampValidator.cs @@ -16,7 +16,8 @@ namespace Microsoft.AspNetCore.Identity /// Validates a security stamp of an identity as an asynchronous operation, and rebuilds the identity if the validation succeeds, otherwise rejects /// the identity. /// - /// The context containing the and to validate. + /// The context containing the + /// and to validate. /// The that represents the asynchronous validation operation. Task ValidateAsync(CookieValidatePrincipalContext context); } diff --git a/src/Microsoft.AspNetCore.Identity/IUserClaimsPrincipalFactory.cs b/src/Microsoft.AspNetCore.Identity/IUserClaimsPrincipalFactory.cs index 68b9e0b5bc..20a766ff24 100644 --- a/src/Microsoft.AspNetCore.Identity/IUserClaimsPrincipalFactory.cs +++ b/src/Microsoft.AspNetCore.Identity/IUserClaimsPrincipalFactory.cs @@ -9,7 +9,7 @@ namespace Microsoft.AspNetCore.Identity /// /// Provides an abstraction for a factory to create a from a user. /// - /// The type encapsulating a user. + /// The type encapsulating a user. public interface IUserClaimsPrincipalFactory where TUser : class { @@ -17,7 +17,6 @@ namespace Microsoft.AspNetCore.Identity /// Creates a from an user asynchronously. /// /// The user to create a from. - /// The name of the authentication method the was sourced from. /// The that represents the asynchronous creation operation, containing the created . Task CreateAsync(TUser user); } diff --git a/src/Microsoft.AspNetCore.Identity/IUserRoleStore.cs b/src/Microsoft.AspNetCore.Identity/IUserRoleStore.cs index 6b9c3ea090..d8c5725385 100644 --- a/src/Microsoft.AspNetCore.Identity/IUserRoleStore.cs +++ b/src/Microsoft.AspNetCore.Identity/IUserRoleStore.cs @@ -46,7 +46,7 @@ namespace Microsoft.AspNetCore.Identity /// The name of the role to be checked. /// The used to propagate notifications that the operation should be canceled. /// - /// The that represents the asynchronous operation, containing a flag indicating whether the specified is + /// The that represents the asynchronous operation, containing a flag indicating whether the specified is /// a member of the named role. /// Task IsInRoleAsync(TUser user, string roleName, CancellationToken cancellationToken); diff --git a/src/Microsoft.AspNetCore.Identity/IUserStore.cs b/src/Microsoft.AspNetCore.Identity/IUserStore.cs index 8b304426ef..bbf1af3dcb 100644 --- a/src/Microsoft.AspNetCore.Identity/IUserStore.cs +++ b/src/Microsoft.AspNetCore.Identity/IUserStore.cs @@ -85,7 +85,7 @@ namespace Microsoft.AspNetCore.Identity /// The user ID to search for. /// The used to propagate notifications that the operation should be canceled. /// - /// The that represents the asynchronous operation, containing the user matching the specified if it exists. + /// The that represents the asynchronous operation, containing the user matching the specified if it exists. /// Task FindByIdAsync(string userId, CancellationToken cancellationToken); @@ -95,7 +95,7 @@ namespace Microsoft.AspNetCore.Identity /// The normalized user name to search for. /// The used to propagate notifications that the operation should be canceled. /// - /// The that represents the asynchronous operation, containing the user matching the specified if it exists. + /// The that represents the asynchronous operation, containing the user matching the specified if it exists. /// Task FindByNameAsync(string normalizedUserName, CancellationToken cancellationToken); } diff --git a/src/Microsoft.AspNetCore.Identity/IUserTokenProvider.cs b/src/Microsoft.AspNetCore.Identity/IUserTokenProvider.cs index c3170e25d0..4349034c98 100644 --- a/src/Microsoft.AspNetCore.Identity/IUserTokenProvider.cs +++ b/src/Microsoft.AspNetCore.Identity/IUserTokenProvider.cs @@ -12,7 +12,7 @@ namespace Microsoft.AspNetCore.Identity public interface IUserTokenProvider where TUser : class { /// - /// Generates a token for the specified and . + /// Generates a token for the specified and . /// /// The purpose the token will be used for. /// The that can be used to retrieve user properties. @@ -49,13 +49,13 @@ namespace Microsoft.AspNetCore.Identity /// /// Returns a flag indicating whether the token provider can generate a token suitable for two factor authentication token for - /// the specified . + /// the specified . /// /// The that can be used to retrieve user properties. /// The user a token could be generated for. /// /// The that represents the asynchronous operation, containing the a flag indicating if a two - /// factor token could be generated by this provider for the specified and . + /// factor token could be generated by this provider for the specified . /// The task will return true if a two factor authentication token could be generated, otherwise false. /// Task CanGenerateTwoFactorTokenAsync(UserManager manager, TUser user); diff --git a/src/Microsoft.AspNetCore.Identity/IdentityBuilder.cs b/src/Microsoft.AspNetCore.Identity/IdentityBuilder.cs index 8227da0037..52dc6d0a5c 100644 --- a/src/Microsoft.AspNetCore.Identity/IdentityBuilder.cs +++ b/src/Microsoft.AspNetCore.Identity/IdentityBuilder.cs @@ -58,7 +58,7 @@ namespace Microsoft.AspNetCore.Identity } /// - /// Adds an for the . + /// Adds an for the . /// /// The user type to validate. /// The current instance. @@ -80,7 +80,7 @@ namespace Microsoft.AspNetCore.Identity /// /// Adds an . /// - /// The type of the error describer. + /// The type of the error describer. /// The current instance. public virtual IdentityBuilder AddErrorDescriber() where TDescriber : IdentityErrorDescriber { diff --git a/src/Microsoft.AspNetCore.Identity/IdentityErrorDescriber.cs b/src/Microsoft.AspNetCore.Identity/IdentityErrorDescriber.cs index 5335a155df..54c024c79e 100644 --- a/src/Microsoft.AspNetCore.Identity/IdentityErrorDescriber.cs +++ b/src/Microsoft.AspNetCore.Identity/IdentityErrorDescriber.cs @@ -231,7 +231,6 @@ namespace Microsoft.AspNetCore.Identity /// /// Returns an indicating a password entered does not contain a non-alphanumeric character, which is required by the password policy. /// - /// The length that is not long enough. /// An indicating a password entered does not contain a non-alphanumeric character. public virtual IdentityError PasswordRequiresNonAlphanumeric() { @@ -245,7 +244,6 @@ namespace Microsoft.AspNetCore.Identity /// /// Returns an indicating a password entered does not contain a numeric character, which is required by the password policy. /// - /// The length that is not long enough. /// An indicating a password entered does not contain a numeric character. public virtual IdentityError PasswordRequiresDigit() { @@ -259,7 +257,6 @@ namespace Microsoft.AspNetCore.Identity /// /// Returns an indicating a password entered does not contain a lower case letter, which is required by the password policy. /// - /// The length that is not long enough. /// An indicating a password entered does not contain a lower case letter. public virtual IdentityError PasswordRequiresLower() { @@ -273,7 +270,6 @@ namespace Microsoft.AspNetCore.Identity /// /// Returns an indicating a password entered does not contain an upper case letter, which is required by the password policy. /// - /// The length that is not long enough. /// An indicating a password entered does not contain an upper case letter. public virtual IdentityError PasswordRequiresUpper() { diff --git a/src/Microsoft.AspNetCore.Identity/PasswordHasher.cs b/src/Microsoft.AspNetCore.Identity/PasswordHasher.cs index e234aff624..a3ab3ba6ad 100644 --- a/src/Microsoft.AspNetCore.Identity/PasswordHasher.cs +++ b/src/Microsoft.AspNetCore.Identity/PasswordHasher.cs @@ -37,7 +37,7 @@ namespace Microsoft.AspNetCore.Identity /// /// Creates a new instance of . /// - /// The options for this instance. + /// The options for this instance. public PasswordHasher(IOptions optionsAccessor = null) { var options = optionsAccessor?.Value ?? new PasswordHasherOptions(); diff --git a/src/Microsoft.AspNetCore.Identity/PhoneNumberTokenProvider.cs b/src/Microsoft.AspNetCore.Identity/PhoneNumberTokenProvider.cs index 123b54ba08..b3c497f867 100644 --- a/src/Microsoft.AspNetCore.Identity/PhoneNumberTokenProvider.cs +++ b/src/Microsoft.AspNetCore.Identity/PhoneNumberTokenProvider.cs @@ -13,13 +13,13 @@ namespace Microsoft.AspNetCore.Identity { /// /// Returns a flag indicating whether the token provider can generate a token suitable for two factor authentication token for - /// the specified . + /// the specified . /// /// The that can be used to retrieve user properties. /// The user a token could be generated for. /// /// The that represents the asynchronous operation, containing the a flag indicating if a two - /// factor token could be generated by this provider for the specified and . + /// factor token could be generated by this provider for the specified . /// The task will return true if a two factor authentication token could be generated as the user has /// a telephone number, otherwise false. /// diff --git a/src/Microsoft.AspNetCore.Identity/RoleManager.cs b/src/Microsoft.AspNetCore.Identity/RoleManager.cs index 430e0d4f29..8dd42b45a3 100644 --- a/src/Microsoft.AspNetCore.Identity/RoleManager.cs +++ b/src/Microsoft.AspNetCore.Identity/RoleManager.cs @@ -94,11 +94,11 @@ namespace Microsoft.AspNetCore.Identity internal ILookupNormalizer KeyNormalizer { get; set; } /// - /// Gets an IQueryable collection of Roles if the persistence store is an , + /// Gets an IQueryable collection of Roles if the persistence store is an , /// otherwise throws a . /// - /// An IQueryable collection of Roles if the persistence store is an . - /// Thrown if the persistence store is not an . + /// An IQueryable collection of Roles if the persistence store is an . + /// Thrown if the persistence store is not an . /// /// Callers to this property should use to ensure the backing role store supports /// returning an IQueryable list of roles. diff --git a/src/Microsoft.AspNetCore.Identity/SecurityStampValidator.cs b/src/Microsoft.AspNetCore.Identity/SecurityStampValidator.cs index 09004450f6..314bc64de3 100644 --- a/src/Microsoft.AspNetCore.Identity/SecurityStampValidator.cs +++ b/src/Microsoft.AspNetCore.Identity/SecurityStampValidator.cs @@ -37,7 +37,8 @@ namespace Microsoft.AspNetCore.Identity /// Validates a security stamp of an identity as an asynchronous operation, and rebuilds the identity if the validation succeeds, otherwise rejects /// the identity. /// - /// The context containing the and to validate. + /// The context containing the + /// and to validate. /// The that represents the asynchronous validation operation. public virtual async Task ValidateAsync(CookieValidatePrincipalContext context) { @@ -83,7 +84,8 @@ namespace Microsoft.AspNetCore.Identity /// Validates a principal against a user's stored security stamp. /// the identity. /// - /// The context containing the and to validate. + /// The context containing the + /// and to validate. /// The that represents the asynchronous validation operation. public static Task ValidatePrincipalAsync(CookieValidatePrincipalContext context) { diff --git a/src/Microsoft.AspNetCore.Identity/SignInManager.cs b/src/Microsoft.AspNetCore.Identity/SignInManager.cs index fb9e65f23c..39bc20ccc3 100644 --- a/src/Microsoft.AspNetCore.Identity/SignInManager.cs +++ b/src/Microsoft.AspNetCore.Identity/SignInManager.cs @@ -193,10 +193,9 @@ namespace Microsoft.AspNetCore.Identity /// /// Validates the security stamp for the specified against - /// the persisted stamp for the , as an asynchronous operation. + /// the persisted stamp for the current user, as an asynchronous operation. /// /// The principal whose stamp should be validated. - /// The ID for the user. /// The task object representing the asynchronous operation. The task will contain the /// if the stamp matches the persisted value, otherwise it will return false. public virtual async Task ValidateSecurityStampAsync(ClaimsPrincipal principal) @@ -271,7 +270,7 @@ namespace Microsoft.AspNetCore.Identity /// The user name to sign in. /// The password to attempt to sign in with. /// Flag indicating whether the sign-in cookie should persist after the browser is closed. - /// Flag indicating if the user account should be locked if the sign in fails. + /// Flag indicating if the user account should be locked if the sign in fails. /// The task object representing the asynchronous operation containing the /// for the sign-in attempt. public virtual async Task PasswordSignInAsync(string userName, string password, diff --git a/src/Microsoft.AspNetCore.Identity/TotpSecurityStampBasedTokenProvider.cs b/src/Microsoft.AspNetCore.Identity/TotpSecurityStampBasedTokenProvider.cs index a0c2a38313..3253c45f66 100644 --- a/src/Microsoft.AspNetCore.Identity/TotpSecurityStampBasedTokenProvider.cs +++ b/src/Microsoft.AspNetCore.Identity/TotpSecurityStampBasedTokenProvider.cs @@ -13,7 +13,7 @@ namespace Microsoft.AspNetCore.Identity where TUser : class { /// - /// Generates a token for the specified and . + /// Generates a token for the specified and . /// /// The purpose the token will be used for. /// The that can be used to retrieve user properties. @@ -93,13 +93,13 @@ namespace Microsoft.AspNetCore.Identity /// /// Returns a flag indicating whether the token provider can generate a token suitable for two factor authentication token for - /// the specified . + /// the specified . /// /// The that can be used to retrieve user properties. /// The user a token could be generated for. /// /// The that represents the asynchronous operation, containing the a flag indicating if a two - /// factor token could be generated by this provider for the specified and . + /// factor token could be generated by this provider for the specified . /// The task will return true if a two factor authentication token could be generated, otherwise false. /// public abstract Task CanGenerateTwoFactorTokenAsync(UserManager manager, TUser user); diff --git a/src/Microsoft.AspNetCore.Identity/UserClaimsPrincipalFactory.cs b/src/Microsoft.AspNetCore.Identity/UserClaimsPrincipalFactory.cs index bb90eb617f..a60f61dc55 100644 --- a/src/Microsoft.AspNetCore.Identity/UserClaimsPrincipalFactory.cs +++ b/src/Microsoft.AspNetCore.Identity/UserClaimsPrincipalFactory.cs @@ -19,7 +19,7 @@ namespace Microsoft.AspNetCore.Identity where TRole : class { /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// /// The to retrieve user information from. /// The to retrieve a user's roles from. @@ -74,7 +74,6 @@ namespace Microsoft.AspNetCore.Identity /// Creates a from an user asynchronously. /// /// The user to create a from. - /// The name of the authentication method the was sourced from. /// The that represents the asynchronous creation operation, containing the created . public virtual async Task CreateAsync(TUser user) { diff --git a/src/Microsoft.AspNetCore.Identity/UserManager.cs b/src/Microsoft.AspNetCore.Identity/UserManager.cs index acd61b2b21..bc561f5a5d 100644 --- a/src/Microsoft.AspNetCore.Identity/UserManager.cs +++ b/src/Microsoft.AspNetCore.Identity/UserManager.cs @@ -44,9 +44,8 @@ namespace Microsoft.AspNetCore.Identity /// A collection of to validate passwords against. /// The to use when generating index keys for users. /// The used to provider error messages. - /// + /// The used to resolve services. /// The logger used to log messages, warnings and errors. - /// The accessor used to access the . public UserManager(IUserStore store, IOptions optionsAccessor, IPasswordHasher passwordHasher, @@ -423,9 +422,8 @@ namespace Microsoft.AspNetCore.Identity /// Finds and returns a user, if any, who has the specified . /// /// The user ID to search for. - /// The used to propagate notifications that the operation should be canceled. /// - /// The that represents the asynchronous operation, containing the user matching the specified if it exists. + /// The that represents the asynchronous operation, containing the user matching the specified if it exists. /// public virtual Task FindByIdAsync(string userId) { @@ -437,9 +435,8 @@ namespace Microsoft.AspNetCore.Identity /// Finds and returns a user, if any, who has the specified user name. /// /// The user name to search for. - /// The used to propagate notifications that the operation should be canceled. /// - /// The that represents the asynchronous operation, containing the user matching the specified if it exists. + /// The that represents the asynchronous operation, containing the user matching the specified if it exists. /// public virtual Task FindByNameAsync(string userName) { @@ -959,7 +956,6 @@ namespace Microsoft.AspNetCore.Identity /// The user to replace the claim on. /// The claim to replace. /// The new claim to replace the existing with. - /// The used to propagate notifications that the operation should be canceled. /// /// The that represents the asynchronous operation, containing the /// of the operation. @@ -988,7 +984,7 @@ namespace Microsoft.AspNetCore.Identity /// /// Removes the specified from the given . /// - /// The user to remove the specified from. + /// The user to remove the specified from. /// The to remove. /// /// The that represents the asynchronous operation, containing the @@ -1057,7 +1053,7 @@ namespace Microsoft.AspNetCore.Identity /// Add the specified to the named role. /// /// The user to add to the named role. - /// The name of the role to add the user to. + /// The name of the role to add the user to. /// /// The that represents the asynchronous operation, containing the /// of the operation. @@ -1084,7 +1080,7 @@ namespace Microsoft.AspNetCore.Identity /// Add the specified to the named roles. /// /// The user to add to the named roles. - /// The name of the roles to add the user to. + /// The name of the roles to add the user to. /// /// The that represents the asynchronous operation, containing the /// of the operation. @@ -1118,7 +1114,7 @@ namespace Microsoft.AspNetCore.Identity /// Removes the specified from the named role. /// /// The user to remove from the named role. - /// The name of the role to remove the user from. + /// The name of the role to remove the user from. /// /// The that represents the asynchronous operation, containing the /// of the operation. @@ -1157,7 +1153,7 @@ namespace Microsoft.AspNetCore.Identity /// Removes the specified from the named roles. /// /// The user to remove from the named roles. - /// The name of the roles to remove the user from. + /// The name of the roles to remove the user from. /// /// The that represents the asynchronous operation, containing the /// of the operation. @@ -1209,7 +1205,7 @@ namespace Microsoft.AspNetCore.Identity /// The user whose role membership should be checked. /// The name of the role to be checked. /// - /// The that represents the asynchronous operation, containing a flag indicating whether the specified is + /// The that represents the asynchronous operation, containing a flag indicating whether the specified is /// a member of the named role. /// public virtual async Task IsInRoleAsync(TUser user, string role) @@ -1227,7 +1223,6 @@ namespace Microsoft.AspNetCore.Identity /// Gets the email address for the specified . /// /// The user whose email should be returned. - /// The used to propagate notifications that the operation should be canceled. /// The task object containing the results of the asynchronous operation, the email address for the specified . public virtual async Task GetEmailAsync(TUser user) { @@ -1267,8 +1262,7 @@ namespace Microsoft.AspNetCore.Identity /// /// Gets the user, if any, associated with the specified, normalized email address. /// - /// The normalized email address to return the user for. - /// The used to propagate notifications that the operation should be canceled. + /// The normalized email address to return the user for. /// /// The task object containing the results of the asynchronous lookup operation, the user if any associated with the specified normalized email address. /// @@ -1361,6 +1355,7 @@ namespace Microsoft.AspNetCore.Identity /// Generates an email change token for the specified user. /// /// The user to generate an email change token for. + /// The new email address. /// /// The that represents the asynchronous operation, an email change token. /// @@ -1725,6 +1720,7 @@ namespace Microsoft.AspNetCore.Identity /// as an asynchronous operation. /// /// The user whose two factor authentication enabled status should be set. + /// A flag indicating whether the specified has two factor authentication enabled. /// /// The that represents the asynchronous operation, the of the operation /// diff --git a/src/Microsoft.AspNetCore.Identity/UserValidator.cs b/src/Microsoft.AspNetCore.Identity/UserValidator.cs index 65d57ba022..af870f2462 100644 --- a/src/Microsoft.AspNetCore.Identity/UserValidator.cs +++ b/src/Microsoft.AspNetCore.Identity/UserValidator.cs @@ -16,7 +16,7 @@ namespace Microsoft.AspNetCore.Identity /// /// Provides validation services for user classes. /// - /// The type encapsulating a user. + /// The type encapsulating a user. public class UserValidator : IUserValidator where TUser : class { /// diff --git a/src/Microsoft.AspNetCore.Identity/project.json b/src/Microsoft.AspNetCore.Identity/project.json index ed9eab5802..e5fc27d884 100644 --- a/src/Microsoft.AspNetCore.Identity/project.json +++ b/src/Microsoft.AspNetCore.Identity/project.json @@ -3,7 +3,9 @@ "version": "1.0.0-*", "compilationOptions": { "warningsAsErrors": true, - "keyFile": "../../tools/Key.snk" + "keyFile": "../../tools/Key.snk", + "nowarn": [ "CS1591" ], + "xmlDoc": true }, "repository": { "type": "git",