From ffbd59572ed90f525153fe82766173232039acba Mon Sep 17 00:00:00 2001 From: Raul Santos Date: Sat, 4 Sep 2021 20:33:46 +0200 Subject: [PATCH] Various fixes to C# documentation (cherry picked from commit 2deabd553faf9f2ba7bbb5a52456c842ae4e036b) --- .../mono/glue/GodotSharp/GodotSharp/Core/Mathf.cs | 2 +- .../mono/glue/GodotSharp/GodotSharp/Core/MathfEx.cs | 8 ++++---- .../glue/GodotSharp/GodotSharp/Core/NodePath.cs | 2 +- .../GodotSharp/GodotSharp/Core/StringExtensions.cs | 4 ++++ .../glue/GodotSharp/GodotSharp/Core/Transform.cs | 2 +- .../glue/GodotSharp/GodotSharp/Core/Transform2D.cs | 13 ++++++------- 6 files changed, 17 insertions(+), 14 deletions(-) diff --git a/modules/mono/glue/GodotSharp/GodotSharp/Core/Mathf.cs b/modules/mono/glue/GodotSharp/GodotSharp/Core/Mathf.cs index 1b527c188a2..29180d0ff6e 100644 --- a/modules/mono/glue/GodotSharp/GodotSharp/Core/Mathf.cs +++ b/modules/mono/glue/GodotSharp/GodotSharp/Core/Mathf.cs @@ -651,7 +651,7 @@ namespace Godot /// /// The value to stepify. /// The step size to snap to. - /// + /// The snapped value. public static real_t Stepify(real_t s, real_t step) { if (step != 0f) diff --git a/modules/mono/glue/GodotSharp/GodotSharp/Core/MathfEx.cs b/modules/mono/glue/GodotSharp/GodotSharp/Core/MathfEx.cs index 9bb73ce7dd1..f15d01b34bf 100644 --- a/modules/mono/glue/GodotSharp/GodotSharp/Core/MathfEx.cs +++ b/modules/mono/glue/GodotSharp/GodotSharp/Core/MathfEx.cs @@ -44,7 +44,7 @@ namespace Godot /// /// Returns the amount of digits after the decimal place. /// - /// The input value. + /// The input value. /// The amount of digits. public static int DecimalCount(decimal s) { @@ -54,7 +54,7 @@ namespace Godot /// /// Rounds upward (towards positive infinity). /// - /// This is the same as , but returns an int. + /// This is the same as , but returns an . /// /// The number to ceil. /// The smallest whole number that is not less than . @@ -66,7 +66,7 @@ namespace Godot /// /// Rounds downward (towards negative infinity). /// - /// This is the same as , but returns an int. + /// This is the same as , but returns an . /// /// The number to floor. /// The largest whole number that is not more than . @@ -78,7 +78,7 @@ namespace Godot /// /// Rounds to the nearest whole number. /// - /// This is the same as , but returns an int. + /// This is the same as , but returns an . /// /// The number to round. /// The rounded number. diff --git a/modules/mono/glue/GodotSharp/GodotSharp/Core/NodePath.cs b/modules/mono/glue/GodotSharp/GodotSharp/Core/NodePath.cs index a374faee3de..8d97b133cf8 100644 --- a/modules/mono/glue/GodotSharp/GodotSharp/Core/NodePath.cs +++ b/modules/mono/glue/GodotSharp/GodotSharp/Core/NodePath.cs @@ -130,7 +130,7 @@ namespace Godot /// "/root/Level/Path2D" /// /// - /// + /// A string that represents a path in a scene tree. public NodePath(string path) { ptr = godot_icall_NodePath_Ctor(path); diff --git a/modules/mono/glue/GodotSharp/GodotSharp/Core/StringExtensions.cs b/modules/mono/glue/GodotSharp/GodotSharp/Core/StringExtensions.cs index aa7fe69b5a2..cac3e67012a 100644 --- a/modules/mono/glue/GodotSharp/GodotSharp/Core/StringExtensions.cs +++ b/modules/mono/glue/GodotSharp/GodotSharp/Core/StringExtensions.cs @@ -423,6 +423,10 @@ namespace Godot /// /// Find the first occurrence of a substring. Optionally, the search starting position can be passed. /// + /// + /// + /// + /// /// The string that will be searched. /// The substring to find. /// The search starting position. diff --git a/modules/mono/glue/GodotSharp/GodotSharp/Core/Transform.cs b/modules/mono/glue/GodotSharp/GodotSharp/Core/Transform.cs index 6c1b987add1..54a021e97cf 100644 --- a/modules/mono/glue/GodotSharp/GodotSharp/Core/Transform.cs +++ b/modules/mono/glue/GodotSharp/GodotSharp/Core/Transform.cs @@ -164,7 +164,7 @@ namespace Godot /// Operations take place in global space. /// /// The object to look at. - /// The relative up direction + /// The relative up direction. /// The resulting transform. public Transform LookingAt(Vector3 target, Vector3 up) { diff --git a/modules/mono/glue/GodotSharp/GodotSharp/Core/Transform2D.cs b/modules/mono/glue/GodotSharp/GodotSharp/Core/Transform2D.cs index ce589093b94..45edaef7475 100644 --- a/modules/mono/glue/GodotSharp/GodotSharp/Core/Transform2D.cs +++ b/modules/mono/glue/GodotSharp/GodotSharp/Core/Transform2D.cs @@ -23,7 +23,6 @@ namespace Godot /// /// The basis matrix's X vector (column 0). Equivalent to array index [0]. /// - /// public Vector2 x; /// @@ -420,12 +419,12 @@ namespace Godot /// Constructs a transformation matrix from the given components. /// Arguments are named such that xy is equal to calling x.y /// - /// The X component of the X column vector, accessed via t.x.x or [0][0] - /// The Y component of the X column vector, accessed via t.x.y or [0][1] - /// The X component of the Y column vector, accessed via t.y.x or [1][0] - /// The Y component of the Y column vector, accessed via t.y.y or [1][1] - /// The X component of the origin vector, accessed via t.origin.x or [2][0] - /// The Y component of the origin vector, accessed via t.origin.y or [2][1] + /// The X component of the X column vector, accessed via t.x.x or [0][0]. + /// The Y component of the X column vector, accessed via t.x.y or [0][1]. + /// The X component of the Y column vector, accessed via t.y.x or [1][0]. + /// The Y component of the Y column vector, accessed via t.y.y or [1][1]. + /// The X component of the origin vector, accessed via t.origin.x or [2][0]. + /// The Y component of the origin vector, accessed via t.origin.y or [2][1]. public Transform2D(real_t xx, real_t xy, real_t yx, real_t yy, real_t ox, real_t oy) { x = new Vector2(xx, xy);