add: documentation for public classes and methods

konnnst · Nov 26, 2023 · b2aaa9c · b2aaa9c
1 parent a569998
commit b2aaa9c
Show file tree

Hide file tree

Showing 5 changed files with 103 additions and 7 deletions.
diff --git a/HW05UNIT/UNIT/Assert.cs b/HW05UNIT/UNIT/Assert.cs
@@ -1,23 +1,42 @@
 namespace Unit;
 
+/// <summary>
+/// Class for asserting statements
+/// </summary>
 public static class Assert
 {
-    public static void IsTrue(bool condition)
+    /// <summary>
+    /// Check if statement is true
+    /// </summary>
+    /// <param name="statement">Statement to check</param>
+    /// <exception cref="Exception">Thrown if statement is false</exception>
+    public static void IsTrue(bool statement)
     {
-        if (!condition)
+        if (!statement)
         {
             throw new Exception("ACHTUNG! Assert.IsTrue failed!");
         }
     }
 
-    public static void IsFalse(bool condition)
+    /// <summary>
+    /// Check if statement is false
+    /// </summary>
+    /// <param name="statement">Statement to check</param>
+    /// <exception cref="Exception">Thrown if statement is true</exception>
+    public static void IsFalse(bool statement)
     {
-        if (condition)
+        if (statement)
         {
             throw new Exception("ACHTUNG! Assert.IsFalse failed");
         }
     }
 
+    /// <summary>
+    /// Check if two objects are equal
+    /// </summary>
+    /// <param name="a">First object</param>
+    /// <param name="b">Second object</param>
+    /// <exception cref="Exception">Thrown if objects are not equal</exception>
     public static void AreEqual(object a, object b)
     {
         if (!a.Equals(b))
@@ -26,6 +45,12 @@ public static void AreEqual(object a, object b)
         }
     }
 
+    /// <summary>
+    /// Check if two objects are not equal
+    /// </summary>
+    /// <param name="a">First object</param>
+    /// <param name="b">Second object</param>
+    /// <exception cref="Exception">Thrown if objects are equal</exception>
     public static void AreNotEqual(object a, object b)
     {
         if (a.Equals(b))
@@ -34,6 +59,11 @@ public static void AreNotEqual(object a, object b)
         }
     }
 
+    /// <summary>
+    /// Check if object is null
+    /// </summary>
+    /// <param name="a">Object</param>
+    /// <exception cref="Exception">Thrown if object is not null</exception>
     public static void IsNull(object a)
     {
         if (a != null)
@@ -42,6 +72,11 @@ public static void IsNull(object a)
         }
     }
 
+    /// <summary>
+    /// Check if object is not null
+    /// </summary>
+    /// <param name="a">Object</param>
+    /// <exception cref="Exception">Thrown if object is null</exception>
     public static void IsNotNull(object a)
     {
         if (a == null)
@@ -50,6 +85,11 @@ public static void IsNotNull(object a)
         }
     }
 
+    /// <summary>
+    /// Fails always
+    /// </summary>
+    /// <param name="message">Custom message to add in exception message</param>
+    /// <exception cref="Exception">Thrown always. Contains custom message</exception>
     public static void Fail(string message)
     {
         if (message.Count() != 0)
@@ -59,6 +99,9 @@ public static void Fail(string message)
         throw new Exception($"ACHTUNG! Failed{message}");
     }
 
