From 7ed962c7206817556e790d048bca38e4e3caf249 Mon Sep 17 00:00:00 2001
From: Roy Ben-Shabat <Roy@Twine-s.com>
Date: Wed, 14 Feb 2018 11:47:21 +0200
Subject: Added code comments for technician module.

---
 .../TechItems/SingleGraphItem.cs                    | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

(limited to 'Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Technician/TechItems/SingleGraphItem.cs')

diff --git a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Technician/TechItems/SingleGraphItem.cs b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Technician/TechItems/SingleGraphItem.cs
index 9d44c6a33..9b19f0861 100644
--- a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Technician/TechItems/SingleGraphItem.cs
+++ b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Technician/TechItems/SingleGraphItem.cs
@@ -10,10 +10,17 @@ using Tango.SharedUI.Helpers;
 
 namespace Tango.MachineStudio.Technician.TechItems
 {
+    /// <summary>
+    /// Represents a single channel real-time graph item.
+    /// </summary>
+    /// <seealso cref="Tango.MachineStudio.Technician.TechItems.TechItem" />
     [TechItem(4)]
     public class SingleGraphItem : TechItem
     {
         private TechMonitor _techMonitor;
+        /// <summary>
+        /// Gets or sets the db tech monitor.
+        /// </summary>
         [XmlIgnore]
         public TechMonitor TechMonitor
         {
@@ -36,9 +43,15 @@ namespace Tango.MachineStudio.Technician.TechItems
             }
         }
 
+        /// <summary>
+        /// Gets or sets the item editor.
+        /// </summary>
         [XmlIgnore]
         public SingleGraphElementEditor Editor { get; set; }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SingleGraphItem"/> class.
+        /// </summary>
         public SingleGraphItem() : base()
         {
             Name = "Single Channel Graph";
@@ -46,11 +59,19 @@ namespace Tango.MachineStudio.Technician.TechItems
             Image = ResourceHelper.GetImageFromResources("Images/single-graph.png");
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SingleGraphItem"/> class.
+        /// </summary>
+        /// <param name="techMonitor">The db tech monitor.</param>
         public SingleGraphItem(TechMonitor techMonitor) : this()
         {
             TechMonitor = techMonitor;
         }
 
+        /// <summary>
+        /// Clones this instance.
+        /// </summary>
+        /// <returns></returns>
         public override TechItem Clone()
         {
             SingleGraphItem cloned = base.Clone() as SingleGraphItem;
-- 
cgit v1.3.1