aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.MachineDesigner/MachineDesignerModule.cs
diff options
context:
space:
mode:
authorRoy Ben-Shabat <Roy@Twine-s.com>2018-01-14 17:09:24 +0200
committerRoy Ben-Shabat <Roy@Twine-s.com>2018-01-14 17:09:24 +0200
commite952c7c3e5c4441b60dc0b2dc1641459a35731e3 (patch)
treedd938c686d7efd238cc821001137a70616364376 /Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.MachineDesigner/MachineDesignerModule.cs
parent0bd3760bec105a00efa0fe624da2eb82d85d06c9 (diff)
downloadTango-e952c7c3e5c4441b60dc0b2dc1641459a35731e3.tar.gz
Tango-e952c7c3e5c4441b60dc0b2dc1641459a35731e3.zip
Added code comments for:
MachineStudio.MachineDesigner.
Diffstat (limited to 'Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.MachineDesigner/MachineDesignerModule.cs')
-rw-r--r--Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.MachineDesigner/MachineDesignerModule.cs28
1 files changed, 28 insertions, 0 deletions
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()
{