summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorThaddeus Crews <repiteo@outlook.com>2024-11-11 14:18:22 -0600
committerThaddeus Crews <repiteo@outlook.com>2024-11-11 14:18:22 -0600
commit85c5a4f05866128d1ceacb64a6b5cea39cdcbefa (patch)
tree282003d4903693e2b71f9ee53b1ada4c812b4a8e
parent6577ed278ac511414ce83bdf057cc32d19975e8a (diff)
parentc51cdaf006a1dd746a3153c6463215479b4d89e9 (diff)
downloadredot-engine-85c5a4f05866128d1ceacb64a6b5cea39cdcbefa.tar.gz
Merge pull request #98499 from tetrapod00/docs-dotnet-constructor-differences
Docs: Add notes about C# differences in Variant constructors
-rw-r--r--doc/classes/Basis.xml1
-rw-r--r--doc/classes/Color.xml2
-rw-r--r--doc/classes/Projection.xml3
-rw-r--r--doc/classes/Quaternion.xml1
-rw-r--r--doc/classes/Transform2D.xml1
-rw-r--r--doc/classes/Transform3D.xml1
6 files changed, 7 insertions, 2 deletions
diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml
index 322d2ab9d4..92faa55fe0 100644
--- a/doc/classes/Basis.xml
+++ b/doc/classes/Basis.xml
@@ -25,6 +25,7 @@
<return type="Basis" />
<description>
Constructs a [Basis] identical to the [constant IDENTITY].
+ [b]Note:[/b] In C#, this constructs a [Basis] with all of its components set to [constant Vector3.ZERO].
</description>
</constructor>
<constructor name="Basis">
diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml
index bfc5b97b5d..546d90fa3c 100644
--- a/doc/classes/Color.xml
+++ b/doc/classes/Color.xml
@@ -19,7 +19,7 @@
<return type="Color" />
<description>
Constructs a default [Color] from opaque black. This is the same as [constant BLACK].
- [b]Note:[/b] in C#, constructs an empty color with all of its components set to [code]0.0[/code] (transparent black).
+ [b]Note:[/b] In C#, this constructs a [Color] with all of its components set to [code]0.0[/code] (transparent black).
</description>
</constructor>
<constructor name="Color">
diff --git a/doc/classes/Projection.xml b/doc/classes/Projection.xml
index 1665660da3..f781083abf 100644
--- a/doc/classes/Projection.xml
+++ b/doc/classes/Projection.xml
@@ -14,7 +14,8 @@
<constructor name="Projection">
<return type="Projection" />
<description>
- Constructs a default-initialized [Projection] set to [constant IDENTITY].
+ Constructs a default-initialized [Projection] identical to [constant IDENTITY].
+ [b]Note:[/b] In C#, this constructs a [Projection] identical to [constant ZERO].
</description>
</constructor>
<constructor name="Projection">
diff --git a/doc/classes/Quaternion.xml b/doc/classes/Quaternion.xml
index 665c6335f2..c74a6453e0 100644
--- a/doc/classes/Quaternion.xml
+++ b/doc/classes/Quaternion.xml
@@ -22,6 +22,7 @@
<return type="Quaternion" />
<description>
Constructs a [Quaternion] identical to the [constant IDENTITY].
+ [b]Note:[/b] In C#, this constructs a [Quaternion] with all of its components set to [code]0.0[/code].
</description>
</constructor>
<constructor name="Quaternion">
diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml
index 756716433e..665e5e9d67 100644
--- a/doc/classes/Transform2D.xml
+++ b/doc/classes/Transform2D.xml
@@ -20,6 +20,7 @@
<return type="Transform2D" />
<description>
Constructs a [Transform2D] identical to [constant IDENTITY].
+ [b]Note:[/b] In C#, this constructs a [Transform2D] with all of its components set to [constant Vector2.ZERO].
</description>
</constructor>
<constructor name="Transform2D">
diff --git a/doc/classes/Transform3D.xml b/doc/classes/Transform3D.xml
index 30c141659a..0f943c7dd1 100644
--- a/doc/classes/Transform3D.xml
+++ b/doc/classes/Transform3D.xml
@@ -21,6 +21,7 @@
<return type="Transform3D" />
<description>
Constructs a [Transform3D] identical to the [constant IDENTITY].
+ [b]Note:[/b] In C#, this constructs a [Transform3D] with its [member origin] and the components of its [member basis] set to [constant Vector3.ZERO].
</description>
</constructor>
<constructor name="Transform3D">