Skip to content

Commit

Permalink
Fix obsolete XML comments (#1074)
Browse files Browse the repository at this point in the history
* Fix obsolete XML comments

* Improving the XML comments in MsalError to make them more actionable.

* Addressing PR feedback

* fix typo
  • Loading branch information
jmprieur authored Apr 14, 2019
1 parent 0315085 commit a3c6cdd
Show file tree
Hide file tree
Showing 13 changed files with 162 additions and 52 deletions.
4 changes: 2 additions & 2 deletions src/Microsoft.Identity.Client/AuthenticationResult.cs
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ internal AuthenticationResult(MsalAccessTokenCacheItem msalAccessTokenCacheItem,
/// <summary>
/// Gets the account information. Some elements in <see cref="IAccount"/> might be null if not returned by the
/// service. The account can be passed back in some API overloads to identify which account should be used such
/// as <see cref="IClientApplicationBase.AcquireTokenSilentAsync(IEnumerable{string}, IAccount)"/> or
/// as <see cref="IClientApplicationBase.AcquireTokenSilent(IEnumerable{string}, IAccount)"/> or
/// <see cref="IClientApplicationBase.RemoveAsync(IAccount)"/> for instance
/// </summary>
public IAccount Account { get; }
Expand Down Expand Up @@ -183,4 +183,4 @@ public string CreateAuthorizationHeader()
return Oauth2AuthorizationHeader + AccessToken;
}
}
}
}
2 changes: 1 addition & 1 deletion src/Microsoft.Identity.Client/ClientApplicationBase.cs
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public abstract partial class ClientApplicationBase : IClientApplicationBase
/// <Summary>
/// User token cache. This case holds id tokens, access tokens and refresh tokens for accounts. It's used
/// and updated silently if needed when calling <see cref="AcquireTokenSilent(IEnumerable{string}, IAccount)"/>
/// or one of the overrides of <see cref="AcquireTokenSilentAsync(IEnumerable{string}, IAccount)"/>.
/// or one of the overrides of <see cref="AcquireTokenSilent(IEnumerable{string}, IAccount)"/>.
/// It is updated by each AcquireTokenXXX method, with the exception of <c>AcquireTokenForClient</c> which only uses the application
/// cache (see <c>IConfidentialClientApplication</c>).
/// </Summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ internal ConfidentialClientApplication(ApplicationConfiguration configuration)
/// It's usually used in Web Apps (for instance ASP.NET / ASP.NET Core Web apps) which sign-in users,
/// and can request an authorization code.
/// This method does not lookup the token cache, but stores the result in it, so it can be looked up
/// using other methods such as <see cref="IClientApplicationBase.AcquireTokenSilentAsync(IEnumerable{string}, IAccount)"/>.
/// using other methods such as <see cref="IClientApplicationBase.AcquireTokenSilent(IEnumerable{string}, IAccount)"/>.
/// </summary>
/// <param name="scopes">Scopes requested to access a protected API</param>
/// <param name="authorizationCode">The authorization code received from the service authorization endpoint.</param>
Expand Down Expand Up @@ -174,8 +174,7 @@ AcquireTokenByRefreshTokenParameterBuilder IByRefreshToken.AcquireTokenByRefresh

