godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-11-17 14:11:06 +00:00
Code Releases Wiki Activity

doc: Make all module docs self-contained

Browse Source
This commit is contained in:
Rémi Verschelde
2017-11-15 19:23:20 +01:00
parent e7701bb2de
commit 677e95d8d1
84 changed files with 142 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
modules/visual_script/doc_classes/VisualScriptComment.xml Normal file
View File

@@ -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>