[RS Backup] Fixing 7349803 (documentation fixes) for Job in Cmdlet Layer

Author: dragonfly91

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup/Cmdlets/Jobs/GetAzureRmRecoveryServicesBackupJob.cs

@@ -22,36 +22,58 @@
 namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets
 {
     /// <summary>
-    /// Get list of jobs
+    /// Gets the list of jobs associated with this recovery services vault 
+    /// according to the filters passed via the cmdlet parameters.
     /// </summary>
     [Cmdlet(VerbsCommon.Get, "AzureRmRecoveryServicesBackupJob"), 
     OutputType(typeof(JobBase), typeof(IList<JobBase>))]
     public class GetAzureRmRecoveryServicesBackupJob : RecoveryServicesBackupCmdletBase
     {
+        /// <summary>
+        /// Filter value for status of job.
+        /// </summary>
         [Parameter(Mandatory = false, HelpMessage = ParamHelpMsgs.Job.StatusFilter, Position = 1)]
         [ValidateNotNullOrEmpty]
         public JobStatus? Status { get; set; }
 
+        /// <summary>
+        /// Filter value for type of job.
+        /// </summary>
         [Parameter(Mandatory = false, HelpMessage = ParamHelpMsgs.Job.OperationFilter, Position = 2)]
         [ValidateNotNullOrEmpty]
         public JobOperation? Operation { get; set; }
 
+        /// <summary>
+        /// Beginning value of time range for which jobs have to be fetched.
+        /// </summary>
         [Parameter(Mandatory = false, HelpMessage = ParamHelpMsgs.Job.FromFilter, Position = 3)]
         [ValidateNotNull]
         public DateTime? From { get; set; }
 
+        /// <summary>
+        /// Ending value of time range for which jobs have to be fetched.
+        /// </summary>
         [Parameter(Mandatory = false, HelpMessage = ParamHelpMsgs.Job.ToFilter, Position = 4)]
         [ValidateNotNull]
         public DateTime? To { get; set; }
 
+        /// <summary>
+        /// Filter value for ID of job.
+        /// </summary>
         [Parameter(Mandatory = false, HelpMessage = ParamHelpMsgs.Job.JobIdFilter, Position = 5)]
         [ValidateNotNullOrEmpty]
         public string JobId { get; set; }
 
+        /// <summary>
+        /// Job whose latest object has to be fetched.
+        /// </summary>
         [Parameter(Mandatory = false, HelpMessage = ParamHelpMsgs.Job.JobFilter, Position = 6)]
         [ValidateNotNull]
         public JobBase Job { get; set; }
 
+        /// <summary>
+        /// Filter value for backup management type of job.
+        /// </summary>
         [Parameter(Mandatory = false, HelpMessage = ParamHelpMsgs.Job.BackupManagementTypeFilter)]
         [ValidateNotNullOrEmpty]
         public BackupManagementType? BackupManagementType { get; set; }

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup/Cmdlets/Jobs/GetAzureRmRecoveryServicesBackupJobDetails.cs

@@ -18,18 +18,27 @@
 
 namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets
 {
+    /// <summary>
+    /// Gets detailed information about a particular job.
+    /// </summary>
     [Cmdlet(VerbsCommon.Get, "AzureRmRecoveryServicesBackupJobDetails", 
         DefaultParameterSetName = JobFilterSet), OutputType(typeof(JobBase))]
     public class GetAzureRmRecoveryServicesBackupJobDetails : RecoveryServicesBackupCmdletBase
     {
         protected const string IdFilterSet = "IdFilterSet";
         protected const string JobFilterSet = "JobFilterSet";
 
+        /// <summary>
+        /// Job whose details are to be fetched.
+        /// </summary>
         [Parameter(Mandatory = true, HelpMessage = ParamHelpMsgs.Job.JobFilter, 
             ParameterSetName = JobFilterSet, Position = 1)]
         [ValidateNotNull]
         public JobBase Job { get; set; }
 
+        /// <summary>
+        /// ID of job whose details are to be fetched.
+        /// </summary>
         [Parameter(Mandatory = true, HelpMessage = ParamHelpMsgs.Job.JobIdFilter,
             ParameterSetName = IdFilterSet, Position = 2)]
         [ValidateNotNullOrEmpty]

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup/Cmdlets/Jobs/StopAzureRmRecoveryServicesBackupJob.cs

@@ -24,18 +24,27 @@
 
 namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets
 {
+    /// <summary>
+    /// Cancels a job. Returns the corresponding job object after this operation finishes.
+    /// </summary>
     [Cmdlet("Stop", "AzureRmRecoveryServicesBackupJob", DefaultParameterSetName = JobFilterSet), 
     OutputType(typeof(JobBase))]
     public class StopAzureRmRecoveryServicesBackupJob : RecoveryServicesBackupCmdletBase
     {
         protected const string IdFilterSet = "IdFilterSet";
         protected const string JobFilterSet = "JobFilterSet";
 
+        /// <summary>
+        /// Job which needs to be canceled.
+        /// </summary>
         [Parameter(Mandatory = true, HelpMessage = ParamHelpMsgs.Job.StopJobJobFilter, 
             ParameterSetName = JobFilterSet, Position = 1)]
         [ValidateNotNull]
         public JobBase Job { get; set; }
 
+        /// <summary>
+        /// ID of the job which needs to be canceled.
+        /// </summary>
         [Parameter(Mandatory = true, HelpMessage = ParamHelpMsgs.Job.StopJobJobIdFilter, 
             ParameterSetName = IdFilterSet, Position = 2)]
         [ValidateNotNull]

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup/Cmdlets/Jobs/WaitAzureRmRecoveryServicesBackupJob.cs

@@ -23,14 +23,23 @@
 
 namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets
 {
+    /// <summary>
+    /// Waits for the given job to finish its operation and returns the corresponding job object.
+    /// </summary>
     [Cmdlet("Wait", "AzureRmRecoveryServicesBackupJob"), OutputType(typeof(JobBase), typeof(IList<JobBase>))]
     public class WaitAzureRmRecoveryServicesBackupJob : RecoveryServicesBackupCmdletBase
     {
+        /// <summary>
+        /// Job or List of jobs until end of which the cmdlet should wait.
+        /// </summary>
         [Parameter(Mandatory = true, HelpMessage = ParamHelpMsgs.Job.WaitJobOrListFilter, 
             ValueFromPipeline = true, Position = 1)]
         [ValidateNotNull]
         public object Job { get; set; }
 
+        /// <summary>
+        /// Maximum time to wait before aborting wait in seconds.
+        /// </summary>
         [Parameter(Mandatory = false, HelpMessage = ParamHelpMsgs.Job.WaitJobTimeoutFilter, Position = 2)]
         public long? Timeout { get; set; }
 
@@ -131,6 +140,13 @@ public override void ExecuteCmdlet()
             });
         }
 
+        /// <summary>
+        /// Gets casted object of type T from the input object obj if possible.
+        /// </summary>
+        /// <typeparam name="T">Type into which the object has to be casted.</typeparam>
+        /// <param name="obj">Object to be casted.</param>
+        /// <param name="castedJob">Object after casting.</param>
+        /// <returns></returns>
         private bool GetCastedObjFromPSObj<T>(object obj, out object castedJob) where T : class
         {
             if (obj is PSObject)
@@ -147,8 +163,13 @@ private bool GetCastedObjFromPSObj<T>(object obj, out object castedJob) where T
             return true;
         }
 
-        // Move the following function to a common helper file later when
-        // more functions of this type are required.
+        /// <summary>
+        /// Checks if the job is already in progress.
+        /// TODO: Move the following function to a common helper file later when
+        ///       more functions of this type are required.
+        /// </summary>
+        /// <param name="job">Job to check if it is in progress.</param>
+        /// <returns></returns>
         private bool IsJobInProgress(JobBase job)
         {
             if (job.Status.CompareTo("InProgress") == 0 ||