Merge pull request #107143 from Mickeon/documentation-miscellaneous-oddities-part-5

Fix miscellaneous oddities around the class reference (part 5)

Author: akien-mga

doc/classes/Animation.xml

@@ -687,7 +687,7 @@
 			[b]Note:[/b] Length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping.
 		</member>
 		<member name="loop_mode" type="int" setter="set_loop_mode" getter="get_loop_mode" enum="Animation.LoopMode" default="0">
-			Determines the behavior of both ends of the animation timeline during animation playback. This is used for correct interpolation of animation cycles, and for hinting the player that it must restart the animation.
+			Determines the behavior of both ends of the animation timeline during animation playback. This indicates whether and how the animation should be restarted, and is also used to correctly interpolate animation cycles.
 		</member>
 		<member name="step" type="float" setter="set_step" getter="get_step" default="0.033333335">
 			The animation step value.

doc/classes/Camera3D.xml

@@ -128,7 +128,8 @@
 			<param index="1" name="z_near" type="float" />
 			<param index="2" name="z_far" type="float" />
 			<description>
-				Sets the camera projection to orthogonal mode (see [constant PROJECTION_ORTHOGONAL]), by specifying a [param size], and the [param z_near] and [param z_far] clip planes in world space units. (As a hint, 2D games often use this projection, with values specified in pixels.)
+				Sets the camera projection to orthogonal mode (see [constant PROJECTION_ORTHOGONAL]), by specifying a [param size], and the [param z_near] and [param z_far] clip planes in world space units.
+				As a hint, 3D games that look 2D often use this projection, with [param size] specified in pixels.
 			</description>
 		</method>
 		<method name="set_perspective">

doc/classes/CameraFeed.xml

@@ -67,10 +67,10 @@
 			<param index="0" name="index" type="int" />
 			<param index="1" name="parameters" type="Dictionary" />
 			<description>
-				Sets the feed format parameters for the given index in the [member formats] array. Returns [code]true[/code] on success. By default YUYV encoded stream is transformed to FEED_RGB. YUYV encoded stream output format can be changed with [param parameters].output value:
-				[code]separate[/code] will result in FEED_YCBCR_SEP
-				[code]grayscale[/code] will result in desaturated FEED_RGB
-				[code]copy[/code] will result in FEED_YCBCR
+				Sets the feed format parameters for the given [param index] in the [member formats] array. Returns [code]true[/code] on success. By default, the YUYV encoded stream is transformed to [constant FEED_RGB]. The YUYV encoded stream output format can be changed by setting [param parameters]'s [code]output[/code] entry to one of the following:
+				- [code]"separate"[/code] will result in [constant FEED_YCBCR_SEP];
+				- [code]"grayscale"[/code] will result in desaturated [constant FEED_RGB];
+				- [code]"copy"[/code] will result in [constant FEED_YCBCR].
 			</description>
 		</method>
 		<method name="set_name">

doc/classes/CanvasItem.xml

@@ -173,7 +173,7 @@
 			<param index="5" name="pixel_range" type="float" default="4.0" />
 			<param index="6" name="scale" type="float" default="1.0" />
 			<description>
-				Draws a textured rectangle region of the multi-channel signed distance field texture at a given position, optionally modulated by a color. See [member FontFile.multichannel_signed_distance_field] for more information and caveats about MSDF font rendering.
+				Draws a textured rectangle region of the multichannel signed distance field texture at a given position, optionally modulated by a color. See [member FontFile.multichannel_signed_distance_field] for more information and caveats about MSDF font rendering.
 				If [param outline] is positive, each alpha channel value of pixel in region is set to maximum value of true distance in the [param outline] radius.
 				Value of the [param pixel_range] should the same that was used during distance field texture generation.
 			</description>

doc/classes/DampedSpringJoint2D.xml

@@ -4,7 +4,7 @@
 		A physics joint that connects two 2D physics bodies with a spring-like force.
 	</brief_description>
 	<description>
-		A physics joint that connects two 2D physics bodies with a spring-like force. This resembles a spring that always wants to stretch to a given length.
+		A physics joint that connects two 2D physics bodies with a spring-like force. This behaves like a spring that always wants to stretch to a given length.
 	</description>
 	<tutorials>
 	</tutorials>

doc/classes/EditorExportPlatform.xml

@@ -260,19 +260,19 @@
 			Message type for error messages that must be addressed and fail the export.
 		</constant>
 		<constant name="DEBUG_FLAG_DUMB_CLIENT" value="1" enum="DebugFlags" is_bitfield="true">
