Added comments to hardware comparison code.

1 files changed, 26 insertions, 2 deletions

diff --git a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.HardwareDesigner/Comparison/HardwareComponentPropertyResult.cs b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.HardwareDesigner/Comparison/HardwareComponentPropertyResult.cs
index d57413af1..f2e006270 100644
--- a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.HardwareDesigner/Comparison/HardwareComponentPropertyResult.cs
+++ b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.HardwareDesigner/Comparison/HardwareComponentPropertyResult.cs
@@ -6,13 +6,37 @@ using System.Threading.Tasks;
 
 namespace Tango.MachineStudio.HardwareDesigner.Comparison
 {
-    public class HardwareComponentPropertyResult
+    /// <summary>
+    /// class HardwareComponentPropertyResult contains 2 values of a property for the comparison hardware versions 
+    /// </summary>
+    /// <seealso cref="Tango.MachineStudio.HardwareDesigner.Comparison.IHasDifference" />
+    public class HardwareComponentPropertyResult: IHasDifference
     {
+        /// <summary>
+        /// Gets or sets the name of the property.
+        /// </summary>
+        /// <value>
+        /// The name of the property.
+        /// </value>
         public String PropertyName { get; set; }
+
+        /// <summary>
+        /// Gets or sets the value1 of one ( left panel) hardware version
+        /// </summary>
+        /// <value>
+        /// The value1.
+        /// </value>
         public String Value1 { get; set; }
+
+        /// <summary>
+        /// Gets or sets the value2 of the second ( right panel) hardware version
+        /// </summary>
+        /// <value>
+        /// The value2.
+        /// </value>
         public String Value2 { get; set; }
 
-        public bool IsDifferent
+        public bool HasDifferences
         {
             get { return Value1 != Value2; }
         }