diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2021-01-04 15:01:47 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-04 15:01:47 +0100 |
| commit | 51e5e200e236f506f757b08ee96345fbeec30db0 (patch) | |
| tree | ab32df89fe2cf03de8f807bf4a631ae2997bed9a /doc/classes/@GlobalScope.xml | |
| parent | 8cfec72084e134a41467658da1f5ae5f5567a044 (diff) | |
| parent | 215d18814e3db5371ed7aae9555ac25bf7d1a00e (diff) | |
Merge pull request #44911 from akien-mga/doc-sync
doc: Sync classref with current source
Diffstat (limited to 'doc/classes/@GlobalScope.xml')
| -rw-r--r-- | doc/classes/@GlobalScope.xml | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index c8f216e199..b40ae65a61 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -944,6 +944,22 @@ [/codeblock] </description> </method> + <method name="snapped"> + <return type="float"> + </return> + <argument index="0" name="x" type="float"> + </argument> + <argument index="1" name="step" type="float"> + </argument> + <description> + Snaps float value [code]x[/code] to a given [code]step[/code]. This can also be used to round a floating point number to an arbitrary number of decimals. + [codeblock] + snapped(100, 32) # Returns 96 + snapped(3.14159, 0.01) # Returns 3.14 + [/codeblock] + See also [method ceil], [method floor], and [method round]. + </description> + </method> <method name="sqrt"> <return type="float"> </return> @@ -974,22 +990,6 @@ [/codeblock] </description> </method> - <method name="snapped"> - <return type="float"> - </return> - <argument index="0" name="x" type="float"> - </argument> - <argument index="1" name="step" type="float"> - </argument> - <description> - Snaps float value [code]x[/code] to a given [code]step[/code]. This can also be used to round a floating point number to an arbitrary number of decimals. - [codeblock] - snapped(100, 32) # Returns 96 - snapped(3.14159, 0.01) # Returns 3.14 - [/codeblock] - See also [method ceil], [method floor], and [method round]. - </description> - </method> <method name="str" qualifiers="vararg"> <return type="String"> </return> |