Fix Az.RecoveryServices XML Comments (#18484)

* Fix Az.RecoveryServices XML Comments * Fix Az.RecoveryServices XML Comments 1
Azure · Jun 21, 2022 · 4f22491 · 4f22491
1 parent 23ba64c
commit 4f22491
Show file tree

Hide file tree

Showing 53 changed files with 241 additions and 131 deletions.
diff --git a/src/RecoveryServices/RecoveryServices.Backup.Helpers/Conversions/RecoveryPointConversions.cs b/src/RecoveryServices/RecoveryServices.Backup.Helpers/Conversions/RecoveryPointConversions.cs
@@ -61,8 +61,8 @@ public static List<RecoveryPointBase> FilterRPsBasedOnTier(List<RecoveryPointBas
         /// filter move readness based on target tier
         /// </summary>
         /// <param name="recoveryPointList"></param>
-        /// <param name="TargetTier"></param>
-        /// <param name="IsReadyForMove"></param>
+        /// <param name="targetTier"></param>
+        /// <param name="isReadyForMove"></param>
         /// <returns></returns>
         public static List<RecoveryPointBase> CheckRPMoveReadiness(List<RecoveryPointBase> recoveryPointList, RecoveryPointTier targetTier, bool isReadyForMove)
         {
@@ -220,7 +220,7 @@ public static List<RecoveryPointBase> GetPSAzureRecoveryPointsForSecondaryRegion
             return result;
         }
 
-        // <summary>
+        /// <summary>
         /// Helper function to convert ps recovery point model from service response.
         /// </summary>
         public static RecoveryPointBase GetPSAzureRecoveryPoints(
@@ -259,7 +259,7 @@ public static RecoveryPointBase GetPSAzureRecoveryPoints(
             return result;
         }
 
-        // <summary>
+        /// <summary>
         /// Helper function to convert ps recovery point model from service response.
         /// </summary>
         public static RecoveryPointBase GetPSAzureRecoveryPointsFromSecondaryRegion(

diff --git a/...ecoveryServices/RecoveryServices.Backup.Helpers/Conversions/RetentionPolicyConversions.cs b/...ecoveryServices/RecoveryServices.Backup.Helpers/Conversions/RetentionPolicyConversions.cs
@@ -30,7 +30,7 @@ public partial class PolicyHelpers
 
         #region public
 
-        // <summary>
+        /// <summary>
         /// Helper function to convert ps long term retention policy from service response.
         /// </summary>
         public static LongTermRetentionPolicy GetPSLongTermRetentionPolicy(
@@ -410,7 +410,7 @@ public static ServiceClientModel.SimpleRetentionPolicy
             }
         }
 
-        // <summary>
+        /// <summary>
         /// Helper function to convert service long term retention policy from ps retention policy.
         /// </summary>
         public static ServiceClientModel.LongTermRetentionPolicy GetServiceClientLongTermRetentionPolicy(
@@ -446,7 +446,7 @@ public static ServiceClientModel.LongTermRetentionPolicy GetServiceClientLongTer
             return serviceClientRetPolicy;
         }
 
-        // <summary>
+        /// <summary>
         /// Helper function to convert service simple retention policy from ps simple policy.
         /// </summary>
         public static ServiceClientModel.SimpleRetentionPolicy GetServiceClientSimpleRetentionPolicy(

diff --git a/...RecoveryServices/RecoveryServices.Backup.Helpers/Conversions/SchedulePolicyConversions.cs b/...RecoveryServices/RecoveryServices.Backup.Helpers/Conversions/SchedulePolicyConversions.cs
@@ -27,7 +27,7 @@ public partial class PolicyHelpers
     {
         #region ServiceClientToPSObject conversions
 
-        // <summary>
+        /// <summary>
         /// Helper function to convert ps simple schedule policy from service response.
         /// </summary>
         public static SimpleSchedulePolicy GetPSSimpleSchedulePolicy(
@@ -92,7 +92,7 @@ public static SimpleSchedulePolicy GetPSSimpleSchedulePolicy(
             return psPolicy;
         }
 
-        // <summary>
+        /// <summary>
         /// Helper function to convert ps simple schedule policy from service response.
         /// </summary>
         public static SimpleSchedulePolicyV2 GetPSSimpleSchedulePolicyV2(
@@ -166,7 +166,7 @@ public static SimpleSchedulePolicyV2 GetPSSimpleSchedulePolicyV2(
             return psPolicy;
         }
 
-        // <summary>
+        /// <summary>
         /// Helper function to convert ps log schedule policy from service response.
         /// </summary>
         public static LogSchedulePolicy GetPSLogSchedulePolicy(
@@ -190,7 +190,7 @@ public static LogSchedulePolicy GetPSLogSchedulePolicy(
 
         #region PStoServiceClientObject conversions
 
-        // <summary>
+        /// <summary>
         /// Helper function to parse utc time from local time.
         /// </summary>
         public static List<DateTime> ParseDateTimesToUTC(IList<DateTime?> localTimes, string timeZone)
@@ -222,7 +222,7 @@ public static List<DateTime> ParseDateTimesToUTC(IList<DateTime?> localTimes, st
             return utcTimes;
         }
 
-        // <summary>
+        /// <summary>
         /// Helper function to convert service simple schedule policy from ps schedule policy.
         /// </summary>
         public static ServiceClientModel.SchedulePolicy GetServiceClientSimpleSchedulePolicy(
@@ -306,7 +306,7 @@ public static ServiceClientModel.LogSchedulePolicy GetServiceClientLogSchedulePo
             return serviceClientPolicy;
         }
 
-        // <summary>
+        /// <summary>
         /// Helper function to get nullable date time list from date time list.
         /// </summary>
         public static List<DateTime?> GetNullableDateTimeListFromDateTimeList(

diff --git a/src/RecoveryServices/RecoveryServices.Backup.Helpers/ServiceClientHelpers.cs b/src/RecoveryServices/RecoveryServices.Backup.Helpers/ServiceClientHelpers.cs
@@ -149,7 +149,7 @@ public static string
         /// are to be made to contact the backend service. 
         /// This is determined by the job status of powershell object.
         /// </summary>
-        /// <param name="jobStatus">Powershell job status enum value</param>
+        /// <param name="pSJobStatus">Powershell job status enum value</param>
         /// <returns>Service job status</returns>
         public static string
             GetServiceClientJobStatus(
@@ -313,7 +313,7 @@ public static void GetSkipTokenFromNextLink(string nextLink, out string skipToke
         /// Note: This doesn't work if the string has any extra characters
         /// after slash. (CSM ID's generally don't have)
         /// </summary>
-        /// <param name="url"></param>
+        /// <param name="fullId"></param>
         /// <returns></returns>
         public static string GetLastIdFromFullId(string fullId)
         {

diff --git a/src/RecoveryServices/RecoveryServices.Backup.Helpers/Validations/PolicyValidations.cs b/src/RecoveryServices/RecoveryServices.Backup.Helpers/Validations/PolicyValidations.cs
@@ -24,7 +24,7 @@ namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Helpers
     /// </summary>
     public partial class PolicyHelpers
     {
-        // <summary>
+        /// <summary>
         /// Helper function to validate long term rentention policy and simple schedule policy.
         /// </summary>
         public static void ValidateLongTermRetentionPolicyWithSimpleSchedulePolicy(
@@ -121,7 +121,7 @@ public static void ValidateLongTermRetentionPolicyWithSimpleSchedulePolicy(
             }
         }
 
-        // <summary>
+        /// <summary>
         /// Helper function to validate long term rentention policy and simple schedule policy.
         /// </summary>
         public static void ValidateLongTermRetentionPolicyWithSimpleSchedulePolicy(

diff --git a/src/RecoveryServices/RecoveryServices.Backup.Models/AzureSqlModels/AzureSqlContainer.cs b/src/RecoveryServices/RecoveryServices.Backup.Models/AzureSqlModels/AzureSqlContainer.cs
@@ -26,7 +26,7 @@ public class AzureSqlContainer : ContainerBase
         /// </summary>
         public ContainerRegistrationStatus Status { get; set; }
 
-        // <summary>
+        /// <summary>
         /// Constructor. Takes the service client object representing the container 
         /// and converts it in to the PS container model
         /// </summary>

diff --git a/src/RecoveryServices/RecoveryServices.Backup.Models/AzureSqlModels/AzureSqlItem.cs b/src/RecoveryServices/RecoveryServices.Backup.Models/AzureSqlModels/AzureSqlItem.cs
@@ -69,17 +69,17 @@ public class AzureSqlItemExtendedInfo : ItemExtendedInfoBase
     {
         /// <summary>
         /// Oldest Recovery Point for the Item
-        /// </summary
+        /// </summary>
         public DateTime? OldestRecoveryPoint { get; set; }
 
         /// <summary>
         /// Recovery Points Count for the Item
-        /// </summary
+        /// </summary>
         public int? RecoveryPointCount { get; set; }
 
         /// <summary>
         /// PolicyState for the Item
-        /// </summary
+        /// </summary>
         public string PolicyState { get; set; }
     }
 }
diff --git a/...ices/RecoveryServices.Backup.Models/AzureVmWorkloadModels/AzureWorkloadProtectableItem.cs b/...ices/RecoveryServices.Backup.Models/AzureVmWorkloadModels/AzureWorkloadProtectableItem.cs
@@ -93,7 +93,7 @@ public class AzureWorkloadProtectableItem : ProtectableItemBase
         /// Constructor. Takes the service client object representing the protected item 
         /// and converts it in to the PS protected item model
         /// </summary>
-        /// <param name="protectedItemResource">Service client object representing the protected item resource</param>
+        /// <param name="workloadProtectableItemResource"></param>
         /// <param name="containerName">Name of the container associated with this protected item</param>
         /// <param name="containerType">Type of the container associated with this protected item</param>
         public AzureWorkloadProtectableItem(WorkloadProtectableItemResource workloadProtectableItemResource,

diff --git a/src/RecoveryServices/RecoveryServices.Backup.Models/Properties/Resources.Designer.cs b/src/RecoveryServices/RecoveryServices.Backup.Models/Properties/Resources.Designer.cs
diff --git a/src/RecoveryServices/RecoveryServices.Backup.Providers/AzureWorkloadProviderHelper.cs b/src/RecoveryServices/RecoveryServices.Backup.Providers/AzureWorkloadProviderHelper.cs
@@ -546,8 +546,8 @@ public bool checkInstantRpRetentionRange(int? oldSnapshotRetention, int? newSnap
         /// 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.
         /// if retention is not reduced in any schedule, returns false at the end.
         /// </summary>
-        /// <param name="oldRetentionSchedule"></param>
-        /// <param name="newRetentionSchedule"></param>
+        /// <param name="newRetentionPolicy"></param>
+        /// <param name="oldRetentionPolicy"></param>
         /// <returns></returns>
         public bool checkMUAForLongTermRetentionPolicy(ServiceClientModel.LongTermRetentionPolicy oldRetentionPolicy, ServiceClientModel.LongTermRetentionPolicy newRetentionPolicy)
         {
@@ -596,8 +596,8 @@ public bool checkMUAForSimpleRetentionPolicy(ServiceClientModel.SimpleRetentionP
         /// 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.
         /// if retention is not reduced in any schedule, returns false at the end.
         /// </summary>
-        /// <param name="oldRetentionSchedule"></param>
-        /// <param name="newRetentionSchedule"></param>
+        /// <param name="oldRetentionPolicy"></param>
+        /// <param name="newRetentionPolicy"></param>
         /// <returns></returns>
         public bool checkMUAForMSSQLPolicy(ServiceClientModel.AzureVmWorkloadProtectionPolicy oldRetentionPolicy, ServiceClientModel.AzureVmWorkloadProtectionPolicy newRetentionPolicy)
         {            

diff --git a/src/RecoveryServices/RecoveryServices.Backup.Providers/Providers/IaasVmPsBackupProvider.cs b/src/RecoveryServices/RecoveryServices.Backup.Providers/Providers/IaasVmPsBackupProvider.cs
@@ -1635,6 +1635,7 @@ private static string GetAzureIaasVirtualMachineId(
         /// Generates ILR Response object for Windows VMs
         /// </summary>
         /// <param name="clientScriptForConnection"></param>
+        /// <param name="content"></param>
         /// <returns></returns>
         private AzureVmRPMountScriptDetails GenerateILRResponseForWindowsVMs(
             ClientScriptForConnect clientScriptForConnection, out string content)
@@ -1686,6 +1687,7 @@ private AzureVmRPMountScriptDetails GenerateILRResponseForWindowsVMs(
         /// <param name="clientScriptForConnection"></param>
         /// <param name="protectedItemName"></param>
         /// <param name="recoveryPointTime"></param>
+        /// <param name="content"></param>
         /// <returns></returns>
         private AzureVmRPMountScriptDetails GenerateILRResponseForLinuxVMs(
             ClientScriptForConnect clientScriptForConnection,

diff --git a/src/RecoveryServices/RecoveryServices.Backup.ServiceClientAdapter/BMSAPIs/ContainerAPIs.cs b/src/RecoveryServices/RecoveryServices.Backup.ServiceClientAdapter/BMSAPIs/ContainerAPIs.cs
@@ -29,6 +29,8 @@ public partial class ServiceClientAdapter
         /// </summary>
         /// <param name="containerName">Name of the container to unregister</param>
         /// <param name="queryFilter">Query parameters</param>
+        /// <param name="vaultName"></param>
+        /// <param name="resourceGroupName"></param>
         /// <returns>Response of the job created in the service</returns>
         public RestAzureNS.AzureOperationResponse InquireContainer(
             string containerName,
@@ -50,6 +52,8 @@ public RestAzureNS.AzureOperationResponse InquireContainer(
         /// </summary>
         /// <param name="queryFilter">Query parameters</param>
         /// <param name="skipToken">Skip token for pagination</param>
+        /// <param name="vaultName"></param>
+        /// <param name="resourceGroupName"></param>
         /// <returns>List of protection containers</returns>
         public IEnumerable<ProtectionContainerResource> ListContainers(
             ODataQuery<BMSContainerQueryObject> queryFilter,
@@ -98,6 +102,8 @@ public ProtectionContainerResource GetContainer(
         /// Fetches backup engines in the vault according to the query params
         /// </summary>
         /// <param name="queryParams">Query parameters</param>
+        /// <param name="vaultName"></param>
+        /// <param name="resourceGroupName"></param>
         /// <returns>List of backup engines</returns>
         public IEnumerable<BackupEngineBaseResource> ListBackupEngines(
             ODataQuery<BMSBackupEnginesQueryObject> queryParams,
@@ -124,7 +130,8 @@ public IEnumerable<BackupEngineBaseResource> ListBackupEngines(
         /// Fetches unregistered containers in the vault according to the query params
         /// </summary>
         /// <param name="queryFilter">Query parameters</param>
-        /// <param name="skipToken">Skip token for pagination</param>
+        /// <param name="vaultName"></param>
+        /// <param name="resourceGroupName"></param>
         /// <returns>List of protectable containers</returns>
         public IEnumerable<ProtectableContainerResource> ListUnregisteredContainers(
             ODataQuery<BMSContainerQueryObject> queryFilter,
@@ -206,6 +213,8 @@ public RestAzureNS.AzureOperationResponse<ProtectionContainerResource> RegisterC
         /// Triggers unregister of a container in service
         /// </summary>
         /// <param name="containerName">Name of the container to unregister</param>
+        /// <param name="vaultName"></param>
+        /// <param name="resourceGroupName"></param>
         public RestAzureNS.AzureOperationResponse UnregisterContainers(
             string containerName,
             string vaultName = null,
@@ -223,6 +232,8 @@ public RestAzureNS.AzureOperationResponse UnregisterContainers(
         /// Triggers unregister of a workload container in service
         /// </summary>
         /// <param name="containerName">Name of the container to unregister</param>
+        /// <param name="vaultName"></param>
+        /// <param name="resourceGroupName"></param>
         public RestAzureNS.AzureOperationResponse UnregisterWorkloadContainers(
             string containerName,
             string vaultName = null,