Skip to content

Commit

Permalink
Merge pull request #53452 from aaronfranke/who-let-the-docs-out
Browse files Browse the repository at this point in the history
  • Loading branch information
@akien-mga
akien-mga authored Oct 31, 2021
2 parents 1aef3a4 + 6772ebc commit 1dd7427
Showing 40 changed files with 2,345 additions and 2,066 deletions.
2 changes: 2 additions & 0 deletions core/doc_data.h
View file
Original file line number Diff line number Diff line change
@@ -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;
64 changes: 34 additions & 30 deletions doc/classes/AABB.xml
View file
Original file line number Diff line number Diff line change
@@ -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>
@@ -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
Original file line number Diff line number Diff line change
@@ -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" />
@@ -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" />
@@ -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

0 comments on commit 1dd7427

Please sign in to comment.