From 105495646191f2758779256589cac1aa5c583cdc Mon Sep 17 00:00:00 2001
From: Tomasz Chabora <kobewi4e@gmail.com>
Date: Mon, 12 Oct 2020 19:37:50 +0200
Subject: Document remaining Visual Script classes

---
 modules/visual_script/doc_classes/VisualScriptFunctionState.xml | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'modules/visual_script/doc_classes/VisualScriptFunctionState.xml')

diff --git a/modules/visual_script/doc_classes/VisualScriptFunctionState.xml b/modules/visual_script/doc_classes/VisualScriptFunctionState.xml
index 16c1629fe4..54a02bf270 100644
--- a/modules/visual_script/doc_classes/VisualScriptFunctionState.xml
+++ b/modules/visual_script/doc_classes/VisualScriptFunctionState.xml
@@ -1,8 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="VisualScriptFunctionState" inherits="RefCounted" version="4.0">
 	<brief_description>
+		A Visual Script node representing a function state.
 	</brief_description>
 	<description>
+		[VisualScriptFunctionState] is returned from [VisualScriptYield] and can be used to resume a paused function call.
 	</description>
 	<tutorials>
 	</tutorials>
@@ -17,12 +19,14 @@
 			<argument index="2" name="args" type="Array">
 			</argument>
 			<description>
+				Connects this [VisualScriptFunctionState] to a signal in the given object to automatically resume when it's emitted.
 			</description>
 		</method>
 		<method name="is_valid" qualifiers="const">
 			<return type="bool">
 			</return>
 			<description>
+				Returns whether the function state is valid.
 			</description>
 		</method>
 		<method name="resume">
@@ -31,6 +35,7 @@
 			<argument index="0" name="args" type="Array" default="[]">
 			</argument>
 			<description>
+				Resumes the function to run from the point it was yielded.
 			</description>
 		</method>
 	</methods>
-- 
cgit v1.2.3