Merge pull request #314 from MabOneSdk/pragrawa-dev1

Adding comments for provider members

Author: pragrawa

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Providers/IPsBackupProvider.cs

@@ -24,6 +24,10 @@
 
 namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.ProviderModel
 {
+    /// <summary>
+    /// This interface contains methods 
+    /// which needs to be implemented by different providers.
+    /// </summary>
     public interface IPsBackupProvider
     {
         void Initialize(Dictionary<System.Enum, object> providerData, ServiceClientAdapter serviceClientAdapter);

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Providers/PsBackupProviderManager.cs

@@ -29,7 +29,14 @@ namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.ProviderModel
     /// </summary>
     public class PsBackupProviderManager
     {
+        /// <summary>
+        /// Dictionary of cmdlet param enums and provider specific objects.
+        /// </summary>
         Dictionary<System.Enum, object> providerData;
+
+        /// <summary>
+        /// Service client adapter object.
+        /// </summary>
         ServiceClientAdapter serviceClientAdapter;
 
         public PsBackupProviderManager(Dictionary<System.Enum, object> providerDataIn, ServiceClientAdapter serviceClientAdapterIn)
@@ -83,11 +90,17 @@ public IPsBackupProvider GetProviderInstance
             return GetProviderInstance(providerType);
         }
 
+        /// <summary>
+        /// To get provider instance for backup management server.
+        /// </summary>
         public IPsBackupProvider GetProviderInstanceForBackupManagementServer()
         {
             return GetProviderInstance(PsBackupProviderTypes.Dpm);
         }
 
+        /// <summary>
+        /// To get provider instance using workload type.
+        /// </summary>
         public IPsBackupProvider GetProviderInstance(WorkloadType workloadType)
         {
             PsBackupProviderTypes providerType = 0;
@@ -106,11 +119,17 @@ public IPsBackupProvider GetProviderInstance(WorkloadType workloadType)
             return GetProviderInstance(providerType);
         }
 
+        /// <summary>
+        /// To get provider instance using container type.
+        /// </summary>
         public IPsBackupProvider GetProviderInstance(ContainerType containerType)
         {
             throw new NotImplementedException();
         }
 
+        /// <summary>
+        /// To get provider instance using workload and backup management type.
+        /// </summary>
         public IPsBackupProvider GetProviderInstance(
             WorkloadType workloadType, BackupManagementType? backupManagementType)
         {
@@ -139,6 +158,9 @@ public IPsBackupProvider GetProviderInstance(
             return GetProviderInstance(psProviderType);
         }
 
+        /// <summary>
+        /// To get provider instance using provider type.
+        /// </summary>
         public IPsBackupProvider GetProviderInstance(PsBackupProviderTypes providerType)
         {
             IPsBackupProvider psBackupProvider = null;