Minor script commenting and docs cleanup.

Synthoid · Sep 10, 2023 · ff1d619 · ff1d619
1 parent d9ddfef
commit ff1d619
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 3 deletions.
diff --git a/...e 3D Extensions/Examples/Substances/Engine Interactions/EngineInitialization_graph_0.meta b/...e 3D Extensions/Examples/Substances/Engine Interactions/EngineInitialization_graph_0.meta
diff --git a/Assets/Plugins/Substance 3D Extensions/Scripts/Runtime/Engine/SubstanceEngineManager.cs b/Assets/Plugins/Substance 3D Extensions/Scripts/Runtime/Engine/SubstanceEngineManager.cs
@@ -129,6 +129,9 @@ public UnityEvent onEnginePostShutdown
             set { m_OnEnginePostShutdown = value; }
         }
 
+        /// <summary>
+        /// Initialize the substance engine. Note: This will do nothing if the engine is already initialized.
+        /// </summary>
         public void InitializeEngine()
         {
             if(IsInitialized)
@@ -157,7 +160,9 @@ public void InitializeEngine()
             onEngineInitialized.Invoke();
         }
 
-
+        /// <summary>
+        /// Shutdown the substance engine.  Note: This will do nothing if the engine is not currently initialized.
+        /// </summary>
         public void ShutdownEngine()
         {
             if(!IsInitialized) return;

diff --git a/docs/scripting/Engine/SubstanceEngineManager.md b/docs/scripting/Engine/SubstanceEngineManager.md
@@ -55,5 +55,5 @@ public class SubstanceParameterExample : MonoBehaviour
 
 | Method | Returns | Description |
 | ------ | ------- | ----------- |
-| InitializeEngine() | void | Set the input values on the graph asset to match the inputs on the given native graph. |
-| ShutdownEngine() | void | Displose all cached runtime native graphs and clear the dictionary cache. |
+| InitializeEngine() | void | Initialize the substance engine. Note: This will do nothing if the engine is already initialized. |
+| ShutdownEngine() | void | Shutdown the substance engine. Note: This will do nothing if the engine is not currently initialized. |