godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-05 06:11:29 +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.
This commit is contained in:
Rémi Verschelde
2021-07-30 15:28:05 +02:00
parent a1c19b9a1e
commit 7adf4cc9b5
408 changed files with 14025 additions and 28050 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
doc/classes/AnimationNodeStateMachinePlayback.xml
View File

@@ -22,60 +22,50 @@
</tutorials>
<methods>
<method name="get_current_length" qualifiers="const">
<return type="float">
</return>
<return type="float" />
<description>
</description>
</method>
<method name="get_current_node" qualifiers="const">
<return type="StringName">
</return>
<return type="StringName" />
<description>
Returns the currently playing animation state.
</description>
</method>
<method name="get_current_play_position" qualifiers="const">
<return type="float">
</return>
<return type="float" />
<description>
Returns the playback position within the current animation state.
</description>
</method>
<method name="get_travel_path" qualifiers="const">
<return type="PackedStringArray">
</return>
<return type="PackedStringArray" />
<description>
Returns the current travel path as computed internally by the A* algorithm.
</description>
</method>
<method name="is_playing" qualifiers="const">
<return type="bool">
</return>
<return type="bool" />
<description>
Returns [code]true[/code] if an animation is playing.
</description>
</method>
<method name="start">
<return type="void">
</return>
<argument index="0" name="node" type="StringName">
</argument>
<return type="void" />
<argument index="0" name="node" type="StringName" />
<description>
Starts playing the given animation.
</description>
</method>
<method name="stop">
<return type="void">
</return>
<return type="void" />
<description>
Stops the currently playing animation.
</description>
</method>
<method name="travel">
<return type="void">
</return>
<argument index="0" name="to_node" type="StringName">
</argument>
<return type="void" />
<argument index="0" name="to_node" type="StringName" />
<description>
Transitions from the current state to another one, following the shortest path.
</description>