Skip to content

Commit

Permalink
Rename the argument tag to param in XML documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@YuriSizov
YuriSizov committed Aug 8, 2022
1 parent 35c1eae commit c5d7115
Show file tree
Hide file tree
Showing 432 changed files with 10,529 additions and 10,529 deletions.
10 changes: 5 additions & 5 deletions doc/class.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
<xs:attribute type="xs:string" name="enum" use="optional" />
</xs:complexType>
</xs:element>
<xs:element name="argument" maxOccurs="unbounded" minOccurs="0">
<xs:element name="param" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:sequence />
Expand Down Expand Up @@ -79,7 +79,7 @@
<xs:attribute type="xs:byte" name="number" />
</xs:complexType>
</xs:element>
<xs:element name="argument" maxOccurs="unbounded" minOccurs="0">
<xs:element name="param" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:sequence />
Expand Down Expand Up @@ -127,7 +127,7 @@
<xs:element name="signal" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="argument" maxOccurs="unbounded" minOccurs="0">
<xs:element name="param" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:sequence />
Expand Down Expand Up @@ -178,7 +178,7 @@
<xs:attribute type="xs:string" name="enum" use="optional" />
</xs:complexType>
</xs:element>
<xs:element name="argument" maxOccurs="unbounded" minOccurs="0">
<xs:element name="param" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:sequence />
Expand Down Expand Up @@ -232,7 +232,7 @@
<xs:attribute type="xs:string" name="enum" use="optional" />
</xs:complexType>
</xs:element>
<xs:element name="argument" maxOccurs="unbounded" minOccurs="0">
<xs:element name="param" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:sequence />
Expand Down
270 changes: 135 additions & 135 deletions doc/classes/@GlobalScope.xml
View file

Large diffs are not rendered by default.

