From cf68fac658f40da174243c93e6b7ef59a7e9dcc6 Mon Sep 17 00:00:00 2001 From: Barry Dorrans Date: Tue, 6 Jan 2015 15:40:24 -0800 Subject: [PATCH] XML Doc Update (one by one for ease of eventual merging) --- .../ClaimsIdentityExtensions.cs | 24 ++++++++++--------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/src/Microsoft.AspNet.Identity/ClaimsIdentityExtensions.cs b/src/Microsoft.AspNet.Identity/ClaimsIdentityExtensions.cs index 63cd7b03f3..23655ddcff 100644 --- a/src/Microsoft.AspNet.Identity/ClaimsIdentityExtensions.cs +++ b/src/Microsoft.AspNet.Identity/ClaimsIdentityExtensions.cs @@ -6,15 +6,16 @@ using System.Security.Claims; namespace System.Security.Principal { /// - /// Extensions making it easier to get the user name/user id claims off of an identity + /// Claims related extensions for . /// public static class ClaimsIdentityExtensions { /// - /// Return the user name using the UserNameClaimType + /// Returns the Name claim value if present otherwise returns null. /// - /// - /// + /// The instance this method extends. + /// The Name claim value, or null if the claim is not present. + /// The name claim is identified by . public static string GetUserName(this IIdentity identity) { if (identity == null) @@ -26,10 +27,11 @@ namespace System.Security.Principal } /// - /// Return the user id using the UserIdClaimType + /// Returns the User ID claim value if present otherwise returns null. /// - /// - /// + /// The instance this method extends. + /// The User ID claim value, or null if the claim is not present. + /// The name claim is identified by . public static string GetUserId(this IIdentity identity) { if (identity == null) @@ -41,11 +43,11 @@ namespace System.Security.Principal } /// - /// Return the claim value for the first claim with the specified type if it exists, null otherwise + /// Returns the value for the first claim of the specified type otherwise null the claim is not present. /// - /// - /// - /// + /// The instance this method extends. + /// The claim type whose first value should be returned. + /// The value of the first instance of the specifed claim type, or null if the claim is not present. public static string FindFirstValue(this ClaimsIdentity identity, string claimType) { if (identity == null)