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

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

View File

@@ -13,21 +13,21 @@
<return type="Resource">
</return>
<description>
Return the loaded resource (only if loaded). Otherwise, returns null.
Returns the loaded resource (only if loaded). Otherwise, returns null.
</description>
</method>
<method name="get_stage" qualifiers="const">
<return type="int">
</return>
<description>
Return the load stage. The total amount of stages can be queried with [method get_stage_count]
Returns the load stage. The total amount of stages can be queried with [method get_stage_count]
</description>
</method>
<method name="get_stage_count" qualifiers="const">
<return type="int">
</return>
<description>
Return the total amount of stages (calls to [method poll]) needed to completely load this resource.
Returns the total amount of stages (calls to [method poll]) needed to completely load this resource.
</description>
</method>
<method name="poll">