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

---
 .../MachineDesignerModule.cs                       | 28 ++++++++++++++++++++++
 1 file changed, 28 insertions(+)

(limited to 'Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.MachineDesigner/MachineDesignerModule.cs')

diff --git a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.MachineDesigner/MachineDesignerModule.cs b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.MachineDesigner/MachineDesignerModule.cs
index db937028b..ca13bd350 100644
--- a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.MachineDesigner/MachineDesignerModule.cs
+++ b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.MachineDesigner/MachineDesignerModule.cs
@@ -12,25 +12,53 @@ using Tango.SharedUI.Helpers;
 
 namespace Tango.MachineStudio.MachineDesigner
 {
+    /// <summary>
+    /// Represents a machine designer Machine Studio module providing an interactive GUI for managing machine configurations.
+    /// </summary>
+    /// <seealso cref="Tango.MachineStudio.Common.IStudioModule" />
     public class MachineDesignerModule : IStudioModule
     {
+        /// <summary>
+        /// Gets the module name.
+        /// </summary>
         public string Name => "Machine Designer";
 
+        /// <summary>
+        /// Gets the module description.
+        /// </summary>
         public string Description => "Provides a graphical control over machine configurations. Create, manage and deploy machine configurations using simple drag and drop interface.";
 
+        /// <summary>
+        /// Gets the module cover image.
+        /// </summary>
         public BitmapSource Image => ResourceHelper.GetImageFromResources("Images/machine-designer-module.jpg");
 
+        /// <summary>
+        /// Gets the module entry point view.
+        /// </summary>
         public FrameworkElement MainView => new MainView();
 
+        /// <summary>
+        /// Gets the permission required to see and load this module.
+        /// </summary>
         public Permissions Permission => Permissions.RunDeveloperModule;
 
+        /// <summary>
+        /// Gets a value indicating whether this module has been initialized.
+        /// </summary>
         public bool IsInitialized => true;
 
+        /// <summary>
+        /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
+        /// </summary>
         public void Dispose()
         {
             
         }
 
+        /// <summary>
+        /// Perform any operations required to initialize this module.
+        /// </summary>
         public void Initialize()
         {
             
-- 
cgit v1.3.1