tiennm99/godot
1
0
Fork 0
mirror of https://github.com/tiennm99/godot.git synced 2026-08-30 12:22:21 +00: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-08-03 10:20:19 +02:00
parent a43365bd58
commit f5836b40d4
356 changed files with 10841 additions and 21682 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/classes/AnimationNodeStateMachinePlayback.xml
+10 -20
View File
@@ -16,60 +16,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="String">
</return>
<return type="String" />
<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="PoolStringArray">
</return>
<return type="PoolStringArray" />
<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="String">
</argument>
<return type="void" />
<argument index="0" name="node" type="String" />
<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="String">
</argument>
<return type="void" />
<argument index="0" name="to_node" type="String" />
<description>
Transitions from the current state to another one, following the shortest path.
</description>