diff options
Diffstat (limited to 'doc/classes/float.xml')
| -rw-r--r-- | doc/classes/float.xml | 19 |
1 files changed, 13 insertions, 6 deletions
diff --git a/doc/classes/float.xml b/doc/classes/float.xml index 16a696f959..8153d62bc9 100644 --- a/doc/classes/float.xml +++ b/doc/classes/float.xml @@ -12,28 +12,35 @@ <method name="float"> <return type="float"> </return> - <argument index="0" name="from" type="bool"> + <description> + Constructs a default-initialized [float] set to [code]0.0[/code]. + </description> + </method> + <method name="float"> + <return type="float"> + </return> + <argument index="0" name="from" type="float"> </argument> <description> - Cast a [bool] value to a floating-point value, [code]float(true)[/code] will be equal to 1.0 and [code]float(false)[/code] will be equal to 0.0. + Constructs a [float] as a copy of the given [float]. </description> </method> <method name="float"> <return type="float"> </return> - <argument index="0" name="from" type="int"> + <argument index="0" name="from" type="bool"> </argument> <description> - Cast an [int] value to a floating-point value, [code]float(1)[/code] will be equal to 1.0. + Cast a [bool] value to a floating-point value, [code]float(true)[/code] will be equal to 1.0 and [code]float(false)[/code] will be equal to 0.0. </description> </method> <method name="float"> <return type="float"> </return> - <argument index="0" name="from" type="String"> + <argument index="0" name="from" type="int"> </argument> <description> - Cast a [String] value to a floating-point value. This method accepts float value strings like [code]"1.23"[/code] and exponential notation strings for its parameter so calling [code]float("1e3")[/code] will return 1000.0 and calling [code]float("1e-3")[/code] will return 0.001. Calling this method with an invalid float string will return 0. This method stops parsing at the first invalid character and will return the parsed result so far, so calling [code]float("1a3")[/code] will return 1 while calling [code]float("1e3a2")[/code] will return 1000.0. + Cast an [int] value to a floating-point value, [code]float(1)[/code] will be equal to [code]1.0[/code]. </description> </method> </methods> |