-			Flag is set if remotely debugged project is expected to use remote file system. If set, [method gen_export_flags] will add [code]--remote-fs[/code] and [code]--remote-fs-password[/code] (if password is set in the editor settings) command line arguments to the list.
+			Flag is set if the remotely debugged project is expected to use the remote file system. If set, [method gen_export_flags] will append [code]--remote-fs[/code] and [code]--remote-fs-password[/code] (if [member EditorSettings.filesystem/file_server/password] is defined) command line arguments to the returned list.
 		</constant>
 		<constant name="DEBUG_FLAG_REMOTE_DEBUG" value="2" enum="DebugFlags" is_bitfield="true">
-			Flag is set if remote debug is enabled. If set, [method gen_export_flags] will add [code]--remote-debug[/code] and [code]--breakpoints[/code] (if breakpoints are selected in the script editor or added by the plugin) command line arguments to the list.
+			Flag is set if remote debug is enabled. If set, [method gen_export_flags] will append [code]--remote-debug[/code] and [code]--breakpoints[/code] (if breakpoints are selected in the script editor or added by the plugin) command line arguments to the returned list.
 		</constant>
 		<constant name="DEBUG_FLAG_REMOTE_DEBUG_LOCALHOST" value="4" enum="DebugFlags" is_bitfield="true">
 			Flag is set if remotely debugged project is running on the localhost. If set, [method gen_export_flags] will use [code]localhost[/code] instead of [member EditorSettings.network/debug/remote_host] as remote debugger host.
 		</constant>
 		<constant name="DEBUG_FLAG_VIEW_COLLISIONS" value="8" enum="DebugFlags" is_bitfield="true">
-			Flag is set if "Visible Collision Shapes" remote debug option is enabled. If set, [method gen_export_flags] will add [code]--debug-collisions[/code] command line arguments to the list.
+			Flag is set if the "Visible Collision Shapes" remote debug option is enabled. If set, [method gen_export_flags] will append the [code]--debug-collisions[/code] command line argument to the returned list.
 		</constant>
 		<constant name="DEBUG_FLAG_VIEW_NAVIGATION" value="16" enum="DebugFlags" is_bitfield="true">
-			Flag is set if Visible Navigation" remote debug option is enabled. If set, [method gen_export_flags] will add [code]--debug-navigation[/code] command line arguments to the list.
+			Flag is set if the "Visible Navigation" remote debug option is enabled. If set, [method gen_export_flags] will append the [code]--debug-navigation[/code] command line argument to the returned list.
 		</constant>
 	</constants>
 </class>

doc/classes/EditorExportPlatformExtension.xml

@@ -139,7 +139,7 @@
 		<method name="_get_logo" qualifiers="virtual required const">
 			<return type="Texture2D" />
 			<description>
-				Returns platform logo displayed in the export dialog, logo should be 32x32 adjusted to the current editor scale, see [method EditorInterface.get_editor_scale].
+				Returns the platform logo displayed in the export dialog. The logo should be 32×32 pixels, adjusted for the current editor scale (see [method EditorInterface.get_editor_scale]).
 			</description>
 		</method>
 		<method name="_get_name" qualifiers="virtual required const">
@@ -152,7 +152,7 @@
 			<return type="ImageTexture" />
 			<param index="0" name="device" type="int" />
 			<description>
-				Returns one-click deploy menu item icon for the specified [param device], icon should be 16x16 adjusted to the current editor scale, see [method EditorInterface.get_editor_scale].
+				Returns the item icon for the specified [param device] in the one-click deploy menu. The icon should be 16×16 pixels, adjusted for the current editor scale (see [method EditorInterface.get_editor_scale]).
 			</description>
 		</method>
 		<method name="_get_option_label" qualifiers="virtual const">
@@ -172,7 +172,7 @@
 		<method name="_get_options_count" qualifiers="virtual const">
 			<return type="int" />
 			<description>
-				Returns number one-click deploy devices (or other one-click option displayed in the menu).
+				Returns the number of devices (or other options) available in the one-click deploy menu.
 			</description>
 		</method>
 		<method name="_get_options_tooltip" qualifiers="virtual const">
@@ -203,7 +203,7 @@
 		<method name="_get_run_icon" qualifiers="virtual const">
 			<return type="Texture2D" />
 			<description>
-				Returns icon of the one-click deploy menu button, icon should be 16x16 adjusted to the current editor scale, see [method EditorInterface.get_editor_scale].
+				Returns the icon of the one-click deploy menu button. The icon should be 16×16 pixels, adjusted for the current editor scale (see [method EditorInterface.get_editor_scale]).
 			</description>
 		</method>
 		<method name="_has_valid_export_configuration" qualifiers="virtual required const">

doc/classes/EditorExportPlugin.xml

@@ -230,7 +230,7 @@
 			<return type="bool" />
 			<param index="0" name="platform" type="EditorExportPlatform" />
 			<description>
-				Return [code]true[/code], if the result of [method _get_export_options] has changed and the export options of preset corresponding to [param platform] should be updated.
+				Return [code]true[/code] if the result of [method _get_export_options] has changed and the export options of the preset corresponding to [param platform] should be updated.
 			</description>
 		</method>
 		<method name="_supports_platform" qualifiers="virtual const">

