mirror of
https://github.com/godotengine/godot.git
synced 2026-01-05 06:11:29 +03:00
doc: Use self-closing tags for return and argument
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
(cherry picked from commit 7adf4cc9b5)
This commit is contained in:
Rémi Verschelde
@@ -15,162 +15,128 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="Transform2D">
|
||||
<return type="Transform2D">
|
||||
</return>
|
||||
<argument index="0" name="from" type="Transform">
|
||||
</argument>
|
||||
<return type="Transform2D" />
|
||||
<argument index="0" name="from" type="Transform" />
|
||||
<description>
|
||||
Constructs the transform from a 3D [Transform].
|
||||
</description>
|
||||
</method>
|
||||
<method name="Transform2D">
|
||||
<return type="Transform2D">
|
||||
</return>
|
||||
<argument index="0" name="x_axis" type="Vector2">
|
||||
</argument>
|
||||
<argument index="1" name="y_axis" type="Vector2">
|
||||
</argument>
|
||||
<argument index="2" name="origin" type="Vector2">
|
||||
</argument>
|
||||
<return type="Transform2D" />
|
||||
<argument index="0" name="x_axis" type="Vector2" />
|
||||
<argument index="1" name="y_axis" type="Vector2" />
|
||||
<argument index="2" name="origin" type="Vector2" />
|
||||
<description>
|
||||
Constructs the transform from 3 [Vector2] values representing [member x], [member y], and the [member origin] (the three column vectors).
|
||||
</description>
|
||||
</method>
|
||||
<method name="Transform2D">
|
||||
<return type="Transform2D">
|
||||
</return>
|
||||
<argument index="0" name="rotation" type="float">
|
||||
</argument>
|
||||
<argument index="1" name="position" type="Vector2">
|
||||
</argument>
|
||||
<return type="Transform2D" />
|
||||
<argument index="0" name="rotation" type="float" />
|
||||
<argument index="1" name="position" type="Vector2" />
|
||||
<description>
|
||||
Constructs the transform from a given angle (in radians) and position.
|
||||
</description>
|
||||
</method>
|
||||
<method name="affine_inverse">
|
||||
<return type="Transform2D">
|
||||
</return>
|
||||
<return type="Transform2D" />
|
||||
<description>
|
||||
Returns the inverse of the transform, under the assumption that the transformation is composed of rotation, scaling and translation.
|
||||
</description>
|
||||
</method>
|
||||
<method name="basis_xform">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<argument index="0" name="v" type="Vector2">
|
||||
</argument>
|
||||
<return type="Vector2" />
|
||||
<argument index="0" name="v" type="Vector2" />
|
||||
<description>
|
||||
Returns a vector transformed (multiplied) by the basis matrix.
|
||||
This method does not account for translation (the origin vector).
|
||||
</description>
|
||||
</method>
|
||||
<method name="basis_xform_inv">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<argument index="0" name="v" type="Vector2">
|
||||
</argument>
|
||||
<return type="Vector2" />
|
||||
<argument index="0" name="v" type="Vector2" />
|
||||
<description>
|
||||
Returns a vector transformed (multiplied) by the inverse basis matrix.
|
||||
This method does not account for translation (the origin vector).
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_origin">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<return type="Vector2" />
|
||||
<description>
|
||||
Returns the transform's origin (translation).
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_rotation">
|
||||
<return type="float">
|
||||
</return>
|
||||
<return type="float" />
|
||||
<description>
|
||||
Returns the transform's rotation (in radians).
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_scale">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<return type="Vector2" />
|
||||
<description>
|
||||
Returns the scale.
|
||||
</description>
|
||||
</method>
|
||||
<method name="interpolate_with">
|
||||
<return type="Transform2D">
|
||||
</return>
|
||||
<argument index="0" name="transform" type="Transform2D">
|
||||
</argument>
|
||||
<argument index="1" name="weight" type="float">
|
||||
</argument>
|
||||
<return type="Transform2D" />
|
||||
<argument index="0" name="transform" type="Transform2D" />
|
||||
<argument index="1" name="weight" type="float" />
|
||||
<description>
|
||||
Returns a transform interpolated between this transform and another by a given [code]weight[/code] (on the range of 0.0 to 1.0).
|
||||
</description>
|
||||
</method>
|
||||
<method name="inverse">
|
||||
<return type="Transform2D">
|
||||
</return>
|
||||
<return type="Transform2D" />
|
||||
<description>
|
||||
Returns the inverse of the transform, under the assumption that the transformation is composed of rotation and translation (no scaling, use [method affine_inverse] for transforms with scaling).
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_equal_approx">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="transform" type="Transform2D">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="transform" type="Transform2D" />
|
||||
<description>
|
||||
Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
|
||||
</description>
|
||||
</method>
|
||||
<method name="orthonormalized">
|
||||
<return type="Transform2D">
|
||||
</return>
|
||||
<return type="Transform2D" />
|
||||
<description>
|
||||
Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors (scale of 1 or -1).
|
||||
</description>
|
||||
</method>
|
||||
<method name="rotated">
|
||||
<return type="Transform2D">
|
||||
</return>
|
||||
<argument index="0" name="phi" type="float">
|
||||
</argument>
|
||||
<return type="Transform2D" />
|
||||
<argument index="0" name="phi" type="float" />
|
||||
<description>
|
||||
Rotates the transform by the given angle (in radians), using matrix multiplication.
|
||||
</description>
|
||||
</method>
|
||||
<method name="scaled">
|
||||
<return type="Transform2D">
|
||||
</return>
|
||||
<argument index="0" name="scale" type="Vector2">
|
||||
</argument>
|
||||
<return type="Transform2D" />
|
||||
<argument index="0" name="scale" type="Vector2" />
|
||||
<description>
|
||||
Scales the transform by the given scale factor, using matrix multiplication.
|
||||
</description>
|
||||
</method>
|
||||
<method name="translated">
|
||||
<return type="Transform2D">
|
||||
</return>
|
||||
<argument index="0" name="offset" type="Vector2">
|
||||
</argument>
|
||||
<return type="Transform2D" />
|
||||
<argument index="0" name="offset" type="Vector2" />
|
||||
<description>
|
||||
Translates the transform by the given offset, relative to the transform's basis vectors.
|
||||
Unlike [method rotated] and [method scaled], this does not use matrix multiplication.
|
||||
</description>
|
||||
</method>
|
||||
<method name="xform">
|
||||
<return type="Variant">
|
||||
</return>
|
||||
<argument index="0" name="v" type="Variant">
|
||||
</argument>
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="v" type="Variant" />
|
||||
<description>
|
||||
Transforms the given [Vector2], [Rect2], or [PoolVector2Array] by this transform.
|
||||
</description>
|
||||
</method>
|
||||
<method name="xform_inv">
|
||||
<return type="Variant">
|
||||
</return>
|
||||
<argument index="0" name="v" type="Variant">
|
||||
</argument>
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="v" type="Variant" />
|
||||
<description>
|
||||
Inverse-transforms the given [Vector2], [Rect2], or [PoolVector2Array] by this transform.
|
||||
</description>
|
||||
|
||||
Reference in New Issue
Block a user