Add xml comments

intervals-mining-lab · Dec 10, 2024 · 44282dd · 44282dd
1 parent 3561ad5
commit 44282dd
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 2 deletions.
diff --git a/Libiada.Core.Tests/Core/SimpleTypes/ValueStringTests.cs b/Libiada.Core.Tests/Core/SimpleTypes/ValueStringTests.cs
@@ -35,7 +35,7 @@ public void EqualsTest()
         Assert.Multiple(() =>
         {
             Assert.That(new ValueString("1"), Is.EqualTo(new ValueString('1')));
-            Assert.That(new ValueString("abc"), Is.EqualTo(new ValueString("abc")));
+            Assert.That(new ValueString("abc"), Is.EqualTo(new ValueString("ab" + "c")));
         });
     }
 }
diff --git a/Libiada.Core/Attributes/BindingAttribute.cs b/Libiada.Core/Attributes/BindingAttribute.cs
@@ -4,6 +4,10 @@
 
 using Libiada.Core.Core;
 
+/// <summary>
+/// Used to set binding value to other enums.
+/// </summary>
+/// <seealso cref="System.Attribute" />
 [AttributeUsage(AttributeTargets.Field, AllowMultiple = false)]
 public class BindingAttribute : Attribute
 {

diff --git a/Libiada.Core/Attributes/BindingModeAttribute.cs b/Libiada.Core/Attributes/BindingModeAttribute.cs
@@ -4,6 +4,10 @@
 
 using Libiada.Core.Core;
 
+/// <summary>
+/// Used to set binding mode value to other enums.
+/// </summary>
+/// <seealso cref="System.Attribute" />
 [AttributeUsage(AttributeTargets.Field, AllowMultiple = false)]
 public class BindingModeAttribute : Attribute
 {

diff --git a/Libiada.Core/Attributes/LinkAttribute.cs b/Libiada.Core/Attributes/LinkAttribute.cs
@@ -4,6 +4,10 @@
 
 using Libiada.Core.Core;
 
+/// <summary>
+/// Used to set link value to other enums.
+/// </summary>
+/// <seealso cref="System.Attribute" />
 [AttributeUsage(AttributeTargets.Field, AllowMultiple = false)]
 public class LinkAttribute : Attribute
 {

diff --git a/Libiada.Core/Core/Binding.cs b/Libiada.Core/Core/Binding.cs
@@ -3,6 +3,9 @@
 using System.ComponentModel.DataAnnotations;
 using System.ComponentModel;
 
+/// <summary>
+/// Represents binding (reading direction) of the intervals in the sequence.
+/// </summary>
 public enum Binding : byte
 {
     /// <summary>

diff --git a/Libiada.Core/Core/BindingMode.cs b/Libiada.Core/Core/BindingMode.cs
@@ -3,6 +3,11 @@
 using System.ComponentModel.DataAnnotations;
 using System.ComponentModel;
 
+/// <summary>
+/// Represents binding mode of the intervals in the sequence.
+/// In other words which of the intervals on the ends 
+/// of the sequence are taken into account and in what manner.
+/// </summary>
 public enum BindingMode : byte
 {
     /// <summary>
@@ -21,7 +26,8 @@ public enum BindingMode : byte
     Normal = 1,
 
     /// <summary>
-    /// Cyclic binding mode closes sequence into a loop and each element gets one corresponding interval.
+    /// Cyclic binding mode closes sequence into a loop 
+    /// and each element gets one corresponding interval.
     /// </summary>
     [Display(Name = "Cyclic binding mode")]
     [Description("Сloses sequence into a loop and each element gets one corresponding interval")]