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/VisualScriptYieldSignal.xml | 9 +++++++++
 1 file changed, 9 insertions(+)

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

diff --git a/modules/visual_script/doc_classes/VisualScriptYieldSignal.xml b/modules/visual_script/doc_classes/VisualScriptYieldSignal.xml
index c59234433f..c6c3188d08 100644
--- a/modules/visual_script/doc_classes/VisualScriptYieldSignal.xml
+++ b/modules/visual_script/doc_classes/VisualScriptYieldSignal.xml
@@ -1,8 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="VisualScriptYieldSignal" inherits="VisualScriptNode" version="4.0">
 	<brief_description>
+		A Visual Script node yielding for a signal.
 	</brief_description>
 	<description>
+		[VisualScriptYieldSignal] will pause the function execution until the provided signal is emitted.
 	</description>
 	<tutorials>
 	</tutorials>
@@ -10,20 +12,27 @@
 	</methods>
 	<members>
 		<member name="base_type" type="StringName" setter="set_base_type" getter="get_base_type" default="&amp;&quot;Object&quot;">
+			The base type to be used when [member call_mode] is set to [constant CALL_MODE_INSTANCE].
 		</member>
 		<member name="call_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptYieldSignal.CallMode" default="0">
+			[code]call_mode[/code] determines the target object to wait for the signal emission. See [enum CallMode] for options.
 		</member>
 		<member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path">
+			The node path to use when [member call_mode] is set to [constant CALL_MODE_NODE_PATH].
 		</member>
 		<member name="signal" type="StringName" setter="set_signal" getter="get_signal" default="&amp;&quot;&quot;">
+			The signal name to be waited for.
 		</member>
 	</members>
 	<constants>
 		<constant name="CALL_MODE_SELF" value="0" enum="CallMode">
+			A signal from this [Object] will be used.
 		</constant>
 		<constant name="CALL_MODE_NODE_PATH" value="1" enum="CallMode">
+			A signal from the given [Node] in the scene tree will be used.
 		</constant>
 		<constant name="CALL_MODE_INSTANCE" value="2" enum="CallMode">
+			A signal from an instanced node with the given type will be used.
 		</constant>
 	</constants>
 </class>
-- 
cgit v1.2.3