summaryrefslogtreecommitdiff
path: root/doc/classes/bool.xml
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2021-10-31 23:18:32 +0100
committerGitHub <noreply@github.com>2021-10-31 23:18:32 +0100
commit1dd742777a427c9b96c34d87c218bd3ec30a0224 (patch)
treed850e5852f0b75713ba2452bc112e015a0766740 /doc/classes/bool.xml
parent1aef3a42b234b86c5db21d5a64509453e6bf145c (diff)
parent6772ebcea00df6d01be5b333e7b5a5fff1c7a27a (diff)
Merge pull request #53452 from aaronfranke/who-let-the-docs-out
Diffstat (limited to 'doc/classes/bool.xml')
-rw-r--r--doc/classes/bool.xml51
1 files changed, 27 insertions, 24 deletions
diff --git a/doc/classes/bool.xml b/doc/classes/bool.xml
index 39e34a7b96..49f2d2dd7f 100644
--- a/doc/classes/bool.xml
+++ b/doc/classes/bool.xml
@@ -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>