From 0e8f13b369301c58906539f450fce165275949db Mon Sep 17 00:00:00 2001
From: Adam Ramberg <adam@mambojambostudios.com>
Date: Sat, 21 Mar 2020 22:59:30 +0100
Subject: [PATCH] FSM docs

---
 .../FiniteStateMachine/FiniteStateMachine.cs  | 26 ++++++++++++++++---
 1 file changed, 23 insertions(+), 3 deletions(-)

diff --git a/Packages/FSM/Runtime/FiniteStateMachine/FiniteStateMachine.cs b/Packages/FSM/Runtime/FiniteStateMachine/FiniteStateMachine.cs
index 860710b4..835b92bc 100644
--- a/Packages/FSM/Runtime/FiniteStateMachine/FiniteStateMachine.cs
+++ b/Packages/FSM/Runtime/FiniteStateMachine/FiniteStateMachine.cs
@@ -9,7 +9,6 @@ namespace UnityAtoms.FSM
 {
     /// <summary>
     /// This is an implementation of an FSM in Unity Atoms. It is build using a set of states and a set of transitions. A set can only change through dispatching commands defined by the transitions.
-    /// See the website docs for more info on usage.
     /// </summary>
     [EditorIcon("atom-icon-delicate")]
     [CreateAssetMenu(menuName = "Unity Atoms/FSM/Finite State Machine", fileName = "FiniteStateMachine")]
@@ -116,6 +115,11 @@ namespace UnityAtoms.FSM
             _onStateCooldown = null;
         }
 
+        /// <summary>
+        /// Calls the handler on every Update.
+        /// </summary>
+        /// <param name="handler">The handler to called.</param>
+        /// <param name="gameObject">The gameObject where this handler is setup.</param>
         public void OnUpdate(Action<float, string> handler, GameObject gameObject)
         {
             Action<float, string> extendedHandler = null;
@@ -134,6 +138,11 @@ namespace UnityAtoms.FSM
             _onUpdate += extendedHandler;
         }
 
+        /// <summary>
+        /// Calls the handler on every FixedUpdate.
+        /// </summary>
+        /// <param name="handler">The handler to called.</param>
+        /// <param name="gameObject">The gameObject where this hook is setup.</param>
         public void OnFixedUpdate(Action<float, string> handler, GameObject gameObject)
         {
             Action<float, string> extendedHandler = null;
@@ -152,6 +161,9 @@ namespace UnityAtoms.FSM
             _onFixedUpdate += extendedHandler;
         }
 
+        /// <summary>
+        /// Define a command that is going to automatically be dispatched when the condition provided is met.
+        /// </summary>
         public void DispatchWhen(string command, Func<string, bool> func, GameObject gameObject)
         {
             Action<string> extendedHandler = null;
@@ -172,6 +184,12 @@ namespace UnityAtoms.FSM
             _dispatchWhen += extendedHandler;
         }
 
+        /// <summary>
+        /// Called on every state cooldown.
+        /// </summary>
+        /// <param name="state">The state where we want to do something on the cool down.</param>
+        /// <param name="handler">Handler to be called on cooldown.</param>
+        /// <param name="gameObject">The gameObject where this hook is setup.</param>
         public void OnStateCooldown(string state, Action<string> handler, GameObject gameObject)
         {
             Action<string> extendedHandler = null;
@@ -193,6 +211,10 @@ namespace UnityAtoms.FSM
             _onStateCooldown += extendedHandler;
         }
 
+        /// <summary>
+        /// Reset 
+        /// </summary>
+        /// <param name="shouldTriggerEvents">Should we trigger Change Events.</param>
         public override void Reset(bool shouldTriggerEvents = false)
         {
             Validate();
@@ -265,8 +287,6 @@ namespace UnityAtoms.FSM
 
         protected override bool ValueEquals(string other) => false; // Always trigger events even if changing to the same state as previous
 
-
-
         private void Validate()
         {
             for (var i = 0; i < _transitions.List.Count; ++i)