From 4074cc5903de545c53f1be6b7e7672e731b89b82 Mon Sep 17 00:00:00 2001
From: Ziyue Zheng <v-ziyzhe@microsoft.com>
Date: Thu, 23 Jun 2022 16:37:03 +0800
Subject: [PATCH] Fix Az.Accounts XML Comments

---
 src/Accounts/Authentication.ResourceManager/AzureRmProfile.cs | 4 ++--
 .../Authentication.ResourceManager/Models/PSAzureContext.cs   | 3 ---
 src/Accounts/Authentication/ClaimsChallengeHandler.cs         | 2 +-
 src/Accounts/Authenticators/Identity/ITokenCacheOptions.cs    | 4 +++-
 4 files changed, 6 insertions(+), 7 deletions(-)

diff --git a/src/Accounts/Authentication.ResourceManager/AzureRmProfile.cs b/src/Accounts/Authentication.ResourceManager/AzureRmProfile.cs
index 9396b2a823ed..aff4970ab3ce 100644
--- a/src/Accounts/Authentication.ResourceManager/AzureRmProfile.cs
+++ b/src/Accounts/Authentication.ResourceManager/AzureRmProfile.cs
@@ -268,7 +268,7 @@ public void Save()
         /// Writes profile to a specified path.
         /// </summary>
         /// <param name="path">File path on disk to save profile to</param>
-        /// <param name="serializeCache"></param>
+        /// <param name="serializeCache">true if the TokenCache should be serialized, false otherwise</param>
         public void Save(string path, bool serializeCache = true)
         {
             if (string.IsNullOrEmpty(path))
@@ -286,7 +286,7 @@ public void Save(string path, bool serializeCache = true)
         /// Writes the profile using the specified file provider
         /// </summary>
         /// <param name="provider">The file provider used to save the profile</param>
-        /// <param name="serializeCache"></param>
+        /// <param name="serializeCache">true if the TokenCache should be serialized, false otherwise</param>
         public void Save(IFileProvider provider, bool serializeCache = true)
         {
             foreach (string env in AzureEnvironment.PublicEnvironments.Keys)
diff --git a/src/Accounts/Authentication.ResourceManager/Models/PSAzureContext.cs b/src/Accounts/Authentication.ResourceManager/Models/PSAzureContext.cs
index bb5b217480a1..c9c7bfcc86e8 100644
--- a/src/Accounts/Authentication.ResourceManager/Models/PSAzureContext.cs
+++ b/src/Accounts/Authentication.ResourceManager/Models/PSAzureContext.cs
@@ -163,9 +163,6 @@ public PSAzureContext(PSObject other)
         [Ps1Xml(Label = "TenantId", Target = ViewControl.Table, ScriptBlock = "$_.Tenant.ToString()", Position = 4)]
         public IAzureTenant Tenant { get; set; }
 
-        /// <summary>
-        /// Moved to <see cref="TokenCache"/> due to MSAL.
-        /// </summary>
         public IAzureTokenCache TokenCache { get; set; } = null;
 
         public string VersionProfile { get; set; }
diff --git a/src/Accounts/Authentication/ClaimsChallengeHandler.cs b/src/Accounts/Authentication/ClaimsChallengeHandler.cs
index e0956afaa566..fea07455f112 100644
--- a/src/Accounts/Authentication/ClaimsChallengeHandler.cs
+++ b/src/Accounts/Authentication/ClaimsChallengeHandler.cs
@@ -60,7 +60,7 @@ public virtual object Clone()
         /// </summary>
         /// <remarks>This implementation handles common authentication challenges such as claims challenges. Service client libraries may derive from this and extend to handle service specific authentication challenges.</remarks>
         /// <param name="requestMessage">The HttpMessage to be authenticated.</param>
-        /// <param name="cancellationToken"></param>
+        /// <param name="cancellationToken">Cancelation token</param>
         /// <param name="responseMessage"></param>
         /// <returns>A boolean indicated whether the request should be retried</returns>
         protected virtual async Task<bool> OnChallengeAsync(HttpRequestMessage requestMessage, HttpResponseMessage responseMessage, CancellationToken cancellationToken)
diff --git a/src/Accounts/Authenticators/Identity/ITokenCacheOptions.cs b/src/Accounts/Authenticators/Identity/ITokenCacheOptions.cs
index 6b8866f5fad6..45e7779298d8 100644
--- a/src/Accounts/Authenticators/Identity/ITokenCacheOptions.cs
+++ b/src/Accounts/Authenticators/Identity/ITokenCacheOptions.cs
@@ -13,6 +13,8 @@
 // ----------------------------------------------------------------------------------
 //
 
+using Azure.Identity;
+
 namespace Microsoft.Azure.PowerShell.Authenticators.Identity
 {
     /// <summary>
@@ -27,7 +29,7 @@ public class TokenCachePersistenceOptions
 
         /// <summary>
         /// If set to true the token cache may be persisted as an unencrypted file if no OS level user encryption is available. When set to false the token cache
-        /// will throw a <see cref="UnsafeAllowUnencryptedStorage"/> 
+        /// will throw a <see cref="CredentialUnavailableException"/> in the event no OS level user encryption is available.
         /// </summary>
         public bool UnsafeAllowUnencryptedStorage { get; set; }
     }