godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-03 18:11:19 +03:00
Code Issues Packages Projects Releases Wiki Activity

doc: Use self-closing tags for return and argument

Browse Source 
For the time being we don't support writing a description for those, preferring
having all details in the method's description.

Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.

(cherry picked from commit 7adf4cc9b5)
This commit is contained in:
Rémi Verschelde
2021-07-30 15:28:05 +02:00
parent c5589c76ce
commit 16fd1c421e
350 changed files with 10551 additions and 21102 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
doc/classes/VisualInstance.xml
View File

@@ -10,59 +10,48 @@
</tutorials>
<methods>
<method name="get_aabb" qualifiers="const">
<return type="AABB">
</return>
<return type="AABB" />
<description>
Returns the [AABB] (also known as the bounding box) for this [VisualInstance]. See also [method get_transformed_aabb].
</description>
</method>
<method name="get_base" qualifiers="const">
<return type="RID">
</return>
<return type="RID" />
<description>
Returns the RID of the resource associated with this [VisualInstance]. For example, if the Node is a [MeshInstance], this will return the RID of the associated [Mesh].
</description>
</method>
<method name="get_instance" qualifiers="const">
<return type="RID">
</return>
<return type="RID" />
<description>
Returns the RID of this instance. This RID is the same as the RID returned by [method VisualServer.instance_create]. This RID is needed if you want to call [VisualServer] functions directly on this [VisualInstance].
</description>
</method>
<method name="get_layer_mask_bit" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="layer" type="int">
</argument>
<return type="bool" />
<argument index="0" name="layer" type="int" />
<description>
Returns [code]true[/code] when the specified layer is enabled in [member layers] and [code]false[/code] otherwise.
</description>
</method>
<method name="get_transformed_aabb" qualifiers="const">
<return type="AABB">
</return>
<return type="AABB" />
<description>
Returns the transformed [AABB] (also known as the bounding box) for this [VisualInstance].
Transformed in this case means the [AABB] plus the position, rotation, and scale of the [Spatial]'s [Transform]. See also [method get_aabb].
</description>
</method>
<method name="set_base">
<return type="void">
</return>
<argument index="0" name="base" type="RID">
</argument>
<return type="void" />
<argument index="0" name="base" type="RID" />
<description>
Sets the resource that is instantiated by this [VisualInstance], which changes how the engine handles the [VisualInstance] under the hood. Equivalent to [method VisualServer.instance_set_base].
</description>
</method>
<method name="set_layer_mask_bit">
<return type="void">
</return>
<argument index="0" name="layer" type="int">
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<return type="void" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="enabled" type="bool" />
<description>
Enables a particular layer in [member layers].
</description>