Skip to content

Commit 02d157c

Browse files
authored
Fix userstore xml doc (#63750)
* Fix misleading XML doc for TKey in UserStore (#63370) * fix: update type parameter documentation for primary key in UserOnlyStore and UserStoreBase
1 parent 066a0ba commit 02d157c

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

src/Identity/EntityFrameworkCore/src/UserOnlyStore.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ public UserOnlyStore(TContext context, IdentityErrorDescriber? describer = null)
4343
/// </summary>
4444
/// <typeparam name="TUser">The type representing a user.</typeparam>
4545
/// <typeparam name="TContext">The type of the data context class used to access the store.</typeparam>
46-
/// <typeparam name="TKey">The type of the primary key for a role.</typeparam>
46+
/// <typeparam name="TKey">The type of the primary key for a user.</typeparam>
4747
public class UserOnlyStore<TUser, TContext, TKey> : UserOnlyStore<TUser, TContext, TKey, IdentityUserClaim<TKey>, IdentityUserLogin<TKey>, IdentityUserToken<TKey>>
4848
where TUser : IdentityUser<TKey>
4949
where TContext : DbContext
@@ -62,7 +62,7 @@ public UserOnlyStore(TContext context, IdentityErrorDescriber? describer = null)
6262
/// </summary>
6363
/// <typeparam name="TUser">The type representing a user.</typeparam>
6464
/// <typeparam name="TContext">The type of the data context class used to access the store.</typeparam>
65-
/// <typeparam name="TKey">The type of the primary key for a role.</typeparam>
65+
/// <typeparam name="TKey">The type of the primary key for a user.</typeparam>
6666
/// <typeparam name="TUserClaim">The type representing a claim.</typeparam>
6767
/// <typeparam name="TUserLogin">The type representing a user external login.</typeparam>
6868
/// <typeparam name="TUserToken">The type representing a user token.</typeparam>
@@ -88,7 +88,7 @@ public UserOnlyStore(TContext context, IdentityErrorDescriber? describer = null)
8888
/// </summary>
8989
/// <typeparam name="TUser">The type representing a user.</typeparam>
9090
/// <typeparam name="TContext">The type of the data context class used to access the store.</typeparam>
91-
/// <typeparam name="TKey">The type of the primary key for a role.</typeparam>
91+
/// <typeparam name="TKey">The type of the primary key for a user.</typeparam>
9292
/// <typeparam name="TUserClaim">The type representing a claim.</typeparam>
9393
/// <typeparam name="TUserLogin">The type representing a user external login.</typeparam>
9494
/// <typeparam name="TUserToken">The type representing a user token.</typeparam>

src/Identity/EntityFrameworkCore/src/UserStore.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public UserStore(TContext context, IdentityErrorDescriber? describer = null) : b
6363
/// <typeparam name="TUser">The type representing a user.</typeparam>
6464
/// <typeparam name="TRole">The type representing a role.</typeparam>
6565
/// <typeparam name="TContext">The type of the data context class used to access the store.</typeparam>
66-
/// <typeparam name="TKey">The type of the primary key for a role.</typeparam>
66+
/// <typeparam name="TKey">The type of the primary key for the user and role entities.</typeparam>
6767
public class UserStore<TUser, TRole, TContext, TKey> : UserStore<TUser, TRole, TContext, TKey, IdentityUserClaim<TKey>, IdentityUserRole<TKey>, IdentityUserLogin<TKey>, IdentityUserToken<TKey>, IdentityRoleClaim<TKey>>
6868
where TUser : IdentityUser<TKey>
6969
where TRole : IdentityRole<TKey>
@@ -84,7 +84,7 @@ public UserStore(TContext context, IdentityErrorDescriber? describer = null) : b
8484
/// <typeparam name="TUser">The type representing a user.</typeparam>
8585
/// <typeparam name="TRole">The type representing a role.</typeparam>
8686
/// <typeparam name="TContext">The type of the data context class used to access the store.</typeparam>
87-
/// <typeparam name="TKey">The type of the primary key for a role.</typeparam>
87+
/// <typeparam name="TKey">The type of the primary key for the user and role entities.</typeparam>
8888
/// <typeparam name="TUserClaim">The type representing a claim.</typeparam>
8989
/// <typeparam name="TUserRole">The type representing a user role.</typeparam>
9090
/// <typeparam name="TUserLogin">The type representing a user external login.</typeparam>
@@ -116,7 +116,7 @@ public UserStore(TContext context, IdentityErrorDescriber? describer = null) : b
116116
/// <typeparam name="TUser">The type representing a user.</typeparam>
117117
/// <typeparam name="TRole">The type representing a role.</typeparam>
118118
/// <typeparam name="TContext">The type of the data context class used to access the store.</typeparam>
119-
/// <typeparam name="TKey">The type of the primary key for a role.</typeparam>
119+
/// <typeparam name="TKey">The type of the primary key for the user and role entities.</typeparam>
120120
/// <typeparam name="TUserClaim">The type representing a claim.</typeparam>
121121
/// <typeparam name="TUserRole">The type representing a user role.</typeparam>
122122
/// <typeparam name="TUserLogin">The type representing a user external login.</typeparam>

src/Identity/Extensions.Stores/src/UserStoreBase.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -988,7 +988,7 @@ public virtual async Task<bool> RedeemCodeAsync(TUser user, string code, Cancell
988988
/// </summary>
989989
/// <typeparam name="TUser">The type representing a user.</typeparam>
990990
/// <typeparam name="TRole">The type representing a role.</typeparam>
991-
/// <typeparam name="TKey">The type of the primary key for a role.</typeparam>
991+
/// <typeparam name="TKey">The type of the primary key for a user.</typeparam>
992992
/// <typeparam name="TUserClaim">The type representing a claim.</typeparam>
993993
/// <typeparam name="TUserRole">The type representing a user role.</typeparam>
994994
/// <typeparam name="TUserLogin">The type representing a user external login.</typeparam>

0 commit comments

Comments
 (0)