noahbackus/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 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
doc/classes/ArrayMesh.xml
+5 -5
View File
@@ -98,7 +98,7 @@
<argument index="0" name="name" type="String">
</argument>
<description>
Return the index of the first surface with this name held within this [ArrayMesh]. If none are found -1 is returned.
Returns the index of the first surface with this name held within this [ArrayMesh]. If none are found -1 is returned.
</description>
</method>
<method name="surface_get_array_index_len" qualifiers="const">
@@ -107,7 +107,7 @@
<argument index="0" name="surf_idx" type="int">
</argument>
<description>
Return the length in indices of the index array in the requested surface (see [method add_surface_from_arrays]).
Returns the length in indices of the index array in the requested surface (see [method add_surface_from_arrays]).
</description>
</method>
<method name="surface_get_array_len" qualifiers="const">
@@ -116,7 +116,7 @@
<argument index="0" name="surf_idx" type="int">
</argument>
<description>
Return the length in vertices of the vertex array in the requested surface (see [method add_surface_from_arrays]).
Returns the length in vertices of the vertex array in the requested surface (see [method add_surface_from_arrays]).
</description>
</method>
<method name="surface_get_format" qualifiers="const">
@@ -125,7 +125,7 @@
<argument index="0" name="surf_idx" type="int">
</argument>
<description>
Return the format mask of the requested surface (see [method add_surface_from_arrays]).
Returns the format mask of the requested surface (see [method add_surface_from_arrays]).
</description>
</method>
<method name="surface_get_name" qualifiers="const">
@@ -143,7 +143,7 @@
<argument index="0" name="surf_idx" type="int">
</argument>
<description>
Return the primitive type of the requested surface (see [method add_surface_from_arrays]).
Returns the primitive type of the requested surface (see [method add_surface_from_arrays]).
</description>
</method>
<method name="surface_remove">