Variant: Sync docs with new constructors, fixups after #43403

Change DocData comparators for MethodDoc and ArgumentDoc to get a better
ordering of constructors.
This commit is contained in:
Rémi Verschelde
2020-11-09 17:46:03 +01:00
parent efc4d217d6
commit 0f249f5c0a
45 changed files with 764 additions and 647 deletions

View File

@ -9,6 +9,22 @@
<tutorials>
</tutorials>
<methods>
<method name="float">
<return type="float">
</return>
<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>
Constructs a [float] as a copy of the given [float].
</description>
</method>
<method name="float">
<return type="float">
</return>
@ -24,16 +40,7 @@
<argument index="0" name="from" type="int">
</argument>
<description>
Cast an [int] value to a floating-point value, [code]float(1)[/code] will be equal to 1.0.
</description>
</method>
<method name="float">
<return type="float">
</return>
<argument index="0" name="from" type="String">
</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>