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.Peering XML Comments #18649

Merged
merged 2 commits into from
Jun 22, 2022
Merged

Fix Az.Peering XML Comments #18649

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b082712
Fix Az.Peering XML Comments
v-yuzhichen Jun 21, 2022
e7138f1
Fix Az.Peering XML Comments
ziyuezh576 Jun 22, 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
2 changes: 1 addition & 1 deletion src/Peering/Peering/Common/HelperExtensionMethods.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ public static IPAddress ToIpAddress(this BitArray self)
/// <typeparam name="T"> The Type parameter
/// </typeparam>
/// <returns>
/// The <see cref="List"/>.
/// The <see cref="List{Variance}"/>.
/// </returns>
public static List<Variance> DetailedCompare<T>(this T val1, T val2)
{
Expand Down
8 changes: 4 additions & 4 deletions src/Peering/Peering/Common/PeeringBaseCmdlet.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ public PeeringModel ToPeering(object pSPeering)
/// The peering.
/// </param>
/// <returns>
/// The <see cref="object"/>.
/// The <see cref="PSPeering"/>.
/// </returns>
public PSPeering ToPeeringPs(object peering)
{
Expand Down Expand Up @@ -510,7 +510,7 @@ public virtual void Execute()
/// <summary>
/// Base Cmdlet execute.
/// </summary>
/// <exception cref="NetworkErrorResponseException"></exception>
/// <exception cref="ErrorResponseException"></exception>
public override void ExecuteCmdlet()
{
base.ExecuteCmdlet();
Expand All @@ -520,7 +520,7 @@ public override void ExecuteCmdlet()
/// <summary>
/// The get azure region.
/// </summary>
/// <param name="PeeringLocation">
/// <param name="peeringLocation">
/// The InputObject location.
/// </param>
/// <param name="kind">
Expand All @@ -529,7 +529,7 @@ public override void ExecuteCmdlet()
/// <returns>
/// The <see cref="string"/>.
/// </returns>
/// <exception cref="Exception">
/// <exception cref="PSArgumentNullException">
/// </exception>
public string GetAzureRegion(string peeringLocation, string kind)
{
Expand Down
1 change: 1 addition & 0 deletions src/Peering/Peering/Direct/SetAzureDirectPeeringConnectionCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ public class SetAzureDirectPeeringConnectionCommand : PeeringBaseCmdlet
{
/// <summary>
/// Gets or sets the legacy InputObject.
/// </summary>
[Parameter(
Mandatory = true,
ValueFromPipeline = true,
Expand Down
1 change: 1 addition & 0 deletions src/Peering/Peering/Exchange/SetAzureExchangePeeringConnectionCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ public class SetAzureExchangePeeringConnectionCommand : PeeringBaseCmdlet
{
/// <summary>
/// Gets or sets the legacy InputObject.
/// </summary>
[Parameter(
Mandatory = true,
ValueFromPipeline = true,
Expand Down
2 changes: 1 addition & 1 deletion src/Peering/Peering/PeerAsn/GetAzurePeerAsnCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ private object GetPeerAsn(string peerName)
/// The list peer asn.
/// </summary>
/// <returns>
/// The <see cref="List"/>.
/// The <see cref="List{T}"/>.
/// </returns>
private List<object> ListPeerAsn()
{
Expand Down
4 changes: 2 additions & 2 deletions src/Peering/Peering/PeerAsn/NewAzurePeerAsnCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ public override void Execute()
/// </exception>
/// <exception cref="Exception">
/// </exception>
/// <exception cref="ArmErrorException">
/// <exception cref="ErrorResponseException">
/// </exception>
/// <exception cref="HttpRequestException">
/// </exception>
Expand All @@ -118,7 +118,7 @@ private PSPeerAsn CreatePeerInfo()
/// <summary>
/// The put new InputObject.
/// </summary>
/// <param name="newPeering">
/// <param name="psPeerInfo">
/// The new InputObject.
/// </param>
/// <returns>
Expand Down
11 changes: 6 additions & 5 deletions src/Peering/Peering/Peering/NewAzurePeeringCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ public override void ExecuteCmdlet()
/// </exception>
/// <exception cref="Exception">
/// </exception>
/// <exception cref="ArmErrorException">
/// <exception cref="ErrorResponseException">
/// </exception>
/// <exception cref="HttpRequestException">
/// </exception>
Expand Down Expand Up @@ -318,7 +318,7 @@ private PSPeering CreateDirectPeering()
/// </exception>
/// <exception cref="Exception">
/// </exception>
/// <exception cref="ArmErrorException">
/// <exception cref="ErrorResponseException">
/// </exception>
/// <exception cref="HttpRequestException">
/// </exception>
Expand Down Expand Up @@ -391,10 +391,11 @@ private object PutNewPeering(PSPeering newPeering)
/// <summary>
/// The convert classic to Exchange peering.
/// </summary>
/// <param name="peering">
/// The classic peering.
/// </param>
/// <returns>
/// The <see cref="object"/>.
/// The <see cref="PSPeering"/>.
/// </returns>
private PSPeering ConvertClassicToExchangePeering(PSExchangePeeringModelView peering)
{
Expand Down Expand Up @@ -437,11 +438,11 @@ private PSPeering ConvertClassicToExchangePeering(PSExchangePeeringModelView pee
/// <summary>
/// The convert classic to direct peering.
/// </summary>
/// <param name="this.LegacyPeering">
/// <param name="peering">
/// The classic peering.
/// </param>
/// <returns>
/// The <see cref="object"/>.
/// The <see cref="PSPeering"/>.
/// </returns>
private PSPeering ConvertClassicToDirectPeering(PSDirectPeeringModelView peering)
{
Expand Down
6 changes: 3 additions & 3 deletions src/Peering/Peering/Peering/RegisteredAsn/NewPeeringRegisteredAsnCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ public override void ExecuteCmdlet()
/// </exception>
/// <exception cref="Exception">
/// </exception>
/// <exception cref="ArmErrorException">
/// <exception cref="ErrorResponseException">
/// </exception>
/// <exception cref="HttpRequestException">
/// </exception>
Expand Down Expand Up @@ -187,7 +187,7 @@ private PSPeeringRegisteredAsn CreateParameterSetNameByResourceAndName()
/// </exception>
/// <exception cref="Exception">
/// </exception>
/// <exception cref="ArmErrorException">
/// <exception cref="ErrorResponseException">
/// </exception>
/// <exception cref="HttpRequestException">
/// </exception>
Expand Down Expand Up @@ -217,7 +217,7 @@ private PSPeeringRegisteredAsn CreateParameterSetNameByResourceId()
/// </exception>
/// <exception cref="Exception">
/// </exception>
/// <exception cref="ArmErrorException">
/// <exception cref="ErrorResponseException">
/// </exception>
/// <exception cref="HttpRequestException">
/// </exception>
Expand Down
8 changes: 4 additions & 4 deletions src/Peering/Peering/Peering/RegisteredAsn/SetPeeringRegisteredAsnCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
// ----------------------------------------------------------------------------------
using System;
using System.Management.Automation;

using System.Net.Http;
using Microsoft.Azure.Commands.Peering.Properties;
using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
using Microsoft.Azure.Management.Internal.Resources.Utilities.Models;
Expand Down Expand Up @@ -156,7 +156,7 @@ public override void ExecuteCmdlet()
/// </exception>
/// <exception cref="Exception">
/// </exception>
/// <exception cref="ArmErrorException">
/// <exception cref="ErrorResponseException">
/// </exception>
/// <exception cref="HttpRequestException">
/// </exception>
Expand Down Expand Up @@ -185,7 +185,7 @@ private PSPeeringRegisteredAsn CreateParameterSetNameByResourceAndName()
/// </exception>
/// <exception cref="Exception">
/// </exception>
/// <exception cref="ArmErrorException">
/// <exception cref="ErrorResponseException">
/// </exception>
/// <exception cref="HttpRequestException">
/// </exception>
Expand Down Expand Up @@ -215,7 +215,7 @@ private PSPeeringRegisteredAsn CreateParameterSetNameByResourceId()
/// </exception>
/// <exception cref="Exception">
/// </exception>
/// <exception cref="ArmErrorException">
/// <exception cref="ErrorResponseException">
/// </exception>
/// <exception cref="HttpRequestException">
/// </exception>
Expand Down
6 changes: 3 additions & 3 deletions src/Peering/Peering/Peering/RegisteredPrefix/NewAzPeeringRegisteredPrefixCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ public override void ExecuteCmdlet()
/// </exception>
/// <exception cref="Exception">
/// </exception>
/// <exception cref="ArmErrorException">
/// <exception cref="ErrorResponseException">
/// </exception>
/// <exception cref="HttpRequestException">
/// </exception>
Expand Down Expand Up @@ -190,7 +190,7 @@ private PSPeeringRegisteredPrefix CreateParameterSetNameByResourceAndName()
/// </exception>
/// <exception cref="Exception">
/// </exception>
/// <exception cref="ArmErrorException">
/// <exception cref="ErrorResponseException">
/// </exception>
/// <exception cref="HttpRequestException">
/// </exception>
Expand Down Expand Up @@ -220,7 +220,7 @@ private PSPeeringRegisteredPrefix CreateParameterSetNameByResourceId()
/// </exception>
/// <exception cref="Exception">
/// </exception>
/// <exception cref="ArmErrorException">
/// <exception cref="ErrorResponseException">
/// </exception>
/// <exception cref="HttpRequestException">
/// </exception>
Expand Down
8 changes: 4 additions & 4 deletions src/Peering/Peering/Peering/RegisteredPrefix/SetAzPeeringRegisteredPrefixCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
// ----------------------------------------------------------------------------------
using System;
using System.Management.Automation;

using System.Net.Http;
using Microsoft.Azure.Commands.Peering.Properties;
using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
using Microsoft.Azure.Management.Internal.Resources.Utilities.Models;
Expand Down Expand Up @@ -159,7 +159,7 @@ public override void ExecuteCmdlet()
/// </exception>
/// <exception cref="Exception">
/// </exception>
/// <exception cref="ArmErrorException">
/// <exception cref="ErrorResponseException">
/// </exception>
/// <exception cref="HttpRequestException">
/// </exception>
Expand Down Expand Up @@ -188,7 +188,7 @@ private PSPeeringRegisteredPrefix CreateParameterSetNameByResourceAndName()
/// </exception>
/// <exception cref="Exception">
/// </exception>
/// <exception cref="ArmErrorException">
/// <exception cref="ErrorResponseException">
/// </exception>
/// <exception cref="HttpRequestException">
/// </exception>
Expand Down Expand Up @@ -218,7 +218,7 @@ private PSPeeringRegisteredPrefix CreateParameterSetNameByResourceId()
/// </exception>
/// <exception cref="Exception">
/// </exception>
/// <exception cref="ArmErrorException">
/// <exception cref="ErrorResponseException">
/// </exception>
/// <exception cref="HttpRequestException">
/// </exception>
Expand Down
8 changes: 7 additions & 1 deletion src/Peering/Peering/Peering/UpdateAzurePeeringCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,12 @@ private PSDirectPeeringModelView GetAndUpdateDirectPeering()
/// <param name="directPeering">
/// The direct peering.
/// </param>
/// <param name="resourceGroupName">
/// The resource group name.
/// </param>
/// <param name="name">
/// The name.
/// </param>
/// <returns>
/// The <see cref="PSDirectPeeringModelView"/>.
/// </returns>
Expand Down Expand Up @@ -399,7 +405,7 @@ private PSExchangePeeringModelView GetAndUpdateExchangePeering()
/// <summary>
/// The update exchange peering.
/// </summary>
/// <param name="psExchange">
/// <param name="exchangePeering">
/// The ps exchange.
/// </param>
/// <param name="resourceGroupName">
Expand Down
2 changes: 1 addition & 1 deletion src/Peering/Peering/PeeringService/GetAzurePeeringServiceCountryCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public override void Execute()
/// The get peering service location.
/// </summary>
/// <returns>
/// The <see cref="List"/>.
/// The <see cref="List{PSPeeringServiceCountry}"/>.
/// </returns>
/// <exception cref="ErrorResponseException">
/// </exception>
Expand Down
2 changes: 1 addition & 1 deletion src/Peering/Peering/PeeringService/GetAzurePeeringServiceLocationCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public override void Execute()
/// The get peering service location.
/// </summary>
/// <returns>
/// The <see cref="List"/>.
/// The <see cref="List{PSPeeringServiceLocation}"/>.
/// </returns>
/// <exception cref="ErrorResponseException">
/// </exception>
Expand Down
2 changes: 1 addition & 1 deletion src/Peering/Peering/PeeringService/GetAzurePeeringServiceProviderCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public override void Execute()
/// The get peering service provider.
/// </summary>
/// <returns>
/// The <see cref="List"/>.
/// The <see cref="List{PSPeeringServiceProvider}"/>.
/// </returns>
/// <exception cref="ErrorResponseException">
/// </exception>
Expand Down