summaryrefslogtreecommitdiff
path: root/doc/classes/VisualScriptComment.xml
diff options
context:
space:
mode:
authorNathan Lovato <nathan@gdquest.com>2017-10-03 11:58:06 +0200
committerGitHub <noreply@github.com>2017-10-03 11:58:06 +0200
commitcc407847286e8033252db8caa382857a5601fbf2 (patch)
treed6ba914f2e9c0a2c32f8bdbc24e692ef4d9674d7 /doc/classes/VisualScriptComment.xml
parent6dc1025e6313d711939269e1578fff5ffc0cd30a (diff)
parent10469c1962172db954d02a3912053a99e2a0dfa3 (diff)
Merge pull request #11653 from bojidar-bg/doc-vscript-1
[DOCS] Document some of the VisualScript classes
Diffstat (limited to 'doc/classes/VisualScriptComment.xml')
-rw-r--r--doc/classes/VisualScriptComment.xml6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/classes/VisualScriptComment.xml b/doc/classes/VisualScriptComment.xml
index be4eefd775..da65998e78 100644
--- a/doc/classes/VisualScriptComment.xml
+++ b/doc/classes/VisualScriptComment.xml
@@ -1,8 +1,11 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptComment" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build">
<brief_description>
+ A Visual Script node used to store information for the developer.
</brief_description>
<description>
+ A Visual Script node used to display text, so that code is more readable and better documented.
+ Comment nodes can be resized so they encompass a group of nodes.
</description>
<tutorials>
</tutorials>
@@ -54,10 +57,13 @@
</methods>
<members>
<member name="description" type="String" setter="set_description" getter="get_description">
+ The text inside the comment node.
</member>
<member name="size" type="Vector2" setter="set_size" getter="get_size">
+ The size (in pixels) of the comment node.
</member>
<member name="title" type="String" setter="set_title" getter="get_title">
+ The title of the comment node.
</member>
</members>
<constants>