From 5360058d1c0d4efbac3263be0cd0cbd9325068a0 Mon Sep 17 00:00:00 2001 From: Septian Date: Wed, 12 Jul 2023 05:33:49 +0700 Subject: [PATCH] Fix documentation for consistency (cherry picked from commit 377cbaba430b80eb8aa843d3f349eee4d68f165d) --- doc/classes/AudioStreamPlayer3D.xml | 2 +- doc/classes/DisplayServer.xml | 2 +- doc/classes/EditorDebuggerPlugin.xml | 2 +- doc/classes/PhysicsServer3D.xml | 2 +- doc/classes/SliderJoint3D.xml | 2 +- doc/classes/TextEdit.xml | 2 +- modules/enet/enet_packet_peer.cpp | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index 4a0e261c3ab..84b18bb7afd 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -85,7 +85,7 @@ Attenuation factor used if listener is outside of [member emission_angle_degrees] and [member emission_angle_enabled] is set, in decibels. - Sets the absolute maximum of the soundlevel, in decibels. + Sets the absolute maximum of the sound level, in decibels. The distance past which the sound can no longer be heard at all. Only has an effect if set to a value greater than [code]0.0[/code]. [member max_distance] works in tandem with [member unit_size]. However, unlike [member unit_size] whose behavior depends on the [member attenuation_model], [member max_distance] always works in a linear fashion. This can be used to prevent the [AudioStreamPlayer3D] from requiring audio mixing when the listener is far away, which saves CPU resources. diff --git a/doc/classes/DisplayServer.xml b/doc/classes/DisplayServer.xml index f0e60d95aee..53da4e28759 100644 --- a/doc/classes/DisplayServer.xml +++ b/doc/classes/DisplayServer.xml @@ -757,7 +757,7 @@ - Returns [code]true[/code] if touch events are available (Android or iOS), the capability is detected on the Webplatform or if [member ProjectSettings.input_devices/pointing/emulate_touch_from_mouse] is [code]true[/code]. + Returns [code]true[/code] if touch events are available (Android or iOS), the capability is detected on the Web platform or if [member ProjectSettings.input_devices/pointing/emulate_touch_from_mouse] is [code]true[/code]. diff --git a/doc/classes/EditorDebuggerPlugin.xml b/doc/classes/EditorDebuggerPlugin.xml index 34aaff00360..475f316276a 100644 --- a/doc/classes/EditorDebuggerPlugin.xml +++ b/doc/classes/EditorDebuggerPlugin.xml @@ -81,7 +81,7 @@ Returns an array of [EditorDebuggerSession] currently available to this debugger plugin. - Note: Not sessions in the array may be inactive, check their state via [method EditorDebuggerSession.is_active] + [b]Note:[/b] Not sessions in the array may be inactive, check their state via [method EditorDebuggerSession.is_active] diff --git a/doc/classes/PhysicsServer3D.xml b/doc/classes/PhysicsServer3D.xml index 22f7579017a..b433780e09f 100644 --- a/doc/classes/PhysicsServer3D.xml +++ b/doc/classes/PhysicsServer3D.xml @@ -1146,7 +1146,7 @@ A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement. - The amount of restitution once the limits are surpassed. The lower, the more velocityenergy gets lost. + The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost. The amount of damping once the slider limits are surpassed. diff --git a/doc/classes/SliderJoint3D.xml b/doc/classes/SliderJoint3D.xml index 11e38878e90..6190864951e 100644 --- a/doc/classes/SliderJoint3D.xml +++ b/doc/classes/SliderJoint3D.xml @@ -105,7 +105,7 @@ A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement. - The amount of restitution once the limits are surpassed. The lower, the more velocityenergy gets lost. + The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost. The amount of damping once the slider limits are surpassed. diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 55a5ea18f20..814bb2b299e 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -1234,7 +1234,7 @@ Emitted immediately when the text changes. - When text is added [param from_line] will be less then [param to_line]. On a remove [param to_line] will be less then [param from_line]. + When text is added [param from_line] will be less than [param to_line]. On a remove [param to_line] will be less than [param from_line]. diff --git a/modules/enet/enet_packet_peer.cpp b/modules/enet/enet_packet_peer.cpp index f64704c67de..a131841a07c 100644 --- a/modules/enet/enet_packet_peer.cpp +++ b/modules/enet/enet_packet_peer.cpp @@ -76,7 +76,7 @@ void ENetPacketPeer::throttle_configure(int p_interval, int p_acceleration, int void ENetPacketPeer::set_timeout(int p_timeout, int p_timeout_min, int p_timeout_max) { ERR_FAIL_COND_MSG(peer == nullptr, "Peer not connected"); - ERR_FAIL_COND_MSG(p_timeout > p_timeout_min || p_timeout_min > p_timeout_max, "Timeout limit must be less than minimum timeout, which itself must be less then maximum timeout"); + ERR_FAIL_COND_MSG(p_timeout > p_timeout_min || p_timeout_min > p_timeout_max, "Timeout limit must be less than minimum timeout, which itself must be less than maximum timeout"); enet_peer_timeout(peer, p_timeout, p_timeout_min, p_timeout_max); }