Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move the docs for constructors and operators out of methods section #53452

Merged
merged 1 commit into from
Oct 31, 2021
Merged

Move the docs for constructors and operators out of methods section #53452

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions core/doc_data.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,9 @@ class DocData {
String brief_description;
String description;
Vector<TutorialDoc> tutorials;
Vector<MethodDoc> constructors;
Vector<MethodDoc> methods;
Vector<MethodDoc> operators;
Vector<MethodDoc> signals;
Vector<ConstantDoc> constants;
Map<String, String> enums;
Expand Down
64 changes: 34 additions & 30 deletions doc/classes/AABB.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,28 +13,30 @@
<link title="Vector math">https://docs.godotengine.org/en/latest/tutorials/math/vector_math.html</link>
<link title="Advanced vector math">https://docs.godotengine.org/en/latest/tutorials/math/vectors_advanced.html</link>
</tutorials>
<methods>
<method name="AABB" qualifiers="constructor">
<constructors>
<constructor name="AABB">
<return type="AABB" />
<description>
Constructs a default-initialized [AABB] with default (zero) values of [member position] and [member size].
</description>
</method>
<method name="AABB" qualifiers="constructor">
</constructor>
<constructor name="AABB">
<return type="AABB" />
<argument index="0" name="from" type="AABB" />
<description>
Constructs an [AABB] as a copy of the given [AABB].
</description>
</method>
<method name="AABB" qualifiers="constructor">
</constructor>
<constructor name="AABB">
<return type="AABB" />
<argument index="0" name="position" type="Vector3" />
<argument index="1" name="size" type="Vector3" />
<description>
Constructs an [AABB] from a position and size.
</description>
</method>
</constructor>
</constructors>
<methods>
<method name="abs" qualifiers="const">
<return type="AABB" />
<description>
Expand Down Expand Up @@ -193,45 +195,47 @@
Returns a larger [AABB] that contains both this [AABB] and [code]with[/code].
</description>
</method>
<method name="operator !=" qualifiers="operator">
</methods>
<members>
<member name="end" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)">
Ending corner. This is calculated as [code]position + size[/code]. Setting this value will change the size.
</member>
<member name="position" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)">
Beginning corner. Typically has values lower than [member end].
</member>
<member name="size" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)">
Size from [member position] to [member end]. Typically, all components are positive.
If the size is negative, you can use [method abs] to fix it.
</member>
</members>
<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="AABB" />
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
</operator>
<operator name="operator *">
<return type="AABB" />
<argument index="0" name="right" type="Transform3D" />
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
</operator>
<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="AABB" />
<description>
</description>
</method>
</methods>
<members>
<member name="end" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)">
Ending corner. This is calculated as [code]position + size[/code]. Setting this value will change the size.
</member>
<member name="position" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)">
Beginning corner. Typically has values lower than [member end].
</member>
<member name="size" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)">
Size from [member position] to [member end]. Typically, all components are positive.
If the size is negative, you can use [method abs] to fix it.
</member>
</members>
</operator>
</operators>
</class>
166 changes: 85 additions & 81 deletions doc/classes/Array.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,83 +44,85 @@
</description>
<tutorials>
</tutorials>
<methods>
<method name="Array" qualifiers="constructor">
<constructors>
<constructor name="Array">
<return type="Array" />
<description>
Constructs an empty [Array].
</description>
</method>
<method name="Array" qualifiers="constructor">
</constructor>
<constructor name="Array">
<return type="Array" />
<argument index="0" name="from" type="Array" />
<description>
Constructs an [Array] as a copy of the given [Array].
</description>
</method>
<method name="Array" qualifiers="constructor">
</constructor>
<constructor name="Array">
<return type="Array" />
<argument index="0" name="from" type="PackedByteArray" />
<description>
Constructs an array from a [PackedByteArray].
</description>
</method>
<method name="Array" qualifiers="constructor">
</constructor>
<constructor name="Array">
<return type="Array" />
<argument index="0" name="from" type="PackedColorArray" />
<description>
Constructs an array from a [PackedColorArray].
</description>
</method>
<method name="Array" qualifiers="constructor">
</constructor>
<constructor name="Array">
<return type="Array" />
<argument index="0" name="from" type="PackedFloat32Array" />
<description>
Constructs an array from a [PackedFloat32Array].
</description>
</method>
<method name="Array" qualifiers="constructor">
</constructor>
<constructor name="Array">
<return type="Array" />
<argument index="0" name="from" type="PackedFloat64Array" />
<description>
Constructs an array from a [PackedFloat64Array].
</description>
</method>
<method name="Array" qualifiers="constructor">
</constructor>
<constructor name="Array">
<return type="Array" />
<argument index="0" name="from" type="PackedInt32Array" />
<description>
Constructs an array from a [PackedInt32Array].
</description>
</method>
<method name="Array" qualifiers="constructor">
</constructor>
<constructor name="Array">
<return type="Array" />
<argument index="0" name="from" type="PackedInt64Array" />
<description>
Constructs an array from a [PackedInt64Array].
</description>
</method>
<method name="Array" qualifiers="constructor">
</constructor>
<constructor name="Array">
<return type="Array" />
<argument index="0" name="from" type="PackedStringArray" />
<description>
Constructs an array from a [PackedStringArray].
</description>
</method>
<method name="Array" qualifiers="constructor">
</constructor>
<constructor name="Array">
<return type="Array" />
<argument index="0" name="from" type="PackedVector2Array" />
<description>
Constructs an array from a [PackedVector2Array].
</description>
</method>
<method name="Array" qualifiers="constructor">
</constructor>
<constructor name="Array">
<return type="Array" />
<argument index="0" name="from" type="PackedVector3Array" />
<description>
Constructs an array from a [PackedVector3Array].
</description>
</method>
</constructor>
</constructors>
<methods>
<method name="append">
<return type="void" />
<argument index="0" name="value" type="Variant" />
Expand Down Expand Up @@ -345,64 +347,6 @@
Returns the minimum value contained in the array if all elements are of comparable types. If the elements can't be compared, [code]null[/code] is returned.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool" />
<description>
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Array" />
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="Array" />
<argument index="0" name="right" type="Array" />
<description>
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Array" />
<description>
</description>
</method>
<method name="operator &lt;=" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Array" />
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool" />
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Array" />
<description>
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Array" />
<description>
</description>
</method>
<method name="operator &gt;=" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Array" />
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="void" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="pop_at">
<return type="Variant" />
<argument index="0" name="position" type="int" />
Expand Down Expand Up @@ -550,4 +494,64 @@
</description>
</method>
</methods>
<operators>
<operator name="operator !=">
<return type="bool" />
<description>
</description>
</operator>
<operator name="operator !=">
<return type="bool" />
<argument index="0" name="right" type="Array" />
<description>
</description>
</operator>
<operator name="operator +">
<return type="Array" />
<argument index="0" name="right" type="Array" />
<description>
</description>
</operator>
<operator name="operator &lt;">
<return type="bool" />
<argument index="0" name="right" type="Array" />
<description>
</description>
</operator>
<operator name="operator &lt;=">
<return type="bool" />
<argument index="0" name="right" type="Array" />
<description>
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<description>
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<argument index="0" name="right" type="Array" />
<description>
</description>
</operator>
<operator name="operator &gt;">
<return type="bool" />
<argument index="0" name="right" type="Array" />
<description>
</description>
</operator>
<operator name="operator &gt;=">
<return type="bool" />
<argument index="0" name="right" type="Array" />
<description>
</description>
</operator>
<operator name="operator []">
<return type="void" />
<argument index="0" name="index" type="int" />
<description>
</description>
</operator>
</operators>
</class>
Loading