doc/classes/EditorExportPreset.xml

@@ -4,33 +4,33 @@
 		Export preset configuration.
 	</brief_description>
 	<description>
-		Export preset configuration. Instances of [EditorExportPreset] by editor UI and intended to be used a read-only configuration passed to the [EditorExportPlatform] methods when exporting the project.
+		Represents the configuration of an export preset, as created by the editor's export dialog. An [EditorExportPreset] instance is intended to be used a read-only configuration passed to the [EditorExportPlatform] methods when exporting the project.
 	</description>
 	<tutorials>
 	</tutorials>
 	<methods>
 		<method name="are_advanced_options_enabled" qualifiers="const">
 			<return type="bool" />
 			<description>
-				Returns [code]true[/code] if "Advanced" toggle is enabled in the export dialog.
+				Returns [code]true[/code] if the "Advanced" toggle is enabled in the export dialog.
 			</description>
 		</method>
 		<method name="get_custom_features" qualifiers="const">
 			<return type="String" />
 			<description>
-				Returns string with a comma separated list of custom features.
+				Returns a comma-separated list of custom features added to this preset, as a string. See [url=$DOCS_URL/tutorials/export/feature_tags.html]Feature tags[/url] in the documentation for more information.
 			</description>
 		</method>
 		<method name="get_customized_files" qualifiers="const">
 			<return type="Dictionary" />
 			<description>
-				Returns [Dictionary] of files selected in the "Resources" tab of the export dialog. Dictionary keys are file names and values are export mode - [code]"strip"[/code], [code]"keep"[/code], or [code]"remove"[/code]. See also [method get_file_export_mode].
+				Returns a dictionary of files selected in the "Resources" tab of the export dialog. The dictionary's keys are file paths, and its values are the corresponding export modes: [code]"strip"[/code], [code]"keep"[/code], or [code]"remove"[/code]. See also [method get_file_export_mode].
 			</description>
 		</method>
 		<method name="get_customized_files_count" qualifiers="const">
 			<return type="int" />
 			<description>
-				Returns number of files selected in the "Resources" tab of the export dialog.
+				Returns the number of files selected in the "Resources" tab of the export dialog.
 			</description>
 		</method>
 		<method name="get_encrypt_directory" qualifiers="const">
@@ -118,7 +118,7 @@
 		<method name="get_preset_name" qualifiers="const">
 			<return type="String" />
 			<description>
-				Returns export preset name.
+				Returns this export preset's name.
 			</description>
 		</method>
 		<method name="get_project_setting">
@@ -131,7 +131,7 @@
 		<method name="get_script_export_mode" qualifiers="const">
 			<return type="int" />
 			<description>
-				Returns script export mode.
+				Returns the export mode used by GDScript files. [code]0[/code] for "Text", [code]1[/code] for "Binary tokens", and [code]2[/code] for "Compressed binary tokens (smaller files)".
 			</description>
 		</method>
 		<method name="get_version" qualifiers="const">
@@ -154,19 +154,19 @@
 			<return type="bool" />
 			<param index="0" name="path" type="String" />
 			<description>
-				Returns [code]true[/code] if specified file is exported.
+				Returns [code]true[/code] if the file at the specified [param path] will be exported.
 			</description>
 		</method>
 		<method name="is_dedicated_server" qualifiers="const">
 			<return type="bool" />
 			<description>
-				Returns [code]true[/code] if dedicated server export mode is selected in the export dialog.
+				Returns [code]true[/code] if the dedicated server export mode is selected in the export dialog.
 			</description>
 		</method>
 		<method name="is_runnable" qualifiers="const">
 			<return type="bool" />
 			<description>
-				Returns [code]true[/code] if "Runnable" toggle is enabled in the export dialog.
+				Returns [code]true[/code] if the "Runnable" toggle is enabled in the export dialog.
 			</description>
 		</method>
 	</methods>

doc/classes/EditorFileDialog.xml

@@ -15,7 +15,7 @@
 			<param index="0" name="filter" type="String" />
 			<param index="1" name="description" type="String" default="&quot;&quot;" />
 			<description>
-				Adds a comma-delimited file name [param filter] option to the [EditorFileDialog] with an optional [param description], which restricts what files can be picked.
+				Adds a comma-separated file name [param filter] option to the [EditorFileDialog] with an optional [param description], which restricts what files can be picked.
 				A [param filter] should be of the form [code]"filename.extension"[/code], where filename and extension can be [code]*[/code] to match any string. Filters starting with [code].[/code] (i.e. empty filenames) are not allowed.
 				For example, a [param filter] of [code]"*.tscn, *.scn"[/code] and a [param description] of [code]"Scenes"[/code] results in filter text "Scenes (*.tscn, *.scn)".
 			</description>