From 57d4272984fc0dd4c668503ead82a9dd01020bfd Mon Sep 17 00:00:00 2001 From: Haoyu Qiu Date: Thu, 16 Mar 2023 13:56:09 +0800 Subject: [PATCH] Fix typos and inconsistencies in classref --- doc/classes/AABB.xml | 2 +- doc/classes/CPUParticles3D.xml | 2 +- doc/classes/DisplayServer.xml | 6 +++--- doc/classes/EditorVCSInterface.xml | 2 +- doc/classes/SkeletonModification2DLookAt.xml | 2 +- doc/classes/TileSet.xml | 6 +++--- doc/classes/Transform2D.xml | 18 ++++++------------ doc/classes/Transform3D.xml | 18 ++++++------------ doc/classes/TranslationServer.xml | 2 +- doc/classes/Vector2.xml | 8 ++++---- doc/classes/Vector3.xml | 4 ++-- doc/classes/Vector4.xml | 2 +- .../doc_classes/WebSocketMultiplayerPeer.xml | 2 +- 13 files changed, 31 insertions(+), 43 deletions(-) diff --git a/doc/classes/AABB.xml b/doc/classes/AABB.xml index f85a055db5d..34fe3cd1bb8 100644 --- a/doc/classes/AABB.xml +++ b/doc/classes/AABB.xml @@ -237,7 +237,7 @@ - Returns [code]true[/code] if the vectors are not equal. + Returns [code]true[/code] if the AABBs are not equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. diff --git a/doc/classes/CPUParticles3D.xml b/doc/classes/CPUParticles3D.xml index 6c6239819e9..f02b7578f8f 100644 --- a/doc/classes/CPUParticles3D.xml +++ b/doc/classes/CPUParticles3D.xml @@ -294,7 +294,7 @@ Particle system's running speed scaling ratio. A value of [code]0[/code] can be used to pause the particles. - If set to true, three different scale curves can be specified, one per scale axis. + If set to [code]true[/code], three different scale curves can be specified, one per scale axis. Each particle's initial direction range from [code]+spread[/code] to [code]-spread[/code] degrees. Applied to X/Z plane and Y/Z planes. diff --git a/doc/classes/DisplayServer.xml b/doc/classes/DisplayServer.xml index 80567d46561..d0da0974765 100644 --- a/doc/classes/DisplayServer.xml +++ b/doc/classes/DisplayServer.xml @@ -952,7 +952,7 @@ - Sets the window icon (usually displayed in the top-left corner) in the operating system's [i]native[/i] format. To use icons in the operating system's native format, use [method set_native_icon] instead. + Sets the window icon (usually displayed in the top-left corner) with an [Image]. To use icons in the operating system's native format, use [method set_native_icon] instead. @@ -1046,8 +1046,8 @@ Adds a callback, which is called when the utterance has started, finished, canceled or reached a text boundary. - - [constant TTS_UTTERANCE_STARTED], [constant TTS_UTTERANCE_ENDED], and [constant TTS_UTTERANCE_CANCELED] callable's method should take one [int] parameter, the utterance id. - - [constant TTS_UTTERANCE_BOUNDARY] callable's method should take two [int] parameters, the index of the character and the utterance id. + - [constant TTS_UTTERANCE_STARTED], [constant TTS_UTTERANCE_ENDED], and [constant TTS_UTTERANCE_CANCELED] callable's method should take one [int] parameter, the utterance ID. + - [constant TTS_UTTERANCE_BOUNDARY] callable's method should take two [int] parameters, the index of the character and the utterance ID. [b]Note:[/b] The granularity of the boundary callbacks is engine dependent. [b]Note:[/b] This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows. diff --git a/doc/classes/EditorVCSInterface.xml b/doc/classes/EditorVCSInterface.xml index 07ab02cbf72..d5dc6abe817 100644 --- a/doc/classes/EditorVCSInterface.xml +++ b/doc/classes/EditorVCSInterface.xml @@ -124,7 +124,7 @@ - Pushes changes to the [code]remote[/code]. Optionally, if [code]force[/code] is set to true, a force push will override the change history already present on the remote. + Pushes changes to the [param remote]. If [param force] is [code]true[/code], a force push will override the change history already present on the remote. diff --git a/doc/classes/SkeletonModification2DLookAt.xml b/doc/classes/SkeletonModification2DLookAt.xml index f209db77975..190ba7b432f 100644 --- a/doc/classes/SkeletonModification2DLookAt.xml +++ b/doc/classes/SkeletonModification2DLookAt.xml @@ -81,7 +81,7 @@ The [Bone2D] node that the modification will operate on. - The index of the [Bone2D] node that the modification will oeprate on. + The index of the [Bone2D] node that the modification will operate on. The NodePath to the node that is the target for the LookAt modification. This node is what the modification will rotate the [Bone2D] to. diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml index 4877974a3cb..dc501d482d9 100644 --- a/doc/classes/TileSet.xml +++ b/doc/classes/TileSet.xml @@ -155,7 +155,7 @@ - Returns the navigation layers (as in the Navigation server) of the gives TileSet navigation layer. + Returns the navigation layers (as in the Navigation server) of the given TileSet navigation layer. @@ -522,7 +522,7 @@ - Sets the navigation layers (as in the navigation server) for navigation regions is the given TileSet navigation layer. + Sets the navigation layers (as in the navigation server) for navigation regions in the given TileSet navigation layer. @@ -538,7 +538,7 @@ - Enables or disables sdf collision for occluders in the given TileSet occlusion layer. + Enables or disables SDF collision for occluders in the given TileSet occlusion layer. diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index 53e9f4ea10e..4c775cdc4ca 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -148,8 +148,7 @@ Returns a copy of the transform rotated by the given [param angle] (in radians). - This method is an optimized version of multiplying the given transform [code]X[/code] - with a corresponding rotation transform [code]R[/code] from the left, i.e., [code]R * X[/code]. + This method is an optimized version of multiplying the given transform [code]X[/code] with a corresponding rotation transform [code]R[/code] from the left, i.e., [code]R * X[/code]. This can be seen as transforming with respect to the global/parent frame. @@ -158,8 +157,7 @@ Returns a copy of the transform rotated by the given [param angle] (in radians). - This method is an optimized version of multiplying the given transform [code]X[/code] - with a corresponding rotation transform [code]R[/code] from the right, i.e., [code]X * R[/code]. + This method is an optimized version of multiplying the given transform [code]X[/code] with a corresponding rotation transform [code]R[/code] from the right, i.e., [code]X * R[/code]. This can be seen as transforming with respect to the local frame. @@ -168,8 +166,7 @@ Returns a copy of the transform scaled by the given [param scale] factor. - This method is an optimized version of multiplying the given transform [code]X[/code] - with a corresponding scaling transform [code]S[/code] from the left, i.e., [code]S * X[/code]. + This method is an optimized version of multiplying the given transform [code]X[/code] with a corresponding scaling transform [code]S[/code] from the left, i.e., [code]S * X[/code]. This can be seen as transforming with respect to the global/parent frame. @@ -178,8 +175,7 @@ Returns a copy of the transform scaled by the given [param scale] factor. - This method is an optimized version of multiplying the given transform [code]X[/code] - with a corresponding scaling transform [code]S[/code] from the right, i.e., [code]X * S[/code]. + This method is an optimized version of multiplying the given transform [code]X[/code] with a corresponding scaling transform [code]S[/code] from the right, i.e., [code]X * S[/code]. This can be seen as transforming with respect to the local frame. @@ -188,8 +184,7 @@ Returns a copy of the transform translated by the given [param offset]. - This method is an optimized version of multiplying the given transform [code]X[/code] - with a corresponding translation transform [code]T[/code] from the left, i.e., [code]T * X[/code]. + This method is an optimized version of multiplying the given transform [code]X[/code] with a corresponding translation transform [code]T[/code] from the left, i.e., [code]T * X[/code]. This can be seen as transforming with respect to the global/parent frame. @@ -198,8 +193,7 @@ Returns a copy of the transform translated by the given [param offset]. - This method is an optimized version of multiplying the given transform [code]X[/code] - with a corresponding translation transform [code]T[/code] from the right, i.e., [code]X * T[/code]. + This method is an optimized version of multiplying the given transform [code]X[/code] with a corresponding translation transform [code]T[/code] from the right, i.e., [code]X * T[/code]. This can be seen as transforming with respect to the local frame. diff --git a/doc/classes/Transform3D.xml b/doc/classes/Transform3D.xml index 5fe31bd29a0..fb5c8559b66 100644 --- a/doc/classes/Transform3D.xml +++ b/doc/classes/Transform3D.xml @@ -111,8 +111,7 @@ Returns a copy of the transform rotated around the given [param axis] by the given [param angle] (in radians). The [param axis] must be a normalized vector. - This method is an optimized version of multiplying the given transform [code]X[/code] - with a corresponding rotation transform [code]R[/code] from the left, i.e., [code]R * X[/code]. + This method is an optimized version of multiplying the given transform [code]X[/code] with a corresponding rotation transform [code]R[/code] from the left, i.e., [code]R * X[/code]. This can be seen as transforming with respect to the global/parent frame. @@ -123,8 +122,7 @@ Returns a copy of the transform rotated around the given [param axis] by the given [param angle] (in radians). The [param axis] must be a normalized vector. - This method is an optimized version of multiplying the given transform [code]X[/code] - with a corresponding rotation transform [code]R[/code] from the right, i.e., [code]X * R[/code]. + This method is an optimized version of multiplying the given transform [code]X[/code] with a corresponding rotation transform [code]R[/code] from the right, i.e., [code]X * R[/code]. This can be seen as transforming with respect to the local frame. @@ -133,8 +131,7 @@ Returns a copy of the transform scaled by the given [param scale] factor. - This method is an optimized version of multiplying the given transform [code]X[/code] - with a corresponding scaling transform [code]S[/code] from the left, i.e., [code]S * X[/code]. + This method is an optimized version of multiplying the given transform [code]X[/code] with a corresponding scaling transform [code]S[/code] from the left, i.e., [code]S * X[/code]. This can be seen as transforming with respect to the global/parent frame. @@ -143,8 +140,7 @@ Returns a copy of the transform scaled by the given [param scale] factor. - This method is an optimized version of multiplying the given transform [code]X[/code] - with a corresponding scaling transform [code]S[/code] from the right, i.e., [code]X * S[/code]. + This method is an optimized version of multiplying the given transform [code]X[/code] with a corresponding scaling transform [code]S[/code] from the right, i.e., [code]X * S[/code]. This can be seen as transforming with respect to the local frame. @@ -153,8 +149,7 @@ Returns a copy of the transform translated by the given [param offset]. - This method is an optimized version of multiplying the given transform [code]X[/code] - with a corresponding translation transform [code]T[/code] from the left, i.e., [code]T * X[/code]. + This method is an optimized version of multiplying the given transform [code]X[/code] with a corresponding translation transform [code]T[/code] from the left, i.e., [code]T * X[/code]. This can be seen as transforming with respect to the global/parent frame. @@ -163,8 +158,7 @@ Returns a copy of the transform translated by the given [param offset]. - This method is an optimized version of multiplying the given transform [code]X[/code] - with a corresponding translation transform [code]T[/code] from the right, i.e., [code]X * T[/code]. + This method is an optimized version of multiplying the given transform [code]X[/code] with a corresponding translation transform [code]T[/code] from the right, i.e., [code]X * T[/code]. This can be seen as transforming with respect to the local frame. diff --git a/doc/classes/TranslationServer.xml b/doc/classes/TranslationServer.xml index acbb77e63af..155a7d4bdd7 100644 --- a/doc/classes/TranslationServer.xml +++ b/doc/classes/TranslationServer.xml @@ -156,7 +156,7 @@ - Returns the current locale's translation for the given message (key), plural_message and context. + Returns the current locale's translation for the given message (key), plural message and context. The number [param n] is the number or quantity of the plural object. It will be used to guide the translation system to fetch the correct plural form for the selected language. diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index ada853f752a..126a68b161c 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -143,7 +143,7 @@ - Cubically interpolates between this vector and [param b] using [param pre_a] and [param post_b] as handles, and returns the result at position [param weight]. [param weight] is on the range of 0.0 to 1.0, representing the amount of interpolation. + Performs a cubic interpolation between this vector and [param b] using [param pre_a] and [param post_b] as handles, and returns the result at position [param weight]. [param weight] is on the range of 0.0 to 1.0, representing the amount of interpolation. @@ -156,7 +156,7 @@ - Cubically interpolates between this vector and [param b] using [param pre_a] and [param post_b] as handles, and returns the result at position [param weight]. [param weight] is on the range of 0.0 to 1.0, representing the amount of interpolation. + Performs a cubic interpolation between this vector and [param b] using [param pre_a] and [param post_b] as handles, and returns the result at position [param weight]. [param weight] is on the range of 0.0 to 1.0, representing the amount of interpolation. It can perform smoother interpolation than [code]cubic_interpolate()[/code] by the time values. @@ -254,7 +254,7 @@ - Returns the result of the linear interpolation between this vector and [param to] by amount [param weight]. [param weight] is on the range of 0.0 to 1.0, representing the amount of interpolation. + Returns the result of the linear interpolation between this vector and [param to] by amount [param weight]. [param weight] is on the range of [code]0.0[/code] to [code]1.0[/code], representing the amount of interpolation. @@ -287,7 +287,7 @@ - Returns a new vector scaled to unit length. Equivalent to [code]v / v.length()[/code]. + Returns the result of scaling the vector to unit length. Equivalent to [code]v / v.length()[/code]. See also [method is_normalized]. diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index 3957be5f1df..f1400b99002 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -222,7 +222,7 @@ - Returns the result of the linear interpolation between this vector and [param to] by amount [param weight]. [param weight] is on the range of 0.0 to 1.0, representing the amount of interpolation. + Returns the result of the linear interpolation between this vector and [param to] by amount [param weight]. [param weight] is on the range of [code]0.0[/code] to [code]1.0[/code], representing the amount of interpolation. @@ -255,7 +255,7 @@ - Returns the vector scaled to unit length. Equivalent to [code]v / v.length()[/code]. See also [method is_normalized]. + Returns the result of scaling the vector to unit length. Equivalent to [code]v / v.length()[/code]. See also [method is_normalized]. diff --git a/doc/classes/Vector4.xml b/doc/classes/Vector4.xml index 14a30a2eb7f..9f2ff338c11 100644 --- a/doc/classes/Vector4.xml +++ b/doc/classes/Vector4.xml @@ -190,7 +190,7 @@ - Returns the result of scaling the vector to unit length. Equivalent to [code]v / v.length()[/code]. + Returns the result of scaling the vector to unit length. Equivalent to [code]v / v.length()[/code]. See also [method is_normalized]. diff --git a/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml b/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml index fba954d547a..57feadcc998 100644 --- a/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml +++ b/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml @@ -25,7 +25,7 @@ - Starts a new multiplayer server listening on the given [param port]. You can optionally specify a [param bind_address], and provide valiid [param tls_server_options] to use TLS. See [method TLSOptions.server]. + Starts a new multiplayer server listening on the given [param port]. You can optionally specify a [param bind_address], and provide valid [param tls_server_options] to use TLS. See [method TLSOptions.server].