From e76d1c280964af429e61181c0ab75f337da21e1c Mon Sep 17 00:00:00 2001
From: Barry Dorrans <bdorrans@microsoft.com>
Date: Wed, 7 Jan 2015 12:28:35 -0800
Subject: [PATCH] XMLDoc updates.

---
 .../BuilderExtensions.cs                      |  1 +
 .../ClaimsIdentityFactory.cs                  | 49 +++++++++++++++----
 .../ClaimsIdentityOptions.cs                  | 26 ++++++++--
 3 files changed, 62 insertions(+), 14 deletions(-)

diff --git a/src/Microsoft.AspNet.Identity/BuilderExtensions.cs b/src/Microsoft.AspNet.Identity/BuilderExtensions.cs
index 13b2df4b91..d4d184e759 100644
--- a/src/Microsoft.AspNet.Identity/BuilderExtensions.cs
+++ b/src/Microsoft.AspNet.Identity/BuilderExtensions.cs
@@ -2,6 +2,7 @@
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
+
 using Microsoft.AspNet.Identity;
 
 namespace Microsoft.AspNet.Builder
diff --git a/src/Microsoft.AspNet.Identity/ClaimsIdentityFactory.cs b/src/Microsoft.AspNet.Identity/ClaimsIdentityFactory.cs
index 9fc5cb760f..bda8839ac8 100644
--- a/src/Microsoft.AspNet.Identity/ClaimsIdentityFactory.cs
+++ b/src/Microsoft.AspNet.Identity/ClaimsIdentityFactory.cs
@@ -5,19 +5,29 @@ using System;
 using System.Security.Claims;
 using System.Threading;
 using System.Threading.Tasks;
+
 using Microsoft.Framework.OptionsModel;
 
 namespace Microsoft.AspNet.Identity
 {
     /// <summary>
-    ///     Creates a ClaimsIdentity from a User
+    /// Provides methods to create a claims identity for a given user.
     /// </summary>
-    /// <typeparam name="TUser"></typeparam>
+    /// <typeparam name="TUser">The type used to represent a user.</typeparam>
+    /// <typeparam name="TRole">The type used to represent a role.</typeparam>
     public class ClaimsIdentityFactory<TUser, TRole> : IClaimsIdentityFactory<TUser>
         where TUser : class
         where TRole : class
     {
-        public ClaimsIdentityFactory(UserManager<TUser> userManager, RoleManager<TRole> roleManager, 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ClaimsIdentityFactory"/> class.
+        /// </summary>
+        /// <param name="userManager">The <see cref="UserManager{TUser}"/> to retrieve user information from.</param>
+        /// <param name="roleManager">The <see cref="RoleManager{TRole}"/> to retrieve a user's roles from.</param>
+        /// <param name="optionsAccessor">The configured <see cref="IdentityOptions"/>.</param>
+        public ClaimsIdentityFactory(
+            UserManager<TUser> userManager, 
+            RoleManager<TRole> roleManager, 
             IOptions<IdentityOptions> optionsAccessor)
         {
             if (userManager == null)
@@ -37,19 +47,38 @@ namespace Microsoft.AspNet.Identity
             Options = optionsAccessor.Options;
         }
 
+        /// <summary>
+        /// Gets the <see cref="UserManager{TUser}"/> for this factory.
+        /// </summary>
+        /// <value>
+        /// The current <see cref="UserManager{TUser}"/> for this factory instance.
+        /// </value>
         public UserManager<TUser> UserManager { get; private set; }
+
+        /// <summary>
+        /// Gets the <see cref="RoleManager{TRole}"/> for this factory.
+        /// </summary>
+        /// <value>
+        /// The current <see cref="RoleManager{TRole}"/> for this factory instance.
+        /// </value>
         public RoleManager<TRole> RoleManager { get; private set; }
+
+        /// <summary>
+        /// Gets the <see cref="IdentityOptions"/> for this factory.
+        /// </summary>
+        /// <value>
+        /// The current <see cref="IdentityOptions"/> for this factory instance.
+        /// </value>
         public IdentityOptions Options { get; private set; }
 
         /// <summary>
-        ///     CreateAsync a ClaimsIdentity from a user
+        /// Creates a populated <see cref="ClaimsIdentity"/> for the specified <paramref name="user"/>.
         /// </summary>
-        /// <param name="manager"></param>
-        /// <param name="user"></param>
-        /// <param name="authenticationType"></param>
-        /// <param name="cancellationToken"></param>
-        /// <returns></returns>
-        public virtual async Task<ClaimsIdentity> CreateAsync(TUser user,
+        /// <param name="user">The user instance to create claims on.</param>
+        /// <param name="cancellationToken">A <see cref="CancellationToken"/> to observe while waiting for the tasks to complete.</param>
+        /// <returns>A <see cref="Task{TResult}"/> that represents the started task.</returns>
+        public virtual async Task<ClaimsIdentity> CreateAsync(
+            TUser user,
             CancellationToken cancellationToken = default(CancellationToken))
         {
             if (user == null)
diff --git a/src/Microsoft.AspNet.Identity/ClaimsIdentityOptions.cs b/src/Microsoft.AspNet.Identity/ClaimsIdentityOptions.cs
index 9b8dd3c24f..be0df88958 100644
--- a/src/Microsoft.AspNet.Identity/ClaimsIdentityOptions.cs
+++ b/src/Microsoft.AspNet.Identity/ClaimsIdentityOptions.cs
@@ -5,28 +5,46 @@ using System.Security.Claims;
 
 namespace Microsoft.AspNet.Identity
 {
+    /// <summary>
+    /// Options for ClaimType names.
+    /// </summary>
     public class ClaimsIdentityOptions
     {
+        /// <summary>
+        /// The ClaimType used for the identity security stamp.
+        /// </summary>
         public static readonly string DefaultSecurityStampClaimType = "AspNet.Identity.SecurityStamp";
 
         /// <summary>
-        ///     Claim type used for role claims
+        /// Gets the ClaimType used for a Role claim.
         /// </summary>
+        /// <remarks>
+        /// This defaults to <see cref="ClaimTypes.Role"/>.
+        /// </remarks>
         public string RoleClaimType { get; set; } = ClaimTypes.Role;
 
         /// <summary>
-        ///     Claim type used for the user name
+        /// Gets the ClaimType used for the user name claim.
         /// </summary>
+        /// <remarks>
+        /// This defaults to <see cref="ClaimTypes.Name"/>.
+        /// </remarks>
         public string UserNameClaimType { get; set; } = ClaimTypes.Name;
 
         /// <summary>
-        ///     Claim type used for the user id
+        /// Gets the ClaimType used for the user identifier claim.
         /// </summary>
+        /// <remarks>
+        /// This defaults to <see cref="ClaimTypes.NameIdentifier"/>.
+        /// </remarks>
         public string UserIdClaimType { get; set; } = ClaimTypes.NameIdentifier;
 
         /// <summary>
-        ///     Claim type used for the user security stamp
+        /// Gets the ClaimType used for the security stamp claim..
         /// </summary>
+        /// <remarks>
+        /// This defaults to "AspNet.Identity.SecurityStamp".
+        /// </remarks>
         public string SecurityStampClaimType { get; set; } = DefaultSecurityStampClaimType;
     }
 }
\ No newline at end of file