Добавлена документация для планировщика задач

OrnaLibs · Jan 21, 2025 · 20e2157 · 20e2157
1 parent 72c9618
commit 20e2157
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/Managers/TaskScheduler.cs b/Managers/TaskScheduler.cs
@@ -1,5 +1,8 @@
 namespace OrnaLibs.Managers
 {
+    /// <summary>
+    /// Планировщик задач
+    /// </summary>
     public static class TaskScheduler
     {
         private static TimeOnly?[] times = null!;
@@ -10,6 +13,11 @@ public static class TaskScheduler
         private static int _interval;
         private static Thread _thread = null!;
 
+        /// <summary>
+        /// Инициализация планировщика
+        /// </summary>
+        /// <param name="countTasks">Количество задач</param>
+        /// <param name="checkInterval">Интервал между проверками задач в секундах</param>
         public static void Init(int countTasks, int checkInterval = 300)
         {
             times = new TimeOnly?[countTasks];
@@ -18,6 +26,12 @@ public static void Init(int countTasks, int checkInterval = 300)
             _interval = checkInterval;
         }
 
+        /// <summary>
+        /// Регистрация задачи
+        /// </summary>
+        /// <param name="time">Время, в которое будет срабатывать действие</param>
+        /// <param name="action">Действие</param>
+        /// <exception cref="OverflowException">Вызывается, когда отсутствует место для регистрации нового задачи</exception>
         public static void RegisterTask(TimeOnly time, Action action)
         {
             if (nullIndex == actions.Length) throw new OverflowException();
@@ -27,6 +41,9 @@ public static void RegisterTask(TimeOnly time, Action action)
             nullIndex++;
         }
 
+        /// <summary>
+        /// Запуск планировщика
+        /// </summary>
         public static void Start()
         {
             _thread = new(Loop)
@@ -62,6 +79,9 @@ private static void Loop()
             }
         }
 
+        /// <summary>
+        /// Отключение и освобожение планировщика
+        /// </summary>
         public static void Dispose() => _thread.Interrupt();
     }
 }