Skip to content

Commit 4f22491

Browse files
authored
Fix Az.RecoveryServices XML Comments (Azure#18484)
* Fix Az.RecoveryServices XML Comments * Fix Az.RecoveryServices XML Comments 1
1 parent 23ba64c commit 4f22491

File tree

53 files changed

+241
-131
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+241
-131
lines changed

src/RecoveryServices/RecoveryServices.Backup.Helpers/Conversions/RecoveryPointConversions.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ public static List<RecoveryPointBase> FilterRPsBasedOnTier(List<RecoveryPointBas
6161
/// filter move readness based on target tier
6262
/// </summary>
6363
/// <param name="recoveryPointList"></param>
64-
/// <param name="TargetTier"></param>
65-
/// <param name="IsReadyForMove"></param>
64+
/// <param name="targetTier"></param>
65+
/// <param name="isReadyForMove"></param>
6666
/// <returns></returns>
6767
public static List<RecoveryPointBase> CheckRPMoveReadiness(List<RecoveryPointBase> recoveryPointList, RecoveryPointTier targetTier, bool isReadyForMove)
6868
{
@@ -220,7 +220,7 @@ public static List<RecoveryPointBase> GetPSAzureRecoveryPointsForSecondaryRegion
220220
return result;
221221
}
222222

223-
// <summary>
223+
/// <summary>
224224
/// Helper function to convert ps recovery point model from service response.
225225
/// </summary>
226226
public static RecoveryPointBase GetPSAzureRecoveryPoints(
@@ -259,7 +259,7 @@ public static RecoveryPointBase GetPSAzureRecoveryPoints(
259259
return result;
260260
}
261261

262-
// <summary>
262+
/// <summary>
263263
/// Helper function to convert ps recovery point model from service response.
264264
/// </summary>
265265
public static RecoveryPointBase GetPSAzureRecoveryPointsFromSecondaryRegion(

src/RecoveryServices/RecoveryServices.Backup.Helpers/Conversions/RetentionPolicyConversions.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public partial class PolicyHelpers
3030

3131
#region public
3232

33-
// <summary>
33+
/// <summary>
3434
/// Helper function to convert ps long term retention policy from service response.
3535
/// </summary>
3636
public static LongTermRetentionPolicy GetPSLongTermRetentionPolicy(
@@ -410,7 +410,7 @@ public static ServiceClientModel.SimpleRetentionPolicy
410410
}
411411
}
412412

413-
// <summary>
413+
/// <summary>
414414
/// Helper function to convert service long term retention policy from ps retention policy.
415415
/// </summary>
416416
public static ServiceClientModel.LongTermRetentionPolicy GetServiceClientLongTermRetentionPolicy(
@@ -446,7 +446,7 @@ public static ServiceClientModel.LongTermRetentionPolicy GetServiceClientLongTer
446446
return serviceClientRetPolicy;
447447
}
448448

449-
// <summary>
449+
/// <summary>
450450
/// Helper function to convert service simple retention policy from ps simple policy.
451451
/// </summary>
452452
public static ServiceClientModel.SimpleRetentionPolicy GetServiceClientSimpleRetentionPolicy(

src/RecoveryServices/RecoveryServices.Backup.Helpers/Conversions/SchedulePolicyConversions.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ public partial class PolicyHelpers
2727
{
2828
#region ServiceClientToPSObject conversions
2929

30-
// <summary>
30+
/// <summary>
3131
/// Helper function to convert ps simple schedule policy from service response.
3232
/// </summary>
3333
public static SimpleSchedulePolicy GetPSSimpleSchedulePolicy(
@@ -92,7 +92,7 @@ public static SimpleSchedulePolicy GetPSSimpleSchedulePolicy(
9292
return psPolicy;
9393
}
9494

95-
// <summary>
95+
/// <summary>
9696
/// Helper function to convert ps simple schedule policy from service response.
9797
/// </summary>
9898
public static SimpleSchedulePolicyV2 GetPSSimpleSchedulePolicyV2(
@@ -166,7 +166,7 @@ public static SimpleSchedulePolicyV2 GetPSSimpleSchedulePolicyV2(
166166
return psPolicy;
167167
}
168168

169-
// <summary>
169+
/// <summary>
170170
/// Helper function to convert ps log schedule policy from service response.
171171
/// </summary>
172172
public static LogSchedulePolicy GetPSLogSchedulePolicy(
@@ -190,7 +190,7 @@ public static LogSchedulePolicy GetPSLogSchedulePolicy(
190190

191191
#region PStoServiceClientObject conversions
192192

193-
// <summary>
193+
/// <summary>
194194
/// Helper function to parse utc time from local time.
195195
/// </summary>
196196
public static List<DateTime> ParseDateTimesToUTC(IList<DateTime?> localTimes, string timeZone)
@@ -222,7 +222,7 @@ public static List<DateTime> ParseDateTimesToUTC(IList<DateTime?> localTimes, st
222222
return utcTimes;
223223
}
224224

225-
// <summary>
225+
/// <summary>
226226
/// Helper function to convert service simple schedule policy from ps schedule policy.
227227
/// </summary>
228228
public static ServiceClientModel.SchedulePolicy GetServiceClientSimpleSchedulePolicy(
@@ -306,7 +306,7 @@ public static ServiceClientModel.LogSchedulePolicy GetServiceClientLogSchedulePo
306306
return serviceClientPolicy;
307307
}
308308

309-
// <summary>
309+
/// <summary>
310310
/// Helper function to get nullable date time list from date time list.
311311
/// </summary>
312312
public static List<DateTime?> GetNullableDateTimeListFromDateTimeList(

src/RecoveryServices/RecoveryServices.Backup.Helpers/ServiceClientHelpers.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ public static string
149149
/// are to be made to contact the backend service.
150150
/// This is determined by the job status of powershell object.
151151
/// </summary>
152-
/// <param name="jobStatus">Powershell job status enum value</param>
152+
/// <param name="pSJobStatus">Powershell job status enum value</param>
153153
/// <returns>Service job status</returns>
154154
public static string
155155
GetServiceClientJobStatus(
@@ -313,7 +313,7 @@ public static void GetSkipTokenFromNextLink(string nextLink, out string skipToke
313313
/// Note: This doesn't work if the string has any extra characters
314314
/// after slash. (CSM ID's generally don't have)
315315
/// </summary>
316-
/// <param name="url"></param>
316+
/// <param name="fullId"></param>
317317
/// <returns></returns>
318318
public static string GetLastIdFromFullId(string fullId)
319319
{

src/RecoveryServices/RecoveryServices.Backup.Helpers/Validations/PolicyValidations.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Helpers
2424
/// </summary>
2525
public partial class PolicyHelpers
2626
{
27-
// <summary>
27+
/// <summary>
2828
/// Helper function to validate long term rentention policy and simple schedule policy.
2929
/// </summary>
3030
public static void ValidateLongTermRetentionPolicyWithSimpleSchedulePolicy(
@@ -121,7 +121,7 @@ public static void ValidateLongTermRetentionPolicyWithSimpleSchedulePolicy(
121121
}
122122
}
123123

124-
// <summary>
124+
/// <summary>
125125
/// Helper function to validate long term rentention policy and simple schedule policy.
126126
/// </summary>
127127
public static void ValidateLongTermRetentionPolicyWithSimpleSchedulePolicy(

src/RecoveryServices/RecoveryServices.Backup.Models/AzureSqlModels/AzureSqlContainer.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public class AzureSqlContainer : ContainerBase
2626
/// </summary>
2727
public ContainerRegistrationStatus Status { get; set; }
2828

29-
// <summary>
29+
/// <summary>
3030
/// Constructor. Takes the service client object representing the container
3131
/// and converts it in to the PS container model
3232
/// </summary>

src/RecoveryServices/RecoveryServices.Backup.Models/AzureSqlModels/AzureSqlItem.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,17 +69,17 @@ public class AzureSqlItemExtendedInfo : ItemExtendedInfoBase
6969
{
7070
/// <summary>
7171
/// Oldest Recovery Point for the Item
72-
/// </summary
72+
/// </summary>
7373
public DateTime? OldestRecoveryPoint { get; set; }
7474

7575
/// <summary>
7676
/// Recovery Points Count for the Item
77-
/// </summary
77+
/// </summary>
7878
public int? RecoveryPointCount { get; set; }
7979

8080
/// <summary>
8181
/// PolicyState for the Item
82-
/// </summary
82+
/// </summary>
8383
public string PolicyState { get; set; }
8484
}
8585
}

src/RecoveryServices/RecoveryServices.Backup.Models/AzureVmWorkloadModels/AzureWorkloadProtectableItem.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ public class AzureWorkloadProtectableItem : ProtectableItemBase
9393
/// Constructor. Takes the service client object representing the protected item
9494
/// and converts it in to the PS protected item model
9595
/// </summary>
96-
/// <param name="protectedItemResource">Service client object representing the protected item resource</param>
96+
/// <param name="workloadProtectableItemResource"></param>
9797
/// <param name="containerName">Name of the container associated with this protected item</param>
9898
/// <param name="containerType">Type of the container associated with this protected item</param>
9999
public AzureWorkloadProtectableItem(WorkloadProtectableItemResource workloadProtectableItemResource,

src/RecoveryServices/RecoveryServices.Backup.Models/Properties/Resources.Designer.cs

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/RecoveryServices/RecoveryServices.Backup.Providers/AzureWorkloadProviderHelper.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -546,8 +546,8 @@ public bool checkInstantRpRetentionRange(int? oldSnapshotRetention, int? newSnap
546546
/// checks if daily retention is reduced first, then weekly, then monthly and then yearly; breaks and return true whenever it finds retention is reduced in any schedule.
547547
/// if retention is not reduced in any schedule, returns false at the end.
548548
/// </summary>
549-
/// <param name="oldRetentionSchedule"></param>
550-
/// <param name="newRetentionSchedule"></param>
549+
/// <param name="newRetentionPolicy"></param>
550+
/// <param name="oldRetentionPolicy"></param>
551551
/// <returns></returns>
552552
public bool checkMUAForLongTermRetentionPolicy(ServiceClientModel.LongTermRetentionPolicy oldRetentionPolicy, ServiceClientModel.LongTermRetentionPolicy newRetentionPolicy)
553553
{
@@ -596,8 +596,8 @@ public bool checkMUAForSimpleRetentionPolicy(ServiceClientModel.SimpleRetentionP
596596
/// checks if daily retention is reduced first, then weekly, then monthly and then yearly; breaks and return true whenever it finds retention is reduced in any schedule.
597597
/// if retention is not reduced in any schedule, returns false at the end.
598598
/// </summary>
599-
/// <param name="oldRetentionSchedule"></param>
600-
/// <param name="newRetentionSchedule"></param>
599+
/// <param name="oldRetentionPolicy"></param>
600+
/// <param name="newRetentionPolicy"></param>
601601
/// <returns></returns>
602602
public bool checkMUAForMSSQLPolicy(ServiceClientModel.AzureVmWorkloadProtectionPolicy oldRetentionPolicy, ServiceClientModel.AzureVmWorkloadProtectionPolicy newRetentionPolicy)
603603
{

0 commit comments

Comments
 (0)