aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Synchronization/SynchronizationModule.cs
diff options
context:
space:
mode:
Diffstat (limited to 'Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Synchronization/SynchronizationModule.cs')
-rw-r--r--Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Synchronization/SynchronizationModule.cs31
1 files changed, 31 insertions, 0 deletions
diff --git a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Synchronization/SynchronizationModule.cs b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Synchronization/SynchronizationModule.cs
index 039b9faf6..f6381a482 100644
--- a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Synchronization/SynchronizationModule.cs
+++ b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Synchronization/SynchronizationModule.cs
@@ -12,27 +12,58 @@ using Tango.SharedUI.Helpers;
namespace Tango.MachineStudio.Synchronization
{
+ /// <summary>
+ /// Represents a Machine Studio module capable of comparing and synchronizing machines data against Twine remote database.
+ /// </summary>
+ /// <seealso cref="Tango.MachineStudio.Common.IStudioModule" />
public class SynchronizationModule : IStudioModule
{
+ /// <summary>
+ /// The is initialized
+ /// </summary>
private bool _isInitialized;
+ /// <summary>
+ /// Gets the module name.
+ /// </summary>
public string Name => "Synchronization";
+ /// <summary>
+ /// Gets the module description.
+ /// </summary>
public string Description => "Perform local to local or remote to local database synchronization.";
+ /// <summary>
+ /// Gets the module cover image.
+ /// </summary>
public BitmapSource Image => ResourceHelper.GetImageFromResources("Images/synchronization.jpg");
+ /// <summary>
+ /// Gets the module entry point view.
+ /// </summary>
public FrameworkElement MainView => new MainView();
+ /// <summary>
+ /// Gets a value indicating whether this module has been initialized.
+ /// </summary>
public bool IsInitialized => _isInitialized;
+ /// <summary>
+ /// Gets the permission required to see and load this module.
+ /// </summary>
public Permissions Permission => Permissions.RunSynchronizationModule;
+ /// <summary>
+ /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
+ /// </summary>
public void Dispose()
{
//Dispose...
}
+ /// <summary>
+ /// Perform any operations required to initialize this module.
+ /// </summary>
public void Initialize()
{
if (!_isInitialized)