seedlingattempt/godot
1
0
Fork 0
Code Issues Pull Requests Actions 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/AnimatedTexture.xml
View File

@ -13,30 +13,23 @@
</tutorials>
<methods>
<method name="get_frame_delay" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="frame" type="int">
</argument>
<return type="float" />
<argument index="0" name="frame" type="int" />
<description>
Returns the given frame's delay value.
</description>
</method>
<method name="get_frame_texture" qualifiers="const">
<return type="Texture2D">
</return>
<argument index="0" name="frame" type="int">
</argument>
<return type="Texture2D" />
<argument index="0" name="frame" type="int" />
<description>
Returns the given frame's [Texture2D].
</description>
</method>
<method name="set_frame_delay">
<return type="void">
</return>
<argument index="0" name="frame" type="int">
</argument>
<argument index="1" name="delay" type="float">
</argument>
<return type="void" />
<argument index="0" name="frame" type="int" />
<argument index="1" name="delay" type="float" />
<description>
Sets an additional delay (in seconds) between this frame and the next one, that will be added to the time interval defined by [member fps]. By default, frames have no delay defined. If a delay value is defined, the final time interval between this frame and the next will be [code]1.0 / fps + delay[/code].
For example, for an animation with 3 frames, 2 FPS and a frame delay on the second frame of 1.2, the resulting playback will be:
@ -49,12 +42,9 @@
</description>
</method>
<method name="set_frame_texture">
<return type="void">
</return>
<argument index="0" name="frame" type="int">
</argument>
<argument index="1" name="texture" type="Texture2D">
</argument>
<return type="void" />
<argument index="0" name="frame" type="int" />
<argument index="1" name="texture" type="Texture2D" />
<description>
Assigns a [Texture2D] to the given frame. Frame IDs start at 0, so the first frame has ID 0, and the last frame of the animation has ID [member frames] - 1.
You can define any number of textures up to [constant MAX_FRAMES], but keep in mind that only frames from 0 to [member frames] - 1 will be part of the animation.