Move the docs for constructors and operators out of methods section

This commit is contained in:
Aaron Franke
2021-09-20 21:49:02 -05:00
parent f7d852b532
commit 6772ebcea0
40 changed files with 2511 additions and 2232 deletions

View File

@@ -91,71 +91,74 @@
</description>
<tutorials>
</tutorials>
<methods>
<method name="bool" qualifiers="constructor">
<constructors>
<constructor name="bool">
<return type="bool" />
<description>
Constructs a default-initialized [bool] set to [code]false[/code].
</description>
</method>
<method name="bool" qualifiers="constructor">
</constructor>
<constructor name="bool">
<return type="bool" />
<argument index="0" name="from" type="bool" />
<description>
Constructs a [bool] as a copy of the given [bool].
</description>
</method>
<method name="bool" qualifiers="constructor">
</constructor>
<constructor name="bool">
<return type="bool" />
<argument index="0" name="from" type="float" />
<description>
Cast a [float] value to a boolean value, this method will return [code]false[/code] if [code]0.0[/code] is passed in, and [code]true[/code] for all other floats.
</description>
</method>
<method name="bool" qualifiers="constructor">
</constructor>
<constructor name="bool">
<return type="bool" />
<argument index="0" name="from" type="int" />
<description>
Cast an [int] value to a boolean value, this method will return [code]false[/code] if [code]0[/code] is passed in, and [code]true[/code] for all other ints.
</description>
</method>
<method name="operator !=" qualifiers="operator">
</constructor>
</constructors>
<operators>
<operator name="operator !=">
<return type="bool" />
<description>
</description>
</method>
<method name="operator !=" qualifiers="operator">
</operator>
<operator name="operator !=">
<return type="bool" />
<argument index="0" name="right" type="bool" />
<description>
Returns [code]true[/code] if two bools are different, i.e. one is [code]true[/code] and the other is [code]false[/code].
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
</operator>
<operator name="operator &lt;">
<return type="bool" />
<argument index="0" name="right" type="bool" />
<description>
Returns [code]true[/code] if left operand is [code]false[/code] and right operand is [code]true[/code].
Returns [code]true[/code] if the left operand is [code]false[/code] and the right operand is [code]true[/code].
</description>
</method>
<method name="operator ==" qualifiers="operator">
</operator>
<operator name="operator ==">
<return type="bool" />
<description>
Returns [code]true[/code] if two bools are equal, i.e. both are [code]true[/code] or both are [code]false[/code].
</description>
</method>
<method name="operator ==" qualifiers="operator">
</operator>
<operator name="operator ==">
<return type="bool" />
<argument index="0" name="right" type="bool" />
<description>
Returns [code]true[/code] if two bools are equal, i.e. both are [code]true[/code] or both are [code]false[/code].
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
</operator>
<operator name="operator &gt;">
<return type="bool" />
<argument index="0" name="right" type="bool" />
<description>
Returns [code]true[/code] if left operand is [code]true[/code] and right operand is [code]false[/code].
Returns [code]true[/code] if the left operand is [code]true[/code] and the right operand is [code]false[/code].
</description>
</method>
</methods>
</operator>
</operators>
</class>