Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Az.Aks Xml comments #18361

Merged
merged 2 commits into from
Jun 9, 2022
Merged

Fix Az.Aks Xml comments #18361

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
91e37aa
Fix Az.Aks Xml comments
v-yuzhichen Jun 1, 2022
0c1eaf7
Fix Az.Aks Xml comments
v-yuzhichen Jun 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/Aks/Aks/Aks.csproj
View file
Open in desktop
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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please do not check in the changes in csproj file


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

<ItemGroup>
Expand Down
4 changes: 2 additions & 2 deletions src/Aks/Aks/Models/PSContainerServiceServicePrincipalProfile.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ public PSContainerServiceServicePrincipalProfile(){}
/// <param name="clientId">The ID for the service principal.</param>
/// <param name="secret">The secret password associated with the
/// service principal in plain text.</param>
/// <param name="keyVaultSecretRef">Reference to a secret stored in
/// Azure Key Vault.</param>
/// <paramef name="keyVaultSecretRef">Reference to a secret stored in
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This tag is wrong. Please have a look

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

“XML comment has a param tag for 'keyVaultSecretRef', but there is no parameter by that name”. About this error, delete the 'keyvaultsecretref' comment?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct, please remove it.

/// Azure Key Vault.</paramef>
public PSContainerServiceServicePrincipalProfile(string clientId, string secret = default(string))
{
ClientId = clientId;
Expand Down