42 changes: 21 additions & 21 deletions doc/classes/AABB.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@
</constructor>
<constructor name="AABB">
<return type="AABB" />
<argument index="0" name="from" type="AABB" />
<param index="0" name="from" type="AABB" />
<description>
Constructs an [AABB] as a copy of the given [AABB].
</description>
</constructor>
<constructor name="AABB">
<return type="AABB" />
<argument index="0" name="position" type="Vector3" />
<argument index="1" name="size" type="Vector3" />
<param index="0" name="position" type="Vector3" />
<param index="1" name="size" type="Vector3" />
<description>
Constructs an [AABB] from a position and size.
</description>
Expand All @@ -46,14 +46,14 @@
</method>
<method name="encloses" qualifiers="const">
<return type="bool" />
<argument index="0" name="with" type="AABB" />
<param index="0" name="with" type="AABB" />
<description>
Returns [code]true[/code] if this [AABB] completely encloses another one.
</description>
</method>
<method name="expand" qualifiers="const">
<return type="AABB" />
<argument index="0" name="to_point" type="Vector3" />
<param index="0" name="to_point" type="Vector3" />
<description>
Returns a copy of this [AABB] expanded to include a given point.
[b]Example:[/b]
Expand Down Expand Up @@ -81,7 +81,7 @@
</method>
<method name="get_endpoint" qualifiers="const">
<return type="Vector3" />
<argument index="0" name="idx" type="int" />
<param index="0" name="idx" type="int" />
<description>
Gets the position of the 8 endpoints of the [AABB] in space.
</description>
Expand Down Expand Up @@ -124,7 +124,7 @@
</method>
<method name="get_support" qualifiers="const">
<return type="Vector3" />
<argument index="0" name="dir" type="Vector3" />
<param index="0" name="dir" type="Vector3" />
<description>
Returns the support point in a given direction. This is useful for collision detection algorithms.
</description>
Expand All @@ -137,7 +137,7 @@
</method>
<method name="grow" qualifiers="const">
<return type="AABB" />
<argument index="0" name="by" type="float" />
<param index="0" name="by" type="float" />
<description>
Returns a copy of the [AABB] grown a given amount of units towards all the sides.
</description>
Expand All @@ -156,58 +156,58 @@
</method>
<method name="has_point" qualifiers="const">
<return type="bool" />
<argument index="0" name="point" type="Vector3" />
<param index="0" name="point" type="Vector3" />
<description>
Returns [code]true[/code] if the [AABB] contains a point. Points on the faces of the AABB are considered included, though float-point precision errors may impact the accuracy of such checks.
[b]Note:[/b] This method is not reliable for [AABB] with a [i]negative size[/i]. Use [method abs] to get a positive sized equivalent [AABB] to check for contained points.
</description>
</method>
<method name="intersection" qualifiers="const">
<return type="AABB" />
<argument index="0" name="with" type="AABB" />
<param index="0" name="with" type="AABB" />
<description>
Returns the intersection between two [AABB]. An empty AABB (size [code](0, 0, 0)[/code]) is returned on failure.
</description>
</method>
<method name="intersects" qualifiers="const">
<return type="bool" />
<argument index="0" name="with" type="AABB" />
<param index="0" name="with" type="AABB" />
<description>
Returns [code]true[/code] if the [AABB] overlaps with another.
</description>
</method>
<method name="intersects_plane" qualifiers="const">
<return type="bool" />
<argument index="0" name="plane" type="Plane" />
<param index="0" name="plane" type="Plane" />
<description>
Returns [code]true[/code] if the [AABB] is on both sides of a plane.
</description>
</method>
<method name="intersects_ray" qualifiers="const">
<return type="Variant" />
<argument index="0" name="from" type="Vector3" />
<argument index="1" name="dir" type="Vector3" />
<param index="0" name="from" type="Vector3" />
<param index="1" name="dir" type="Vector3" />
<description>
</description>
</method>
<method name="intersects_segment" qualifiers="const">
<return type="Variant" />
<argument index="0" name="from" type="Vector3" />
<argument index="1" name="to" type="Vector3" />
<param index="0" name="from" type="Vector3" />
<param index="1" name="to" type="Vector3" />
<description>
Returns [code]true[/code] if the [AABB] intersects the line segment between [code]from[/code] and [code]to[/code].
</description>
</method>
<method name="is_equal_approx" qualifiers="const">
<return type="bool" />
<argument index="0" name="aabb" type="AABB" />
<param index="0" name="aabb" type="AABB" />
<description>
Returns [code]true[/code] if this [AABB] and [code]aabb[/code] are approximately equal, by calling [method @GlobalScope.is_equal_approx] on each component.
</description>
</method>
<method name="merge" qualifiers="const">
<return type="AABB" />
<argument index="0" name="with" type="AABB" />
<param index="0" name="with" type="AABB" />
<description>
Returns a larger [AABB] that contains both this [AABB] and [code]with[/code].
</description>
Expand All @@ -228,22 +228,22 @@
<operators>
<operator name="operator !=">
<return type="bool" />
<argument index="0" name="right" type="AABB" />
<param index="0" name="right" type="AABB" />
<description>
Returns [code]true[/code] if the vectors are not equal.
[b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable.
</description>
</operator>
<operator name="operator *">
<return type="AABB" />
<argument index="0" name="right" type="Transform3D" />
<param index="0" name="right" type="Transform3D" />
<description>
Inversely transforms (multiplies) the [AABB] by the given [Transform3D] transformation matrix.
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<argument index="0" name="right" type="AABB" />
<param index="0" name="right" type="AABB" />
<description>
Returns [code]true[/code] if the AABBs are exactly equal.
[b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable.
Expand Down
8 changes: 4 additions & 4 deletions doc/classes/AESContext.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,16 +94,16 @@
</method>
<method name="start">
<return type="int" enum="Error" />
<argument index="0" name="mode" type="int" enum="AESContext.Mode" />
<argument index="1" name="key" type="PackedByteArray" />
<argument index="2" name="iv" type="PackedByteArray" default="PackedByteArray()" />
<param index="0" name="mode" type="int" enum="AESContext.Mode" />
<param index="1" name="key" type="PackedByteArray" />
<param index="2" name="iv" type="PackedByteArray" default="PackedByteArray()" />
<description>
Start the AES context in the given [code]mode[/code]. A [code]key[/code] of either 16 or 32 bytes must always be provided, while an [code]iv[/code] (initialization vector) of exactly 16 bytes, is only needed when [code]mode[/code] is either [constant MODE_CBC_ENCRYPT] or [constant MODE_CBC_DECRYPT].
</description>
</method>
<method name="update">
<return type="PackedByteArray" />
<argument index="0" name="src" type="PackedByteArray" />
<param index="0" name="src" type="PackedByteArray" />
<description>
Run the desired operation for this AES context. Will return a [PackedByteArray] containing the result of encrypting (or decrypting) the given [code]src[/code]. See [method start] for mode of operation.
[b]Note:[/b] The size of [code]src[/code] must be a multiple of 16. Apply some padding if needed.
Expand Down
Loading

0 comments on commit c5d7115

Please sign in to comment.