From bf2bc8f2b1ad463bac3e4354b842a87c2e7b13eb Mon Sep 17 00:00:00 2001
From: Roy Ben-Shabat <Roy@Twine-s.com>
Date: Sun, 14 Jan 2018 17:23:12 +0200
Subject: Added code comments for: MachineStudio.Synchronization

---
 .../ViewModels/DirectSynchronizationViewVM.cs      | 30 +++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

(limited to 'Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Synchronization/ViewModels/DirectSynchronizationViewVM.cs')

diff --git a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Synchronization/ViewModels/DirectSynchronizationViewVM.cs b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Synchronization/ViewModels/DirectSynchronizationViewVM.cs
index 5ea6e7aec..9a6c921d4 100644
--- a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Synchronization/ViewModels/DirectSynchronizationViewVM.cs
+++ b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Synchronization/ViewModels/DirectSynchronizationViewVM.cs
@@ -23,6 +23,10 @@ using Tango.Synchronization.Remote;
 
 namespace Tango.MachineStudio.Synchronization.ViewModels
 {
+    /// <summary>
+    /// Represents the 'Direct Synchronization' view model.
+    /// </summary>
+    /// <seealso cref="Tango.SharedUI.ViewModel" />
     public class DirectSynchronizationViewVM : ViewModel
     {
         private SyncNavigationManager _navigation;
@@ -32,8 +36,14 @@ namespace Tango.MachineStudio.Synchronization.ViewModels
         private INotificationProvider _notification;
         private String _comparedSerialNumber;
 
-        public IStudioApplicationManager ApplicationManager { get; set; }
+        #region Constructors
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="DirectSynchronizationViewVM"/> class.
+        /// </summary>
+        /// <param name="applicationManager">The application manager.</param>
+        /// <param name="navigation">The navigation.</param>
+        /// <param name="notification">The notification.</param>
         public DirectSynchronizationViewVM(IStudioApplicationManager applicationManager, SyncNavigationManager navigation, INotificationProvider notification)
         {
             ApplicationManager = applicationManager;
@@ -49,6 +59,8 @@ namespace Tango.MachineStudio.Synchronization.ViewModels
             CommitAllCommand = new RelayCommand(Synchronize, (x) => Differences.Count > 0 && !IsWorking && SelectedMachine != null);
         }
 
+        #endregion
+
         #region Commands
 
         /// <summary>
@@ -90,6 +102,8 @@ namespace Tango.MachineStudio.Synchronization.ViewModels
 
         #region Properties
 
+        public IStudioApplicationManager ApplicationManager { get; set; }
+
         private bool _isWorking;
         /// <summary>
         /// Gets or sets a value indicating whether this instance is working.
@@ -148,6 +162,9 @@ namespace Tango.MachineStudio.Synchronization.ViewModels
 
         #region Private Methods
 
+        /// <summary>
+        /// Compares the selected machine against the remote database.
+        /// </summary>
         private void Compare()
         {
             if (SelectedMachine.SerialNumber != ApplicationManager.ConnectedMachine.As<ExternalBridgeTcpClient>().SerialNumber)
@@ -236,6 +253,9 @@ namespace Tango.MachineStudio.Synchronization.ViewModels
             });
         }
 
+        /// <summary>
+        /// Synchronizes the selected machine with the remote database.
+        /// </summary>
         private void Synchronize()
         {
             if (IsClearMachine)
@@ -313,11 +333,19 @@ namespace Tango.MachineStudio.Synchronization.ViewModels
             });
         }
 
+        /// <summary>
+        /// Displays an error message.
+        /// </summary>
+        /// <param name="message">The message.</param>
         private void ShowError(String message)
         {
             InvokeUINow(() => _notification.ShowError(message));
         }
 
+        /// <summary>
+        /// Displays an information message.
+        /// </summary>
+        /// <param name="message">The message.</param>
         private void ShowInfo(String message)
         {
             InvokeUINow(() => _notification.ShowInfo(message));
-- 
cgit v1.3.1