From 2deabd553faf9f2ba7bbb5a52456c842ae4e036b Mon Sep 17 00:00:00 2001 From: Raul Santos Date: Sat, 4 Sep 2021 20:33:46 +0200 Subject: Various fixes to C# documentation --- modules/mono/glue/GodotSharp/GodotSharp/Core/GD.cs | 2 +- modules/mono/glue/GodotSharp/GodotSharp/Core/Mathf.cs | 2 +- modules/mono/glue/GodotSharp/GodotSharp/Core/MathfEx.cs | 8 ++++---- modules/mono/glue/GodotSharp/GodotSharp/Core/NodePath.cs | 2 +- .../glue/GodotSharp/GodotSharp/Core/StringExtensions.cs | 4 ++++ modules/mono/glue/GodotSharp/GodotSharp/Core/Transform2D.cs | 13 ++++++------- modules/mono/glue/GodotSharp/GodotSharp/Core/Transform3D.cs | 2 +- 7 files changed, 18 insertions(+), 15 deletions(-) (limited to 'modules/mono/glue/GodotSharp') diff --git a/modules/mono/glue/GodotSharp/GodotSharp/Core/GD.cs b/modules/mono/glue/GodotSharp/GodotSharp/Core/GD.cs index a3afc83222..c664463e86 100644 --- a/modules/mono/glue/GodotSharp/GodotSharp/Core/GD.cs +++ b/modules/mono/glue/GodotSharp/GodotSharp/Core/GD.cs @@ -127,7 +127,7 @@ namespace Godot /// /// /// The linear energy to convert. - /// Audio as decibels + /// Audio as decibels. public static real_t Linear2Db(real_t linear) { return (real_t)(Math.Log(linear) * 8.6858896380650365530225783783321); diff --git a/modules/mono/glue/GodotSharp/GodotSharp/Core/Mathf.cs b/modules/mono/glue/GodotSharp/GodotSharp/Core/Mathf.cs index fbc8ff64a6..bfe9600084 100644 --- a/modules/mono/glue/GodotSharp/GodotSharp/Core/Mathf.cs +++ b/modules/mono/glue/GodotSharp/GodotSharp/Core/Mathf.cs @@ -624,7 +624,7 @@ namespace Godot /// /// The value to snap. /// The step size to snap to. - /// + /// The snapped value. public static real_t Snapped(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 9bb73ce7dd..f15d01b34b 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 f53b5dc904..40fb5f8788 100644 --- a/modules/mono/glue/GodotSharp/GodotSharp/Core/NodePath.cs +++ b/modules/mono/glue/GodotSharp/GodotSharp/Core/NodePath.cs @@ -122,7 +122,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 d9ee684c5b..68e6422c19 100644 --- a/modules/mono/glue/GodotSharp/GodotSharp/Core/StringExtensions.cs +++ b/modules/mono/glue/GodotSharp/GodotSharp/Core/StringExtensions.cs @@ -415,6 +415,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/Transform2D.cs b/modules/mono/glue/GodotSharp/GodotSharp/Core/Transform2D.cs index 6f1d9574a8..8e253388bf 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); diff --git a/modules/mono/glue/GodotSharp/GodotSharp/Core/Transform3D.cs b/modules/mono/glue/GodotSharp/GodotSharp/Core/Transform3D.cs index 4bb8308c12..5d9aabdd2f 100644 --- a/modules/mono/glue/GodotSharp/GodotSharp/Core/Transform3D.cs +++ b/modules/mono/glue/GodotSharp/GodotSharp/Core/Transform3D.cs @@ -166,7 +166,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 Transform3D LookingAt(Vector3 target, Vector3 up) { -- cgit v1.2.3