diff options
author | kobewi <kobewi4e@gmail.com> | 2022-01-02 18:32:49 +0100 |
---|---|---|
committer | kobewi <kobewi4e@gmail.com> | 2022-01-02 21:09:18 +0100 |
commit | 2cad7754617f3d7b434d1e9dd7e9ceb30e93d323 (patch) | |
tree | ddf93784dda1234ebb78fe2e6bdef573e97b5689 /doc/classes | |
parent | 223beef14a6c6a3c904a3810c2fba353994937c2 (diff) |
Fix usage of "Return" in the docs
Diffstat (limited to 'doc/classes')
-rw-r--r-- | doc/classes/CodeEdit.xml | 6 | ||||
-rw-r--r-- | doc/classes/CodeHighlighter.xml | 6 | ||||
-rw-r--r-- | doc/classes/Control.xml | 2 | ||||
-rw-r--r-- | doc/classes/CryptoKey.xml | 2 | ||||
-rw-r--r-- | doc/classes/DisplayServer.xml | 4 | ||||
-rw-r--r-- | doc/classes/EditorImportPlugin.xml | 2 | ||||
-rw-r--r-- | doc/classes/Font.xml | 6 | ||||
-rw-r--r-- | doc/classes/FontData.xml | 4 | ||||
-rw-r--r-- | doc/classes/ParticlesMaterial.xml | 4 | ||||
-rw-r--r-- | doc/classes/String.xml | 2 | ||||
-rw-r--r-- | doc/classes/TextEdit.xml | 2 | ||||
-rw-r--r-- | doc/classes/TextParagraph.xml | 2 | ||||
-rw-r--r-- | doc/classes/TextServer.xml | 6 | ||||
-rw-r--r-- | doc/classes/UndoRedo.xml | 2 |
14 files changed, 25 insertions, 25 deletions
diff --git a/doc/classes/CodeEdit.xml b/doc/classes/CodeEdit.xml index 59da64314b..697b0443f1 100644 --- a/doc/classes/CodeEdit.xml +++ b/doc/classes/CodeEdit.xml @@ -234,7 +234,7 @@ <method name="get_folded_lines" qualifiers="const"> <return type="int[]" /> <description> - Return all lines that are current folded. + Returns all lines that are current folded. </description> </method> <method name="get_text_for_code_completion" qualifiers="const"> @@ -288,7 +288,7 @@ <argument index="0" name="line" type="int" /> <argument index="1" name="column" type="int" default="-1" /> <description> - Return delimiter index if [code]line[/code] [code]column[/code] is in a comment. If [code]column[/code] is not provided, will return delimiter index if the entire [code]line[/code] is a comment. Otherwise [code]-1[/code]. + Returns delimiter index if [code]line[/code] [code]column[/code] is in a comment. If [code]column[/code] is not provided, will return delimiter index if the entire [code]line[/code] is a comment. Otherwise [code]-1[/code]. </description> </method> <method name="is_in_string" qualifiers="const"> @@ -296,7 +296,7 @@ <argument index="0" name="line" type="int" /> <argument index="1" name="column" type="int" default="-1" /> <description> - Return the delimiter index if [code]line[/code] [code]column[/code] is in a string. If [code]column[/code] is not provided, will return the delimiter index if the entire [code]line[/code] is a string. Otherwise [code]-1[/code]. + Returns the delimiter index if [code]line[/code] [code]column[/code] is in a string. If [code]column[/code] is not provided, will return the delimiter index if the entire [code]line[/code] is a string. Otherwise [code]-1[/code]. </description> </method> <method name="is_line_bookmarked" qualifiers="const"> diff --git a/doc/classes/CodeHighlighter.xml b/doc/classes/CodeHighlighter.xml index 064be0c29d..efd8f618e7 100644 --- a/doc/classes/CodeHighlighter.xml +++ b/doc/classes/CodeHighlighter.xml @@ -76,21 +76,21 @@ <return type="bool" /> <argument index="0" name="start_key" type="String" /> <description> - Return [code]true[/code] if the start key exists, else [code]false[/code]. + Returns [code]true[/code] if the start key exists, else [code]false[/code]. </description> </method> <method name="has_keyword_color" qualifiers="const"> <return type="bool" /> <argument index="0" name="keyword" type="String" /> <description> - Return [code]true[/code] if the keyword exists, else [code]false[/code]. + Returns [code]true[/code] if the keyword exists, else [code]false[/code]. </description> </method> <method name="has_member_keyword_color" qualifiers="const"> <return type="bool" /> <argument index="0" name="member_keyword" type="String" /> <description> - Return [code]true[/code] if the member keyword exists, else [code]false[/code]. + Returns [code]true[/code] if the member keyword exists, else [code]false[/code]. </description> </method> <method name="remove_color_region"> diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 39f8980b2c..3d8199831d 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -201,7 +201,7 @@ <argument index="1" name="text" type="String" /> <description> User defined BiDi algorithm override function. - Return [code]Array[/code] of [code]Vector2i[/code] text ranges, in the left-to-right order. Ranges should cover full source [code]text[/code] without overlaps. BiDi algorithm will be used on each range separately. + Returns [code]Array[/code] of [code]Vector2i[/code] text ranges, in the left-to-right order. Ranges should cover full source [code]text[/code] without overlaps. BiDi algorithm will be used on each range separately. </description> </method> <method name="accept_event"> diff --git a/doc/classes/CryptoKey.xml b/doc/classes/CryptoKey.xml index 111da858ea..9e56a41fee 100644 --- a/doc/classes/CryptoKey.xml +++ b/doc/classes/CryptoKey.xml @@ -14,7 +14,7 @@ <method name="is_public_only" qualifiers="const"> <return type="bool" /> <description> - Return [code]true[/code] if this CryptoKey only has the public part, and not the private one. + Returns [code]true[/code] if this CryptoKey only has the public part, and not the private one. </description> </method> <method name="load"> diff --git a/doc/classes/DisplayServer.xml b/doc/classes/DisplayServer.xml index 1ca69057b4..a41875385c 100644 --- a/doc/classes/DisplayServer.xml +++ b/doc/classes/DisplayServer.xml @@ -392,7 +392,7 @@ <method name="screen_get_max_scale" qualifiers="const"> <return type="float" /> <description> - Return the greatest scale factor of all screens. + Returns the greatest scale factor of all screens. [b]Note:[/b] On macOS returned value is [code]2.0[/code] if there is at least one hiDPI (Retina) screen in the system, and [code]1.0[/code] in all other cases. [b]Note:[/b] This method is implemented on macOS. </description> @@ -413,7 +413,7 @@ <return type="float" /> <argument index="0" name="screen" type="int" default="-1" /> <description> - Return the scale factor of the specified screen by index. + Returns the scale factor of the specified screen by index. [b]Note:[/b] On macOS returned value is [code]2.0[/code] for hiDPI (Retina) screen, and [code]1.0[/code] for all other cases. [b]Note:[/b] This method is implemented on macOS. </description> diff --git a/doc/classes/EditorImportPlugin.xml b/doc/classes/EditorImportPlugin.xml index 1f98781bbd..50c227dc0a 100644 --- a/doc/classes/EditorImportPlugin.xml +++ b/doc/classes/EditorImportPlugin.xml @@ -163,7 +163,7 @@ } [/csharp] [/codeblocks] - Return [code]true[/code] to make all options always visible. + Returns [code]true[/code] to make all options always visible. </description> </method> <method name="_get_preset_count" qualifiers="virtual const"> diff --git a/doc/classes/Font.xml b/doc/classes/Font.xml index 275d6b6577..3537fc0b66 100644 --- a/doc/classes/Font.xml +++ b/doc/classes/Font.xml @@ -222,7 +222,7 @@ <return type="float" /> <argument index="0" name="size" type="int" default="16" /> <description> - Return average pixel offset of the underline below the baseline. + Returns average pixel offset of the underline below the baseline. [b]Note:[/b] Real underline position of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate. </description> </method> @@ -230,7 +230,7 @@ <return type="float" /> <argument index="0" name="size" type="int" default="16" /> <description> - Return average thickness of the underline. + Returns average thickness of the underline. [b]Note:[/b] Real underline thickness of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate. </description> </method> @@ -238,7 +238,7 @@ <return type="bool" /> <argument index="0" name="char" type="int" /> <description> - Return [code]true[/code] if a Unicode [code]char[/code] is available in the font. + Returns [code]true[/code] if a Unicode [code]char[/code] is available in the font. </description> </method> <method name="remove_data"> diff --git a/doc/classes/FontData.xml b/doc/classes/FontData.xml index 9889b8945a..0c8386784e 100644 --- a/doc/classes/FontData.xml +++ b/doc/classes/FontData.xml @@ -259,7 +259,7 @@ <return type="Array" /> <argument index="0" name="cache_index" type="int" /> <description> - Return list of the font sizes in the cache. Each size is [code]Vector2i[/code] with font size and outline size. + Returns list of the font sizes in the cache. Each size is [code]Vector2i[/code] with font size and outline size. </description> </method> <method name="get_spacing" qualifiers="const"> @@ -343,7 +343,7 @@ <return type="bool" /> <argument index="0" name="char" type="int" /> <description> - Return [code]true[/code] if a Unicode [code]char[/code] is available in the font. + Returns [code]true[/code] if a Unicode [code]char[/code] is available in the font. </description> </method> <method name="is_antialiased" qualifiers="const"> diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml index 718a1ac80d..6cf0ea2a93 100644 --- a/doc/classes/ParticlesMaterial.xml +++ b/doc/classes/ParticlesMaterial.xml @@ -15,14 +15,14 @@ <return type="float" /> <argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter" /> <description> - Return the maximum value range for the given parameter. + Returns the maximum value range for the given parameter. </description> </method> <method name="get_param_min" qualifiers="const"> <return type="float" /> <argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter" /> <description> - Return the minimum value range for the given parameter. + Returns the minimum value range for the given parameter. </description> </method> <method name="get_param_texture" qualifiers="const"> diff --git a/doc/classes/String.xml b/doc/classes/String.xml index cd6fc10931..d86c577e5e 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -340,7 +340,7 @@ <return type="String" /> <argument index="0" name="parts" type="PackedStringArray" /> <description> - Return a [String] which is the concatenation of the [code]parts[/code]. The separator between elements is the string providing this method. + Returns a [String] which is the concatenation of the [code]parts[/code]. The separator between elements is the string providing this method. Example: [codeblocks] [gdscript] diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index d6738bfb89..26ad20e85b 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -201,7 +201,7 @@ <method name="get_last_full_visible_line" qualifiers="const"> <return type="int" /> <description> - Return the last visible line. Use [method get_last_full_visible_line_wrap_index] for the wrap index. + Returns the last visible line. Use [method get_last_full_visible_line_wrap_index] for the wrap index. </description> </method> <method name="get_last_full_visible_line_wrap_index" qualifiers="const"> diff --git a/doc/classes/TextParagraph.xml b/doc/classes/TextParagraph.xml index 6a510e4a74..ff193a0e4b 100644 --- a/doc/classes/TextParagraph.xml +++ b/doc/classes/TextParagraph.xml @@ -113,7 +113,7 @@ <method name="get_dropcap_rid" qualifiers="const"> <return type="RID" /> <description> - Return drop cap text buffer RID. + Returns drop cap text buffer RID. </description> </method> <method name="get_dropcap_size" qualifiers="const"> diff --git a/doc/classes/TextServer.xml b/doc/classes/TextServer.xml index d7447fcaa2..443716435a 100644 --- a/doc/classes/TextServer.xml +++ b/doc/classes/TextServer.xml @@ -244,7 +244,7 @@ <return type="int" /> <argument index="0" name="font_rid" type="RID" /> <description> - Return the width of the range around the shape between the minimum and maximum representable signed distance. + Returns the width of the range around the shape between the minimum and maximum representable signed distance. </description> </method> <method name="font_get_msdf_size" qualifiers="const"> @@ -295,7 +295,7 @@ <return type="Array" /> <argument index="0" name="font_rid" type="RID" /> <description> - Return list of the font sizes in the cache. Each size is [code]Vector2i[/code] with font size and outline size. + Returns list of the font sizes in the cache. Each size is [code]Vector2i[/code] with font size and outline size. </description> </method> <method name="font_get_spacing" qualifiers="const"> @@ -382,7 +382,7 @@ <argument index="0" name="font_rid" type="RID" /> <argument index="1" name="char" type="int" /> <description> - Return [code]true[/code] if a Unicode [code]char[/code] is available in the font. + Returns [code]true[/code] if a Unicode [code]char[/code] is available in the font. </description> </method> <method name="font_is_antialiased" qualifiers="const"> diff --git a/doc/classes/UndoRedo.xml b/doc/classes/UndoRedo.xml index 044460f569..0bb64fb845 100644 --- a/doc/classes/UndoRedo.xml +++ b/doc/classes/UndoRedo.xml @@ -162,7 +162,7 @@ <method name="get_history_count"> <return type="int" /> <description> - Return how many elements are in the history. + Returns how many elements are in the history. </description> </method> <method name="get_version" qualifiers="const"> |