diff options
| author | Roy Ben-Shabat <Roy@Twine-s.com> | 2018-01-16 12:57:23 +0200 |
|---|---|---|
| committer | Roy Ben-Shabat <Roy@Twine-s.com> | 2018-01-16 12:57:23 +0200 |
| commit | c5dba8cec3db88733ee8e1c206c518e27974f867 (patch) | |
| tree | fa005915dfa442dbf33a61742f7f918e8e8a2926 /Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Technician/TechnicianModule.cs | |
| parent | 0fda2ba3ff49bdc1ffc6833f658e2164af187008 (diff) | |
| download | Tango-c5dba8cec3db88733ee8e1c206c518e27974f867.tar.gz Tango-c5dba8cec3db88733ee8e1c206c518e27974f867.zip | |
Added code comments for:
MachineStudio.Technician.
Diffstat (limited to 'Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Technician/TechnicianModule.cs')
| -rw-r--r-- | Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Technician/TechnicianModule.cs | 32 |
1 files changed, 31 insertions, 1 deletions
diff --git a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Technician/TechnicianModule.cs b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Technician/TechnicianModule.cs index b715b6710..4d211acf1 100644 --- a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Technician/TechnicianModule.cs +++ b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Technician/TechnicianModule.cs @@ -12,22 +12,47 @@ using Tango.SharedUI.Helpers; namespace Tango.MachineStudio.Technician { + /// <summary> + /// Represents a machine studio technician module. + /// </summary> + /// <seealso cref="Tango.MachineStudio.Common.IStudioModule" /> public class TechnicianModule : IStudioModule { private bool _isLoaded; + /// <summary> + /// Occurs when the module IsLoaded property has changed. + /// </summary> public event EventHandler<bool> IsLoadedChanged; + /// <summary> + /// Gets the module name. + /// </summary> public string Name => "Technician"; + /// <summary> + /// Gets the module description. + /// </summary> public string Description => "Provides access to low level machine components by exposing diagnostics and profiling tools."; + /// <summary> + /// Gets the module cover image. + /// </summary> public BitmapSource Image => ResourceHelper.GetImageFromResources("Images/technician.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.RunTechnicianModule; + /// <summary> + /// Gets a value indicating whether this module has been initialized. + /// </summary> public bool IsInitialized => true; /// <summary> @@ -39,12 +64,17 @@ namespace Tango.MachineStudio.Technician set { _isLoaded = value; IsLoadedChanged?.Invoke(this, value); } } - + /// <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() { |
