updated doc comments

jheiling · Aug 13, 2018 · bdf0ea4 · bdf0ea4
1 parent d0a209d
commit bdf0ea4
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 7 deletions.
diff --git a/Scripts/Signal.cs b/Scripts/Signal.cs
@@ -5,6 +5,10 @@
 
 namespace Signals
 {
+    /// <summary>
+    /// Signal with no value.
+    /// Implements the <see cref="ISignal"/> interface.
+    /// </summary>
     [CreateAssetMenu(menuName = "Signals/Signal")]
     public class Signal : ScriptableObject, ISignal
     {
@@ -15,6 +19,9 @@ public class Signal : ScriptableObject, ISignal
 #endif
         [SerializeField] UnityEvent _onTriggered;
 
+        /// <summary>
+        /// Invoked when <see cref="Trigger"/> is called.
+        /// </summary>
         public UnityEvent OnTriggered
         {
             get
@@ -23,6 +30,9 @@ public UnityEvent OnTriggered
             }
         }
 
+        /// <summary>
+        /// Triggers the <see cref="OnTriggered"/> event.
+        /// </summary>
         public void Trigger()
         {
             _onTriggered.Invoke();

diff --git a/Scripts/SignalListener.cs b/Scripts/SignalListener.cs
@@ -17,12 +17,9 @@ public class SignalListener : MonoBehaviour
 #pragma warning restore
 #endif
         [SerializeField] Signal _signal;
-
         [SerializeField] UnityEvent _onTriggered;
-
         [SerializeField] bool _invokeImmediately;
 
-
         protected virtual void Awake()
         {
             if (_onTriggered == null) _onTriggered = new UnityEvent();
@@ -37,6 +34,7 @@ protected virtual void OnDisable()
         {
             RemoveListener();
         }
+
         /// <summary>
         /// The signal whose <see cref="Signal.OnTriggered"/> event is propagated.
         /// </summary>
@@ -54,9 +52,8 @@ public Signal Signal
             }
         }
 
-
         /// <summary>
-        /// Invoked when the <see cref="Signal.OnTriggered"/> of the signal has changed.
+        /// Invoked when <see cref="Signal.Trigger"/> of the <see cref="Signal"/> is called.
         /// </summary>
         public UnityEvent OnTriggered
         {
@@ -67,7 +64,7 @@ public UnityEvent OnTriggered
         }
 
         /// <summary>
-        /// If true the OnChanged event will also be invoked when the SignalListener is enabled or <see cref="Signal"/> is set.
+        /// If true the <see cref="OnChanged"/> event will also be invoked when the SignalListener is enabled or <see cref="Signal"/> is set.
         /// </summary>
         public bool InvokeImmediately
         {
@@ -148,7 +145,7 @@ public ET OnChanged
         }
 
         /// <summary>
-        /// If true the OnChanged event will also be invoked when the SignalListener is enabled or <see cref="Signal"/> is set.
+        /// If true the <see cref="OnChanged"/> event will also be invoked when the SignalListener is enabled or <see cref="Signal"/> is set.
         /// </summary>
         public bool InvokeImmediately
         {