From 0974fdfcbe68117f7b01c8e4b7364d0abfd08829 Mon Sep 17 00:00:00 2001
From: Roy Ben-Shabat <Roy@Twine-s.com>
Date: Sun, 14 Jan 2018 17:11:43 +0200
Subject: Added code comments for: MachineStudio.Stubs.

---
 .../Tango.MachineStudio.Stubs/StubsModule.cs       | 28 ++++++++++++++++++++++
 .../ViewModels/MainViewVM.cs                       |  2 +-
 2 files changed, 29 insertions(+), 1 deletion(-)

(limited to 'Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Stubs')

diff --git a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Stubs/StubsModule.cs b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Stubs/StubsModule.cs
index 2c4b6c76e..23214cf55 100644
--- a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Stubs/StubsModule.cs
+++ b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Stubs/StubsModule.cs
@@ -12,25 +12,53 @@ using Tango.SharedUI.Helpers;
 
 namespace Tango.MachineStudio.Stubs
 {
+    /// <summary>
+    /// Represents a stubs execution Machine Studio module capable of executing stubs against the current connected machine using a C# script engine.
+    /// </summary>
+    /// <seealso cref="Tango.MachineStudio.Common.IStudioModule" />
     public class StubsModule : IStudioModule
     {
+        /// <summary>
+        /// Gets the module name.
+        /// </summary>
         public string Name => "Stubs";
 
+        /// <summary>
+        /// Gets the module description.
+        /// </summary>
         public string Description => "Execute machine tests using an interactive C# scripting editor";
 
+        /// <summary>
+        /// Gets the module cover image.
+        /// </summary>
         public BitmapSource Image => ResourceHelper.GetImageFromResources("Images/stubs.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.RunSynchronizationModule;
 
+        /// <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()
         {
             //throw new NotImplementedException();
         }
 
+        /// <summary>
+        /// Perform any operations required to initialize this module.
+        /// </summary>
         public void Initialize()
         {
             //throw new NotImplementedException();
diff --git a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Stubs/ViewModels/MainViewVM.cs b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Stubs/ViewModels/MainViewVM.cs
index 2490f9cb3..dcb883c88 100644
--- a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Stubs/ViewModels/MainViewVM.cs
+++ b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Stubs/ViewModels/MainViewVM.cs
@@ -21,7 +21,7 @@ using Tango.Transport.Adapters;
 namespace Tango.MachineStudio.Stubs.ViewModels
 {
     /// <summary>
-    /// Represents the script execution utility main view model.
+    /// Represents the script execution module main view model.
     /// </summary>
     /// <seealso cref="Tango.SharedUI.ViewModel" />
     public class MainViewVM : ViewModel , IShutdownRequestBlocker
-- 
cgit v1.3.1