Skip to content

Commit

Permalink
Fix Az.WebSites XML Comments
Browse files Browse the repository at this point in the history
  • Loading branch information
v-yuzhichen committed Jun 16, 2022
1 parent 3cf0d38 commit 22c5d42
Show file tree
Hide file tree
Showing 30 changed files with 129 additions and 9 deletions.
9 changes: 9 additions & 0 deletions src/Accounts/Accounts/Accounts.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@

<PropertyGroup>
<RootNamespace>$(LegacyAssemblyPrefix)Profile</RootNamespace>
<GenerateDocumentationFile>True</GenerateDocumentationFile>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<NoWarn>1701;1702;1591</NoWarn>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
<NoWarn>1701;1702;1591</NoWarn>
</PropertyGroup>

<ItemGroup>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,17 @@
<PropertyGroup>
<AssemblyName>Microsoft.Azure.PowerShell.Authentication.ResourceManager</AssemblyName>
<RootNamespace>$(LegacyAssemblyPrefix)Common.Authentication.ResourceManager</RootNamespace>
<GenerateDocumentationFile>True</GenerateDocumentationFile>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<NoWarn>1701;1702;1591</NoWarn>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
<NoWarn>1701;1702;1591</NoWarn>
</PropertyGroup>

<ItemGroup>
<ProjectReference Include="..\Authentication\Authentication.csproj" />
</ItemGroup>
Expand Down
3 changes: 3 additions & 0 deletions src/Accounts/Authentication.ResourceManager/AzureRmProfile.cs
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,7 @@ public AzureRmProfile()
/// Initializes a new instance of AzureRMProfile and loads its content from specified path.
/// </summary>
/// <param name="path">The location of profile file on disk.</param>
/// <param name="shouldRefreshContextsFromCache"></param>
public AzureRmProfile(string path, bool shouldRefreshContextsFromCache = true) : this()
{
this.ShouldRefreshContextsFromCache = shouldRefreshContextsFromCache;
Expand Down Expand Up @@ -267,6 +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>
public void Save(string path, bool serializeCache = true)
{
if (string.IsNullOrEmpty(path))
Expand All @@ -284,6 +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>
public void Save(IFileProvider provider, bool serializeCache = true)
{
foreach (string env in AzureEnvironment.PublicEnvironments.Keys)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,8 +164,7 @@ public PSAzureContext(PSObject other)
public IAzureTenant Tenant { get; set; }

/// <summary>
/// Moved to <see cref="IClientApplicationBase.ClientTokenCache"> due to MSAL.
/// See <see cref="AuthenticationClientFactory"> for how to create client applications.
/// Moved to <see cref="IAzureTokenCache"/> due to MSAL.
/// </summary>
public IAzureTokenCache TokenCache { get; set; } = null;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ public PSAzureSubscriptionPolicy()
/// <summary>
/// object constructor
/// </summary>
/// <param name="azureSubscriptionPolicies">Json string to convert</param>
/// <param name="subscriptionPolicies">Json string to convert</param>
public PSAzureSubscriptionPolicy(SubscriptionPolicies subscriptionPolicies)
{
if (subscriptionPolicies != null)
Expand Down
1 change: 1 addition & 0 deletions src/Accounts/Authentication/AdalLogger.cs
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ internal static void Disable(AdalLogger logger)
/// </summary>
/// <param name="level">The log level</param>
/// <param name="message">The log message</param>
/// <param name="containsPII"></param>
public void Log(LogLevel level, string message, bool containsPII)
{
foreach (var logger in _loggers)
Expand Down
9 changes: 9 additions & 0 deletions src/Accounts/Authentication/Authentication.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@
<PropertyGroup>
<AssemblyName>Microsoft.Azure.PowerShell.Authentication</AssemblyName>
<RootNamespace>$(LegacyAssemblyPrefix)Common.Authentication</RootNamespace>
<GenerateDocumentationFile>True</GenerateDocumentationFile>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<NoWarn>1701;1702;1591</NoWarn>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
<NoWarn>1701;1702;1591</NoWarn>
</PropertyGroup>

<ItemGroup>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public interface IClaimsChallengeProcessor
/// <param name="request">The origin request that responds with a claim challenge</param>
/// <param name="claimsChallenge">Claims challenge string</param>
/// <param name="cancellationToken">Cancelation token</param>
/// <returns>Successful or not
/// <returns>Successful or not</returns>
ValueTask<bool> OnClaimsChallenageAsync(HttpRequestMessage request, string claimsChallenge, CancellationToken cancellationToken);
}
}
4 changes: 3 additions & 1 deletion src/Accounts/Authentication/ClaimsChallengeHandler.cs
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,9 @@ public virtual object Clone()
/// Executed in the event a 401 response with a WWW-Authenticate authentication challenge header is received after the initial request.
/// </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="message">The HttpMessage to be authenticated.</param>
/// <param name="requestMessage">The HttpMessage to be authenticated.</param>
/// <param name="responseMessage"></param>
/// <param name="cancellationToken"></param>
/// <returns>A boolean indicated whether the request should be retried</returns>
protected virtual async Task<bool> OnChallengeAsync(HttpRequestMessage requestMessage, HttpResponseMessage responseMessage, CancellationToken cancellationToken)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ internal class ConfigurationBuilder : IConfigurationBuilder
/// <summary>
/// Adds a new configuration source.
/// </summary>
/// <param name="id"></param>
/// <param name="source">The configuration source to add.</param>
/// <returns>The same <see cref="IConfigurationBuilder"/>.</returns>
public IConfigurationBuilder Add(string id, IConfigurationSource source)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ internal static class ConfigurationExtensions
/// Adds a new configuration source.
/// </summary>
/// <param name="builder">The <see cref="IConfigurationBuilder"/> to add to.</param>
/// <param name="id"></param>
/// <param name="configureSource">Configures the source secrets.</param>
/// <returns>The <see cref="IConfigurationBuilder"/>.</returns>
public static IConfigurationBuilder Add<TSource>(this IConfigurationBuilder builder, string id, Action<TSource> configureSource) where TSource : IConfigurationSource, new()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ internal interface IConfigurationBuilder
/// <summary>
/// Adds a new configuration source.
/// </summary>
/// <param name="id"></param>
/// <param name="source">The configuration source to add.</param>
/// <returns>The same <see cref="IConfigurationBuilder"/>.</returns>
IConfigurationBuilder Add(string id, IConfigurationSource source);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ internal interface IConfigurationSource
/// Builds the <see cref="IConfigurationProvider"/> for this source.
/// </summary>
/// <param name="builder">The <see cref="IConfigurationBuilder"/>.</param>
/// <param name="id"></param>
/// <returns>An <see cref="IConfigurationProvider"/></returns>
IConfigurationProvider Build(IConfigurationBuilder builder, string id);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ internal static class JsonConfigurationExtensions
/// Adds a JSON configuration source to <paramref name="builder"/>.
/// </summary>
/// <param name="builder">The <see cref="IConfigurationBuilder"/> to add to.</param>
/// <param name="id"></param>
/// <param name="stream">The <see cref="Stream"/> to read the json configuration data from.</param>
/// <returns>The <see cref="IConfigurationBuilder"/>.</returns>
public static IConfigurationBuilder AddJsonStream(this IConfigurationBuilder builder, string id, Stream stream)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ internal class JsonStreamConfigurationSource : StreamConfigurationSource
/// Builds the <see cref="JsonStreamConfigurationProvider"/> for this source.
/// </summary>
/// <param name="builder">The <see cref="IConfigurationBuilder"/>.</param>
/// <param name="id"></param>
/// <returns>An <see cref="JsonStreamConfigurationProvider"/></returns>
public override IConfigurationProvider Build(IConfigurationBuilder builder, string id)
=> new JsonStreamConfigurationProvider(this, id);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ internal abstract class StreamConfigurationProvider : ConfigurationProvider
/// Constructor.
/// </summary>
/// <param name="source">The source.</param>
/// <param name="id"></param>
public StreamConfigurationProvider(StreamConfigurationSource source, string id) : base(id)
{
Source = source ?? throw new ArgumentNullException(nameof(source));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ internal abstract class StreamConfigurationSource : IConfigurationSource
/// Builds the <see cref="StreamConfigurationProvider"/> for this source.
/// </summary>
/// <param name="builder">The <see cref="IConfigurationBuilder"/>.</param>
/// <param name="id"></param>
/// <returns>An <see cref="IConfigurationProvider"/></returns>
public abstract IConfigurationProvider Build(IConfigurationBuilder builder, string id);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ internal class UnsettableMemoryConfigurationProvider : ConfigurationProvider, IE
/// Initialize a new instance from the source.
/// </summary>
/// <param name="source">The source settings.</param>
/// <param name="id"></param>
public UnsettableMemoryConfigurationProvider(UnsettableMemoryConfigurationSource source, string id): base(id)
{
if (source == null)
Expand Down
3 changes: 3 additions & 0 deletions src/Accounts/Authenticators/Authenticators.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,21 @@
<CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
<AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
<OutputPath>bin\$(Configuration)</OutputPath>
<GenerateDocumentationFile>True</GenerateDocumentationFile>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<DelaySign>false</DelaySign>
<DefineConstants>TRACE;DEBUG;NETSTANDARD</DefineConstants>
<NoWarn>1701;1702;1591</NoWarn>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
<SignAssembly>true</SignAssembly>
<DelaySign>true</DelaySign>
<AssemblyOriginatorKeyFile>$(RepoSrc)MSSharedLibKey.snk</AssemblyOriginatorKeyFile>
<DefineConstants>TRACE;RELEASE;NETSTANDARD;SIGN</DefineConstants>
<NoWarn>1701;1702;1591</NoWarn>
</PropertyGroup>

<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion src/Accounts/Authenticators/Identity/ITokenCacheOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,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="CredentialUnavailableException"/> in the event no OS level user encryption is available.
/// will throw a <see cref="UnsafeAllowUnencryptedStorage"/> in the event no OS level user encryption is available.
/// </summary>
public bool UnsafeAllowUnencryptedStorage { get; set; }
}
Expand Down
8 changes: 6 additions & 2 deletions src/Billing/Billing.sln
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio 15
VisualStudioVersion = 15.0.27703.2042
# Visual Studio Version 17
VisualStudioVersion = 17.2.32526.322
MinimumVisualStudioVersion = 10.0.40219.1
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Billing", "Billing\Billing.csproj", "{8C6489F5-0352-4667-8A0D-86B4B399EECC}"
EndProject
Expand Down Expand Up @@ -46,6 +46,10 @@ Global
{142D7B0B-388A-4CEB-A228-7F6D423C5C2E}.Debug|Any CPU.Build.0 = Debug|Any CPU
{142D7B0B-388A-4CEB-A228-7F6D423C5C2E}.Release|Any CPU.ActiveCfg = Release|Any CPU
{142D7B0B-388A-4CEB-A228-7F6D423C5C2E}.Release|Any CPU.Build.0 = Release|Any CPU
{6BD6B80A-06AF-4B5B-9230-69CCFC6C8D64}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{6BD6B80A-06AF-4B5B-9230-69CCFC6C8D64}.Debug|Any CPU.Build.0 = Debug|Any CPU
{6BD6B80A-06AF-4B5B-9230-69CCFC6C8D64}.Release|Any CPU.ActiveCfg = Release|Any CPU
{6BD6B80A-06AF-4B5B-9230-69CCFC6C8D64}.Release|Any CPU.Build.0 = Release|Any CPU
{91E87DBE-3946-4A11-B8DD-84C6FC60181E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{91E87DBE-3946-4A11-B8DD-84C6FC60181E}.Debug|Any CPU.Build.0 = Debug|Any CPU
{91E87DBE-3946-4A11-B8DD-84C6FC60181E}.Release|Any CPU.ActiveCfg = Release|Any CPU
Expand Down
9 changes: 9 additions & 0 deletions src/Billing/Billing/Billing.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@

<PropertyGroup>
<RootNamespace>$(LegacyAssemblyPrefix)$(PsModuleName)</RootNamespace>
<GenerateDocumentationFile>True</GenerateDocumentationFile>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<NoWarn>1701;1702;1591</NoWarn>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
<NoWarn>1701;1702;1591</NoWarn>
</PropertyGroup>

<ItemGroup>
Expand Down
9 changes: 9 additions & 0 deletions src/Billing/Consumption/Consumption.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@
<PropertyGroup>
<AssemblyName>$(AzAssemblyPrefix)Consumption</AssemblyName>
<RootNamespace>$(LegacyAssemblyPrefix)Consumption</RootNamespace>
<GenerateDocumentationFile>True</GenerateDocumentationFile>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<NoWarn>1701;1702;1591</NoWarn>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
<NoWarn>1701;1702;1591</NoWarn>
</PropertyGroup>

<ItemGroup>
Expand Down
9 changes: 9 additions & 0 deletions src/Peering/Peering/Peering.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@

<PropertyGroup>
<RootNamespace>$(LegacyAssemblyPrefix)$(PsModuleName)</RootNamespace>
<GenerateDocumentationFile>True</GenerateDocumentationFile>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<NoWarn>1701;1702;1591</NoWarn>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
<NoWarn>1701;1702;1591</NoWarn>
</PropertyGroup>

<ItemGroup>
Expand Down
9 changes: 9 additions & 0 deletions src/Resources/ResourceManager/ResourceManager.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@
<PropertyGroup>
<AssemblyName>$(AzAssemblyPrefix)ResourceManager</AssemblyName>
<RootNamespace>$(LegacyAssemblyPrefix)ResourceManager.Cmdlets</RootNamespace>
<GenerateDocumentationFile>True</GenerateDocumentationFile>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<NoWarn>1701;1702;1591</NoWarn>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
<NoWarn>1701;1702;1591</NoWarn>
</PropertyGroup>

<ItemGroup>
Expand Down
9 changes: 9 additions & 0 deletions src/Resources/Resources/Resources.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@

<PropertyGroup>
<RootNamespace>$(LegacyAssemblyPrefix)$(PsModuleName)</RootNamespace>
<GenerateDocumentationFile>True</GenerateDocumentationFile>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<NoWarn>1701;1702;1591</NoWarn>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
<NoWarn>1701;1702;1591</NoWarn>
</PropertyGroup>

<ItemGroup>
Expand Down
9 changes: 9 additions & 0 deletions src/Websites/Websites.Helper/Websites.Helper.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,15 @@
<TargetFramework>netstandard2.0</TargetFramework>
<AssemblyName>Microsoft.Azure.PowerShell.Cmdlets.Websites.Helper</AssemblyName>
<RootNamespace>Microsoft.Azure.PowerShell.Cmdlets.Websites.Helper</RootNamespace>
<GenerateDocumentationFile>True</GenerateDocumentationFile>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<NoWarn>1701;1702;1591</NoWarn>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
<NoWarn>1701;1702;1591</NoWarn>
</PropertyGroup>

<ItemGroup>
Expand Down
9 changes: 9 additions & 0 deletions src/Websites/Websites/Websites.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@

<PropertyGroup>
<RootNamespace>$(LegacyAssemblyPrefix)WebApps</RootNamespace>
<GenerateDocumentationFile>True</GenerateDocumentationFile>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<NoWarn>1701;1702;1591</NoWarn>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
<NoWarn>1701;1702;1591</NoWarn>
</PropertyGroup>

<ItemGroup>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,10 @@ public bool ContainsIgnoredProvider(string requestUri, out string version)
/// Helper method to determine whether or not this request api version should be ignored
/// </summary>
/// <param name="requestUri">The request uri</param>
/// <param name="apiVersion">The api verison to use</paraam>
/// <param name="shouldIgnoreGenericResource"></param>
/// <param name="providersToIgnore"></param>
/// <param name="resourcesToIgnore"></param>
/// <param name="apiVersion">The api verison to use</param>
/// <returns></returns>
public static bool ContainsIgnoredProvider(
string requestUri,
Expand Down
Loading

0 comments on commit 22c5d42

Please sign in to comment.