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

Change "Return" to "Returns" where necessary in XML documentation

Browse Source 
In many of the XML files it had been noted that when the documentation
refers to a return value, both "Return" and "Returns" are used. This
has now been fixed to only say "Returns".

Fixes #28867
This commit is contained in:
Sean Heffernan
2019-05-23 19:15:43 -07:00
parent a46b8e1ebf
commit 426bcc9941
64 changed files with 193 additions and 193 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
doc/classes/Animation.xml
View File

@@ -263,14 +263,14 @@
<argument index="0" name="path" type="NodePath">
</argument>
<description>
Return the index of the specified track. If the track is not found, return -1.
Returns the index of the specified track. If the track is not found, return -1.
</description>
</method>
<method name="get_track_count" qualifiers="const">
<return type="int">
</return>
<description>
Return the amount of tracks in the animation.
Returns the amount of tracks in the animation.
</description>
</method>
<method name="method_track_get_key_indices" qualifiers="const">
@@ -283,7 +283,7 @@
<argument index="2" name="delta" type="float">
</argument>
<description>
Return all the key indices of a method track, given a position and delta time.
Returns all the key indices of a method track, given a position and delta time.
</description>
</method>
<method name="method_track_get_name" qualifiers="const">
@@ -294,7 +294,7 @@
<argument index="1" name="key_idx" type="int">
</argument>
<description>
Return the method name of a method track.
Returns the method name of a method track.
</description>
</method>
<method name="method_track_get_params" qualifiers="const">
@@ -305,7 +305,7 @@
<argument index="1" name="key_idx" type="int">
</argument>
<description>
Return the arguments values to be called on a method track for a given key in a given track.
Returns the arguments values to be called on a method track for a given key in a given track.
</description>
</method>
<method name="remove_track">
@@ -345,7 +345,7 @@
<argument index="0" name="idx" type="int">
</argument>
<description>
Return the interpolation type of a given track, from the INTERPOLATION_* enum.
Returns the interpolation type of a given track, from the INTERPOLATION_* enum.
</description>
</method>
<method name="track_get_key_count" qualifiers="const">
@@ -354,7 +354,7 @@
<argument index="0" name="idx" type="int">
</argument>
<description>
Return the amount of keys in a given track.
Returns the amount of keys in a given track.
</description>
</method>
<method name="track_get_key_time" qualifiers="const">
@@ -365,7 +365,7 @@
<argument index="1" name="key_idx" type="int">
</argument>
<description>
Return the time at which the key is located.
Returns the time at which the key is located.
</description>
</method>
<method name="track_get_key_transition" qualifiers="const">
@@ -376,7 +376,7 @@
<argument index="1" name="key_idx" type="int">
</argument>
<description>
Return the transition curve (easing) for a specific key (see built-in math function "ease").
Returns the transition curve (easing) for a specific key (see built-in math function "ease").
</description>
</method>
<method name="track_get_key_value" qualifiers="const">
@@ -387,7 +387,7 @@
<argument index="1" name="key_idx" type="int">
</argument>
<description>
Return the value of a given key in a given track.
Returns the value of a given key in a given track.
</description>
</method>
<method name="track_get_path" qualifiers="const">
@@ -438,7 +438,7 @@
<argument index="0" name="idx" type="int">
</argument>
<description>
Return [code]true[/code] if the given track is imported. Else, return [code]false[/code].
Returns [code]true[/code] if the given track is imported. Else, return [code]false[/code].
</description>
</method>
<method name="track_move_down">
@@ -598,7 +598,7 @@
<argument index="1" name="time_sec" type="float">
</argument>
<description>
Return the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position ([Vector3]), rotation ([Quat]) and scale ([Vector3]).
Returns the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position ([Vector3]), rotation ([Quat]) and scale ([Vector3]).
</description>
</method>
<method name="value_track_get_key_indices" qualifiers="const">
@@ -611,7 +611,7 @@
<argument index="2" name="delta" type="float">
</argument>
<description>
Return all the key indices of a value track, given a position and delta time.
Returns all the key indices of a value track, given a position and delta time.
</description>
</method>
<method name="value_track_get_update_mode" qualifiers="const">
@@ -620,7 +620,7 @@
<argument index="0" name="idx" type="int">
</argument>
<description>
Return the update mode of a value track.
Returns the update mode of a value track.
</description>
</method>
<method name="value_track_set_update_mode">