+    /// <summary>
+    /// Fails always
+    /// </summary>
     public static void Fail()
     {
         Fail("");

diff --git a/HW05UNIT/UNIT/Attributes.cs b/HW05UNIT/UNIT/Attributes.cs
@@ -1,5 +1,9 @@
 namespace Unit;
 
+
+/// <summary>
+/// Marks test methods
+/// </summary>
 [AttributeUsage(AttributeTargets.Method)]
 public class Test : Attribute
 {
@@ -8,38 +12,65 @@ public class Test : Attribute
 
     public Test() {}
 
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <param name="ignore">Skips marked test method if not "NORMAL" value</param>
     public Test(string ignore)
     {
         Ignore = ignore;
     }
 
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <param name="expected">Expects exceptions, with method noted in expected array</param>
     public Test(string[] expected)
     {
         Expected = expected;
     }
 
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <param name="expected">Expects exceptions, with method noted in expected array</param>
+    /// <param name="ignore">Skips marked test method if not "NORMAL" value</param>
     public Test(string[] expected, string ignore)
     {
         Expected = expected;
         Ignore = ignore;
     }
 }
 
+
+/// <summary>
+/// Marks method running before all test methods
+/// </summary>
 [AttributeUsage(AttributeTargets.Method)]
 public class BeforeClass : Attribute
 {
 }
 
+
+/// <summary>
+/// Marks method running after all test methods
+/// </summary>
 [AttributeUsage(AttributeTargets.Method)]
 public class AfterClass : Attribute
 {
 }
 
+/// <summary>
+/// Marks method running before each test method
+/// </summary>
 [AttributeUsage(AttributeTargets.Method)]
 public class Before : Attribute
 {
 }
 
+/// <summary>
+/// Marks method running after each test method
+/// </summary>
 [AttributeUsage(AttributeTargets.Method)]
 public class After : Attribute
 {

diff --git a/HW05UNIT/UNIT/InfoWriter.cs b/HW05UNIT/UNIT/InfoWriter.cs
@@ -1,5 +1,9 @@
 namespace Unit;
 
+
+/// <summary>
+/// Writes stats and messages in pretty form using templates
+/// </summary>
 public static class InfoWriter
 {
     public static void WriteStatsSpecialMethods(Type t, Action? beforeClass, Action? afterClass,

diff --git a/HW05UNIT/UNIT/TestLauncher.cs b/HW05UNIT/UNIT/TestLauncher.cs
@@ -2,7 +2,10 @@
 
 namespace Unit;
 
-public class TestLauncher
+/// <summary>
+/// Runs tests for every assembly in chosen path
+/// </summary>
+public static class TestLauncher
 {
     private static List<Assembly> assemblies = new();
     private static IEnumerable<string> GetAssemblyPaths(string path)
@@ -25,6 +28,10 @@ private static bool IsAssemblyLoaded(string path)
         return false;
     }
 
+    /// <summary>
+    /// Runs tests for every assembly in chosen path
+    /// </summary>
+    /// <param name="path">Path to folder, holding the assemblies</param>
     public static void RunTests(string path)
     {
         var paths = GetAssemblyPaths(path);

diff --git a/HW05UNIT/UNIT/Tester.cs b/HW05UNIT/UNIT/Tester.cs
@@ -1,10 +1,18 @@
 using System.Diagnostics;
 
 namespace Unit;
+
+/// <summary>
+/// Runs test for given assembly
+/// </summary>
 public class Tester
 {
     private Assembly _asm;
 
+    /// <summary>
+    /// Creates tester object using path
+    /// </summary>
+    /// <param name="asm">Assembly path</param>
     public Tester(Assembly asm)
     {
         _asm = asm;
@@ -150,7 +158,6 @@ private void RunSpecialMethods(Action? beforeClass, Action? afterClass,
                         failedCount++;
                     }
                 }
-               //    Console.WriteLine(stopwatch.ElapsedMilliseconds);
                 elapsedTime.Add(stopwatch.ElapsedMilliseconds);
                 stopwatch.Reset();
 
@@ -166,8 +173,12 @@ private void RunSpecialMethods(Action? beforeClass, Action? afterClass,
         }
 
         InfoWriter.WriteTestResults(elapsedTime, testMethods, failedCount, skippedCount);
-    }
+    } 
+
 
+    /// <summary>
+    /// Runst test methods in selected assembly 
+    /// </summary>
     public void RunTests()
     {
         foreach (var t in _asm.ExportedTypes)