Skip to content

Commit c809262

Browse files
committed
GhostDoc add comments to all classes
1 parent ed0e1d8 commit c809262

File tree

2 files changed

+69
-20
lines changed

2 files changed

+69
-20
lines changed

IdentityUser.cs

+62-17
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,101 @@
1-
using System;
2-
using System.Collections.Generic;
3-
using System.Linq;
4-
using System.Text;
5-
using System.Threading.Tasks;
1+
using System.Collections.Generic;
62
using Microsoft.AspNet.Identity;
73
using MongoDB.Bson;
84
using MongoDB.Bson.Serialization.Attributes;
95

6+
107
namespace MongoDB.AspNet.Identity
118
{
9+
/// <summary>
10+
/// Class IdentityUser.
11+
/// </summary>
1212
public class IdentityUser : IUser
1313
{
14+
/// <summary>
15+
/// Unique key for the user
16+
/// </summary>
17+
/// <value>The identifier.</value>
18+
/// <returns>The unique key for the user</returns>
1419
[BsonId]
1520
[BsonRepresentation(BsonType.ObjectId)]
1621
public virtual string Id { get; set; }
22+
/// <summary>
23+
/// Gets or sets the name of the user.
24+
/// </summary>
25+
/// <value>The name of the user.</value>
1726
public virtual string UserName { get; set; }
27+
/// <summary>
28+
/// Gets or sets the password hash.
29+
/// </summary>
30+
/// <value>The password hash.</value>
1831
public virtual string PasswordHash { get; set; }
32+
/// <summary>
33+
/// Gets or sets the security stamp.
34+
/// </summary>
35+
/// <value>The security stamp.</value>
1936
public virtual string SecurityStamp { get; set; }
37+
/// <summary>
38+
/// Gets the roles.
39+
/// </summary>
40+
/// <value>The roles.</value>
2041
public virtual List<string> Roles { get; private set; }
42+
/// <summary>
43+
/// Gets the claims.
44+
/// </summary>
45+
/// <value>The claims.</value>
2146
public virtual List<IdentityUserClaim> Claims { get; private set; }
47+
/// <summary>
48+
/// Gets the logins.
49+
/// </summary>
50+
/// <value>The logins.</value>
2251
public virtual List<UserLoginInfo> Logins { get; private set; }
2352

53+
/// <summary>
54+
/// Initializes a new instance of the <see cref="IdentityUser"/> class.
55+
/// </summary>
2456
public IdentityUser()
2557
{
2658
this.Claims = new List<IdentityUserClaim>();
2759
this.Roles = new List<string>();
2860
this.Logins = new List<UserLoginInfo>();
2961
}
3062

31-
public IdentityUser(string userName)
32-
: this()
63+
/// <summary>
64+
/// Initializes a new instance of the <see cref="IdentityUser"/> class.
65+
/// </summary>
66+
/// <param name="userName">Name of the user.</param>
67+
public IdentityUser(string userName) : this()
3368
{
3469
this.UserName = userName;
3570
}
3671
}
3772

38-
//public sealed class IdentityUserLogin
39-
//{
40-
// [BsonId]
41-
// [BsonRepresentation(BsonType.ObjectId)]
42-
// public string UserId { get; set; }
43-
// public string LoginProvider { get; set; }
44-
// public string ProviderKey { get; set; }
45-
//}
46-
73+
/// <summary>
74+
/// Class IdentityUserClaim.
75+
/// </summary>
4776
public class IdentityUserClaim
4877
{
78+
/// <summary>
79+
/// Gets or sets the identifier.
80+
/// </summary>
81+
/// <value>The identifier.</value>
4982
[BsonId]
5083
[BsonRepresentation(BsonType.ObjectId)]
51-
public virtual string Id { get; set; }
84+
public virtual string Id { get; set; }
85+
/// <summary>
86+
/// Gets or sets the user identifier.
87+
/// </summary>
88+
/// <value>The user identifier.</value>
5289
public virtual string UserId { get; set; }
90+
/// <summary>
91+
/// Gets or sets the type of the claim.
92+
/// </summary>
93+
/// <value>The type of the claim.</value>
5394
public virtual string ClaimType { get; set; }
95+
/// <summary>
96+
/// Gets or sets the claim value.
97+
/// </summary>
98+
/// <value>The claim value.</value>
5499
public virtual string ClaimValue { get; set; }
55100

56101
}

Utils.cs

+7-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
1-
using System;
2-
using System.Collections.Generic;
1+
using System.Collections.Generic;
32
using System.Linq;
4-
using System.Web;
53

64
namespace MongoDB.AspNet.Identity
75
{
86
internal static class Utils
97
{
8+
/// <summary>
9+
/// Converts an IEnumberable of T to a IList of T
10+
/// </summary>
11+
/// <typeparam name="T"></typeparam>
12+
/// <param name="enumerable">The enumerable.</param>
13+
/// <returns>IList{``0}.</returns>
1014
internal static IList<T> ToIList<T>(this IEnumerable<T> enumerable)
1115
{
1216
return enumerable.ToList();

0 commit comments

Comments
 (0)