diff options
author | Aaron Franke <arnfranke@yahoo.com> | 2020-07-21 14:07:00 -0400 |
---|---|---|
committer | Aaron Franke <arnfranke@yahoo.com> | 2020-07-21 14:44:53 -0400 |
commit | 83e324d670ca05993403c5d0ad7762aa096a7978 (patch) | |
tree | e011b47e7cf86301c72668a2e6c3a2e8ec13255d /modules/mono | |
parent | 41d6c965907730debb2bd6dcc7ccbe6f1ba5d015 (diff) |
Update core documentation to match recent C# changes
Also a few minor API changes like adding AABB.abs()
Co-authored-by: RĂ©mi Verschelde <rverschelde@gmail.com>
Diffstat (limited to 'modules/mono')
-rw-r--r-- | modules/mono/glue/GodotSharp/GodotSharp/Core/Color.cs | 2 | ||||
-rw-r--r-- | modules/mono/glue/GodotSharp/GodotSharp/Core/Plane.cs | 8 |
2 files changed, 7 insertions, 3 deletions
diff --git a/modules/mono/glue/GodotSharp/GodotSharp/Core/Color.cs b/modules/mono/glue/GodotSharp/GodotSharp/Core/Color.cs index 3173a21986..d851abc6d3 100644 --- a/modules/mono/glue/GodotSharp/GodotSharp/Core/Color.cs +++ b/modules/mono/glue/GodotSharp/GodotSharp/Core/Color.cs @@ -486,7 +486,7 @@ namespace Godot } /// <summary> - /// Constructs a color from RGB values on the range of 0 to 1. + /// Constructs a color from RGBA values on the range of 0 to 1. /// </summary> /// <param name="r">The color's red component, typically on the range of 0 to 1.</param> /// <param name="g">The color's green component, typically on the range of 0 to 1.</param> diff --git a/modules/mono/glue/GodotSharp/GodotSharp/Core/Plane.cs b/modules/mono/glue/GodotSharp/GodotSharp/Core/Plane.cs index af0d474bae..2748454e48 100644 --- a/modules/mono/glue/GodotSharp/GodotSharp/Core/Plane.cs +++ b/modules/mono/glue/GodotSharp/GodotSharp/Core/Plane.cs @@ -20,8 +20,9 @@ namespace Godot private Vector3 _normal; /// <summary> - /// The normal of the plane (in the plane equation: a, b, and c). - /// The normal vector must be normalized. + /// The normal of the plane, which must be normalized. + /// In the scalar equation of the plane `ax + by + cz = d`, this is + /// the vector `(a, b, c)`, where `d` is the <see cref="D"> property. /// </summary> /// <value>Equivalent to `x`, `y`, and `z`.</value> public Vector3 Normal @@ -81,6 +82,9 @@ namespace Godot /// <summary> /// The distance from the origin to the plane (in the direction of /// <see cref="Normal"/>). This value is typically non-negative. + /// In the scalar equation of the plane `ax + by + cz = d`, + /// this is `d`, while the `(a, b, c)` coordinates are represented + /// by the <see cref="Normal"> property. /// </summary> /// <value>The plane's distance from the origin.</value> public real_t D { get; set; } |