/// <Summary>
/// Application token cache. This case holds access tokens and refresh tokens for the application. It's maintained
/// and updated silently if needed when <see cref="AcquireTokenForClient(IEnumerable{string})"/> or one
/// of the overrides of <see cref="AcquireTokenForClientAsync(IEnumerable{string})"/>
/// and updated silently if needed when <see cref="AcquireTokenForClient(IEnumerable{string})"/>
/// </Summary>
/// <remarks>On .NET Framework and .NET Core you can also customize the token cache serialization.
/// See https://aka.ms/msal-net-token-cache-serialization. This is taken care of by MSAL.NET on other platforms
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.Identity.Client/DeviceCodeResult.cs
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ namespace Microsoft.Identity.Client
/// to be entered on that device.
/// See https://aka.ms/msal-device-code-flow.
/// </summary>
/// <seealso cref="PublicClientApplication.AcquireTokenWithDeviceCodeAsync(IEnumerable{string}, Func{DeviceCodeResult, System.Threading.Tasks.Task})"> and
/// <seealso cref="PublicClientApplication.AcquireTokenWithDeviceCode(IEnumerable{string}, Func{DeviceCodeResult, System.Threading.Tasks.Task})"> and
/// the other overrides
/// </seealso>
public class DeviceCodeResult
Expand Down
4 changes: 2 additions & 2 deletions src/Microsoft.Identity.Client/IAccount.cs
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ namespace Microsoft.Identity.Client
/// The IAccount interface represents information about a single account.
/// The same user can be present in different tenants, that is, a user can have multiple accounts.
/// An <c>IAccount</c> is returned in the <see cref="AuthenticationResult"/>.<see cref="AuthenticationResult.Account"/> property, and can be used as parameters
/// of PublicClientApplication and ConfidentialClientApplication methods acquiring tokens such as <see cref="ClientApplicationBase.AcquireTokenSilentAsync(System.Collections.Generic.IEnumerable{string}, IAccount)"/>
/// of PublicClientApplication and ConfidentialClientApplication methods acquiring tokens such as <see cref="ClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{string}, IAccount)"/>
/// </summary>
public interface IAccount
{
Expand All @@ -56,4 +56,4 @@ public interface IAccount
/// <remarks>Can be null, for example if this account was migrated to MSAL.NET from ADAL.NET v3's token cache</remarks>
AccountId HomeAccountId { get; }
}
}
}
2 changes: 1 addition & 1 deletion src/Microsoft.Identity.Client/IByRefreshToken.cs
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public partial interface IByRefreshToken
{
/// <summary>
/// Acquires an access token from an existing refresh token and stores it and the refresh token into
/// the user token cache, where it will be available for further AcquireTokenSilentAsync calls.
/// the user token cache, where it will be available for further AcquireTokenSilent calls.
/// This method can be used in migration to MSAL from ADAL v2 and in various integration
/// scenarios where you have a RefreshToken available.
/// (see https://aka.ms/msal-net-migration-adal2-msal2)
Expand Down
1 change: 0 additions & 1 deletion src/Microsoft.Identity.Client/IClientApplicationBase.cs
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ public partial interface IClientApplicationBase
/// <Summary>
/// User token cache. This case holds id tokens, access tokens and refresh tokens for accounts. It's used
/// and updated silently if needed when calling <see cref="AcquireTokenSilent(IEnumerable{string}, IAccount)"/>
/// or one of the overrides of <see cref="AcquireTokenSilentAsync(IEnumerable{string}, IAccount)"/>.
/// It is updated by each AcquireTokenXXX method, with the exception of <c>AcquireTokenForClient</c> which only uses the application
/// cache (see <c>IConfidentialClientApplication</c>).
/// </Summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,7 @@ public partial interface IConfidentialClientApplication : IClientApplicationBase
{
/// <Summary>
/// Application token cache. This case holds access tokens and refresh tokens for the application. It's maintained
/// and updated silently if needed when <see cref="AcquireTokenForClient(IEnumerable{string})"/> or one
/// of the overrides of <see cref="AcquireTokenForClientAsync(IEnumerable{string})"/>
/// and updated silently if needed when <see cref="AcquireTokenForClient(IEnumerable{string})"/>
/// </Summary>
/// <remarks>On .NET Framework and .NET Core you can also customize the token cache serialization.
/// See https://aka.ms/msal-net-token-cache-serialization. This is taken care of by MSAL.NET on other platforms
Expand All @@ -56,7 +55,7 @@ public partial interface IConfidentialClientApplication : IClientApplicationBase
/// It's usually used in Web Apps (for instance ASP.NET / ASP.NET Core Web apps) which sign-in users,
/// and can request an authorization code.
/// This method does not lookup the token cache, but stores the result in it, so it can be looked up
/// using other methods such as <see cref="IClientApplicationBase.AcquireTokenSilentAsync(IEnumerable{string}, IAccount)"/>.
/// using other methods such as <see cref="IClientApplicationBase.AcquireTokenSilent(IEnumerable{string}, IAccount)"/>.
/// </summary>
/// <param name="scopes">Scopes requested to access a protected API</param>
/// <param name="authorizationCode">The authorization code received from the service authorization endpoint.</param>
Expand Down
Loading

0 comments on commit a3c6cdd

Please sign in to comment.