Improve code documentation

Inspiaaa · Sep 5, 2024 · 92e6b46 · 92e6b46
1 parent 293e808
commit 92e6b46
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/CoroutineBase.cs b/src/CoroutineBase.cs
@@ -2,6 +2,7 @@
 using System;
 
 namespace HCoroutines;
+
 /// <summary>
 /// Base class of all coroutines that allows for pausing / resuming / killing / ... the coroutine.
 /// It is also responsible for managing the hierarchical structure and organisation
@@ -21,6 +22,10 @@ public class CoroutineBase
     public bool IsPlaying = false;
 
     // TODO: Add way to set this property.
+
+    /// <summary>
+    /// Determines whether the Update() method is called during process frames or physics frames.
+    /// </summary>
     public CoProcessMode ProcessMode { get; private set; }
 
     public void StartCoroutine(CoroutineBase coroutine)