summaryrefslogtreecommitdiff
path: root/modules/visual_script/doc_classes/VisualScriptWhile.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2017-11-15 21:54:21 +0100
committerGitHub <noreply@github.com>2017-11-15 21:54:21 +0100
commitc7f7dd3e3e3592264a05e0dc7ee5f1ea37fad738 (patch)
treea22a88d22bd079a8404150fbf5b870df6046240e /modules/visual_script/doc_classes/VisualScriptWhile.xml
parent4d08e7c4204ff3fa0e17e0de7e5a08ef03968202 (diff)
parent11e07d18bd80c0b7d8836698d98e058750e33660 (diff)
Merge pull request #12954 from akien-mga/docs
Make module docs self-contained and various improvements
Diffstat (limited to 'modules/visual_script/doc_classes/VisualScriptWhile.xml')
-rw-r--r--modules/visual_script/doc_classes/VisualScriptWhile.xml23
1 files changed, 23 insertions, 0 deletions
diff --git a/modules/visual_script/doc_classes/VisualScriptWhile.xml b/modules/visual_script/doc_classes/VisualScriptWhile.xml
new file mode 100644
index 0000000000..f948660997
--- /dev/null
+++ b/modules/visual_script/doc_classes/VisualScriptWhile.xml
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="VisualScriptWhile" inherits="VisualScriptNode" category="Core" version="3.0-alpha">
+ <brief_description>
+ Conditional loop.
+ </brief_description>
+ <description>
+ Loops while a condition is [code]true[/code]. Execution continues out the [code]exit[/code] Sequence port when the loop terminates.
+ [b]Input Ports:[/b]
+ - Sequence: [code]while(cond)[/code]
+ - Data (bool): [code]cond[/code]
+ [b]Output Ports:[/b]
+ - Sequence: [code]repeat[/code]
+ - Sequence: [code]exit[/code]
+ </description>
+ <tutorials>
+ </tutorials>
+ <demos>
+ </demos>
+ <methods>
+ </methods>
+ <constants>
+ </constants>
+</class>