diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2017-11-15 19:23:20 +0100 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2017-11-15 21:29:33 +0100 |
| commit | 677e95d8d189a62e6473b43989012a8258f193a4 (patch) | |
| tree | a68e77b5d7bd8a319131e632da91f6b86acf7768 /modules/visual_script/doc_classes/VisualScriptComment.xml | |
| parent | e7701bb2de30c554f52dc9d3f0110b4001ae18ad (diff) | |
| download | redot-engine-677e95d8d189a62e6473b43989012a8258f193a4.tar.gz | |
doc: Make all module docs self-contained
Diffstat (limited to 'modules/visual_script/doc_classes/VisualScriptComment.xml')
| -rw-r--r-- | modules/visual_script/doc_classes/VisualScriptComment.xml | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/modules/visual_script/doc_classes/VisualScriptComment.xml b/modules/visual_script/doc_classes/VisualScriptComment.xml new file mode 100644 index 0000000000..ea4545f8ef --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptComment.xml @@ -0,0 +1,71 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptComment" inherits="VisualScriptNode" category="Core" version="3.0-alpha"> + <brief_description> + A Visual Script node used to annotate the script. + </brief_description> + <description> + A Visual Script node used to display annotations in the script, so that code may be documented. + Comment nodes can be resized so they encompass a group of nodes. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_description" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_size" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_title" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_description"> + <return type="void"> + </return> + <argument index="0" name="description" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_title"> + <return type="void"> + </return> + <argument index="0" name="title" type="String"> + </argument> + <description> + </description> + </method> + </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 comment node's size (in pixels). + </member> + <member name="title" type="String" setter="set_title" getter="get_title"> + The comment node's title. + </member> + </members> + <constants> + </constants> +</class> |