From 87599054d26faa534e206959c12ef70f3a1e92f5 Mon Sep 17 00:00:00 2001
From: Micky <66727710+Mickeon@users.noreply.github.com>
Date: Thu, 5 May 2022 01:29:38 +0200
Subject: Specify return value of Transform3D.scaled() and more
Add more `[code]` (Transform3D)
Co-authored-by: kleonc <9283098+kleonc@users.noreply.github.com>
Add more `[code]` (Transform2D)
Co-authored-by: kleonc <9283098+kleonc@users.noreply.github.com>
---
doc/classes/Transform2D.xml | 6 +++---
doc/classes/Transform3D.xml | 6 +++---
2 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml
index 3ad21ee809..7d289b2ef5 100644
--- a/doc/classes/Transform2D.xml
+++ b/doc/classes/Transform2D.xml
@@ -141,14 +141,14 @@
- Rotates the transform by the given angle (in radians), using matrix multiplication.
+ Returns a copy of the transform rotated by the given [code]phi[/code] angle (in radians), using matrix multiplication.
- Scales the transform by the given scale factor, using matrix multiplication.
+ Returns a copy of the transform scaled by the given [code]scale[/code] factor, using matrix multiplication.
@@ -176,7 +176,7 @@
- Translates the transform by the given offset, relative to the transform's basis vectors.
+ Returns a copy of the transform translated by the given [code]offset[/code], relative to the transform's basis vectors.
Unlike [method rotated] and [method scaled], this does not use matrix multiplication.
diff --git a/doc/classes/Transform3D.xml b/doc/classes/Transform3D.xml
index 5a72dc223c..4a08ab3bc7 100644
--- a/doc/classes/Transform3D.xml
+++ b/doc/classes/Transform3D.xml
@@ -96,14 +96,14 @@
- Rotates the transform around the given axis by the given angle (in radians), using matrix multiplication. The axis must be a normalized vector.
+ Returns a copy of the transform rotated around the given [code]axis[/code] by the given [code]phi[/code] angle (in radians), using matrix multiplication. The [code]axis[/code] must be a normalized vector.
- Scales basis and origin of the transform by the given scale factor, using matrix multiplication.
+ Returns a copy of the transform with its basis and origin scaled by the given [code]scale[/code] factor, using matrix multiplication.
@@ -118,7 +118,7 @@
- Translates the transform by the given offset, relative to the transform's basis vectors.
+ Returns a copy of the transform translated by the given [code]offset[/code], relative to the transform's basis vectors.
Unlike [method rotated] and [method scaled], this does not use matrix multiplication.
--
cgit v1.2.3