Skip to content

Commit 5b8b9ac

Browse files
committed
Fix miscellaneous oddities around the class reference (part 7)
1 parent 3a97723 commit 5b8b9ac

38 files changed

+93
-94
lines changed

doc/classes/Array.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -348,7 +348,7 @@
348348
<return type="Array" />
349349
<param index="0" name="deep_subresources_mode" type="int" default="1" />
350350
<description>
351-
Duplicates this array, deeply, like [method duplicate][code](true)[/code], with extra control over how subresources are handled.
351+
Duplicates this array, deeply, like [method duplicate] when passing [code]true[/code], with extra control over how subresources are handled.
352352
[param deep_subresources_mode] must be one of the values from [enum Resource.DeepDuplicateMode]. By default, only internal resources will be duplicated (recursively).
353353
</description>
354354
</method>

doc/classes/BaseMaterial3D.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@
160160
Determines when depth rendering takes place. See also [member transparency].
161161
</member>
162162
<member name="depth_test" type="int" setter="set_depth_test" getter="get_depth_test" enum="BaseMaterial3D.DepthTest" default="0" experimental="May be affected by future rendering pipeline changes.">
163-
Determines which comparison operator is used when testing depth. See [enum DepthTest].
163+
Determines which comparison operator is used when testing depth.
164164
[b]Note:[/b] Changing [member depth_test] to a non-default value only has a visible effect when used on a transparent material, or a material that has [member depth_draw_mode] set to [constant DEPTH_DRAW_DISABLED].
165165
</member>
166166
<member name="detail_albedo" type="Texture2D" setter="set_texture" getter="get_texture">
@@ -382,13 +382,13 @@
382382
The primary color of the stencil effect.
383383
</member>
384384
<member name="stencil_compare" type="int" setter="set_stencil_compare" getter="get_stencil_compare" enum="BaseMaterial3D.StencilCompare" default="0" experimental="May be affected by future rendering pipeline changes.">
385-
The comparison operator to use for stencil masking operations. See [enum StencilCompare].
385+
The comparison operator to use for stencil masking operations.
386386
</member>
387387
<member name="stencil_flags" type="int" setter="set_stencil_flags" getter="get_stencil_flags" default="0" experimental="May be affected by future rendering pipeline changes.">
388-
The flags dictating how the stencil operation behaves. See [enum StencilFlags].
388+
The flags dictating how the stencil operation behaves.
389389
</member>
390390
<member name="stencil_mode" type="int" setter="set_stencil_mode" getter="get_stencil_mode" enum="BaseMaterial3D.StencilMode" default="0" experimental="May be affected by future rendering pipeline changes.">
391-
The stencil effect mode. See [enum StencilMode].
391+
The stencil effect mode.
392392
</member>
393393
<member name="stencil_outline_thickness" type="float" setter="set_stencil_effect_outline_thickness" getter="get_stencil_effect_outline_thickness" default="0.01" experimental="May be affected by future rendering pipeline changes.">
394394
The outline thickness for [constant STENCIL_MODE_OUTLINE].
@@ -862,7 +862,7 @@
862862
Enables stencil operations without a preset.
863863
</constant>
864864
<constant name="STENCIL_FLAG_READ" value="1" enum="StencilFlags">
865-
The material will only be rendered where it passes a stencil comparison with existing stencil buffer values. See [enum StencilCompare].
865+
The material will only be rendered where it passes a stencil comparison with existing stencil buffer values.
866866
</constant>
867867
<constant name="STENCIL_FLAG_WRITE" value="2" enum="StencilFlags">
868868
The material will write the reference value to the stencil buffer where it passes the depth test.

doc/classes/CanvasItem.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -633,7 +633,7 @@
633633
<return type="void" />
634634
<param index="0" name="enable" type="bool" />
635635
<description>
636-
If [code]true[/code], the node will receive [constant NOTIFICATION_TRANSFORM_CHANGED] whenever global transform changes.
636+
If [code]true[/code], the node will receive [constant NOTIFICATION_TRANSFORM_CHANGED] whenever its global transform changes.
637637
[b]Note:[/b] Many canvas items such as [Camera2D] or [Light2D] automatically enable this in order to function correctly.
638638
</description>
639639
</method>

doc/classes/Dictionary.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@
229229
<return type="Dictionary" />
230230
<param index="0" name="deep_subresources_mode" type="int" default="1" />
231231
<description>
232-
Duplicates this dictionary, deeply, like [method duplicate][code](true)[/code], with extra control over how subresources are handled.
232+
Duplicates this dictionary, deeply, like [method duplicate] when passing [code]true[/code], with extra control over how subresources are handled.
233233
[param deep_subresources_mode] must be one of the values from [enum Resource.DeepDuplicateMode]. By default, only internal resources will be duplicated (recursively).
234234
</description>
235235
</method>
@@ -508,7 +508,7 @@
508508
<param index="0" name="key" type="Variant" />
509509
<param index="1" name="value" type="Variant" />
510510
<description>
511-
Sets the value of the element at the given [param key] to the given [param value]. This is the same as using the [code][][/code] operator ([code]dict[key] = value[/code]). Returns [code]true[/code] if the value is set successfully. Fails and returns [code]false[/code] if the dictionary is read-only, or if [param key] and [param value] don't match the dictionary's types.
511+
Sets the value of the element at the given [param key] to the given [param value]. Returns [code]true[/code] if the value is set successfully. Fails and returns [code]false[/code] if the dictionary is read-only, or if [param key] and [param value] don't match the dictionary's types. This is the same as using the [code][][/code] operator ([code]dict[key] = value[/code]).
512512
</description>
513513
</method>
514514
<method name="size" qualifiers="const">

doc/classes/DisplayServer.xml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@
7979
<description>
8080
Returns [code]1[/code] if a screen reader, Braille display or other assistive app is active, [code]0[/code] otherwise. Returns [code]-1[/code] if status is unknown.
8181
[b]Note:[/b] This method is implemented on Linux, macOS, and Windows.
82-
[b]Note:[/b] Accessibility debugging tools, such as Accessibility Insights for Windows, macOS Accessibility Inspector, or AT-SPI Browser do not count as assistive apps and will not affect this value. To test your app with these tools, set [member ProjectSettings.accessibility/general/accessibility_support] to [code]1[/code].
82+
[b]Note:[/b] Accessibility debugging tools, such as Accessibility Insights for Windows, Accessibility Inspector (macOS), or AT-SPI Browser (Linux/BSD), do not count as assistive apps and will not affect this value. To test your project with these tools, set [member ProjectSettings.accessibility/general/accessibility_support] to [code]1[/code].
8383
</description>
8484
</method>
8585
<method name="accessibility_set_window_focused">
@@ -1845,7 +1845,7 @@
18451845
<return type="void" />
18461846
<param index="0" name="callable" type="Callable" />
18471847
<description>
1848-
Sets the [param callable] that should be called when hardware keyboard is connected/disconnected. [param callable] should accept a single [bool] parameter indicating whether the keyboard is connected (true) or disconnected (false).
1848+
Sets the callback that should be called when a hardware keyboard is connected or disconnected. [param callable] should accept a single [bool] argument indicating whether the keyboard has been connected ([code]true[/code]) or disconnected ([code]false[/code]).
18491849
[b]Note:[/b] This method is only implemented on Android.
18501850
</description>
18511851
</method>
@@ -1869,7 +1869,7 @@
18691869
<return type="void" />
18701870
<param index="0" name="callable" type="Callable" />
18711871
<description>
1872-
Sets the [param callable] that should be called when system theme settings are changed. Callback method should have zero arguments.
1872+
Sets the callback that should be called when the system's theme settings are changed. [param callable] should accept zero arguments.
18731873
[b]Note:[/b] This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland).
18741874
</description>
18751875
</method>
@@ -2058,8 +2058,8 @@
20582058
<method name="virtual_keyboard_get_height" qualifiers="const">
20592059
<return type="int" />
20602060
<description>
2061-
Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or if it is currently hidden.
2062-
[b]Note:[/b] On Android 7 and 8, the keyboard height may return 0 the first time the keyboard is opened in non-immersive mode. This behavior does not occur in immersive mode.
2061+
Returns the on-screen keyboard's height in pixels. Returns [code]0[/code] if there is no keyboard or if it is currently hidden.
2062+
[b]Note:[/b] On Android 7 and 8, the keyboard height may return [code]0[/code] the first time the keyboard is opened in non-immersive mode. This behavior does not occur in immersive mode.
20632063
</description>
20642064
</method>
20652065
<method name="virtual_keyboard_hide">
@@ -2236,14 +2236,14 @@
22362236
<method name="window_maximize_on_title_dbl_click" qualifiers="const">
22372237
<return type="bool" />
22382238
<description>
2239-
Returns [code]true[/code], if double-click on a window title should maximize it.
2239+
Returns [code]true[/code] if double-clicking on a window's title should maximize it.
22402240
[b]Note:[/b] This method is implemented only on macOS.
22412241
</description>
22422242
</method>
22432243
<method name="window_minimize_on_title_dbl_click" qualifiers="const">
22442244
<return type="bool" />
22452245
<description>
2246-
Returns [code]true[/code], if double-click on a window title should minimize it.
2246+
Returns [code]true[/code] if double-clicking on a window's title should minimize it.
22472247
[b]Note:[/b] This method is implemented only on macOS.
22482248
</description>
22492249
</method>
@@ -2774,7 +2774,7 @@
27742774
Element is hidden for accessibility tools.
27752775
</constant>
27762776
<constant name="FLAG_MULTISELECTABLE" value="1" enum="AccessibilityFlags">
2777-
Element is support multiple item selection.
2777+
Element supports multiple item selection.
27782778
</constant>
27792779
<constant name="FLAG_REQUIRED" value="2" enum="AccessibilityFlags">
27802780
Element require user input.
@@ -3146,7 +3146,7 @@
31463146
[b]Note:[/b] This flag is implemented on macOS and Windows.
31473147
</constant>
31483148
<constant name="WINDOW_FLAG_MAX" value="13" enum="WindowFlags">
3149-
Max value of the [enum WindowFlags].
3149+
Represents the size of the [enum WindowFlags] enum.
31503150
</constant>
31513151
<constant name="WINDOW_EVENT_MOUSE_ENTER" value="0" enum="WindowEvent">
31523152
Sent when the mouse pointer enters the window.
@@ -3176,7 +3176,7 @@
31763176
[b]Note:[/b] This flag is implemented only on macOS.
31773177
</constant>
31783178
<constant name="WINDOW_EVENT_FORCE_CLOSE" value="8" enum="WindowEvent">
3179-
Sent when the window has been forcibly closed by the Display Server. The window shall immediately hide and clean any internal rendering references.
3179+
Sent when the window has been forcibly closed by the display server. The window will immediately hide and clean any internal rendering references.
31803180
[b]Note:[/b] This flag is implemented only on Linux (Wayland).
31813181
</constant>
31823182
<constant name="WINDOW_EDGE_TOP_LEFT" value="0" enum="WindowResizeEdge">

doc/classes/EditorExportPlatformExtension.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
<param index="0" name="preset" type="EditorExportPreset" />
1616
<param index="1" name="debug" type="bool" />
1717
<description>
18-
Returns [code]true[/code], if specified [param preset] is valid and can be exported. Use [method set_config_error] and [method set_config_missing_templates] to set error details.
19-
Usual implementation can call [method _has_valid_export_configuration] and [method _has_valid_project_configuration] to determine if export is possible.
18+
Returns [code]true[/code] if the specified [param preset] is valid and can be exported. Use [method set_config_error] and [method set_config_missing_templates] to set error details.
19+
Usual implementations call [method _has_valid_export_configuration] and [method _has_valid_project_configuration] to determine if exporting is possible.
2020
</description>
2121
</method>
2222
<method name="_cleanup" qualifiers="virtual">

doc/classes/EditorSettings.xml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -899,13 +899,14 @@
899899
- [b]Auto[/b] ([code]0[/code]): Accessibility support is enabled, but updates to the accessibility information are processed only if an assistive app (such as a screen reader or a Braille display) is active (default).
900900
- [b]Always Active[/b] ([code]1[/code]): Accessibility support is enabled, and updates to the accessibility information are always processed, regardless of the status of assistive apps.
901901
- [b]Disabled[/b] ([code]2[/code]): Accessibility support is fully disabled.
902-
[b]Note:[/b] Accessibility debugging tools, such as Accessibility Insights for Windows, Accessibility Inspector (macOS), or AT-SPI Browser (Linux/BSD) do not count as assistive apps. To test your project with these tools, use [b]Always Active[/b].
902+
[b]Note:[/b] Accessibility debugging tools, such as Accessibility Insights for Windows, Accessibility Inspector (macOS), or AT-SPI Browser (Linux/BSD), do not count as assistive apps. To test the editor with these tools, use [b]Always Active[/b].
903903
</member>
904904
<member name="interface/editor/accept_dialog_cancel_ok_buttons" type="int" setter="" getter="">
905-
How to position the Cancel and OK buttons in the editor's [AcceptDialog]s. Different platforms have different standard behaviors for this, which can be overridden using this setting. This is useful if you use Godot both on Windows and macOS/Linux and your Godot muscle memory is stronger than your OS specific one.
906-
- [b]Auto[/b] follows the platform convention: OK first on Windows, KDE, and LXQt, Cancel first on macOS and other Linux desktop environments.
907-
- [b]Cancel First[/b] forces the ordering Cancel/OK.
908-
- [b]OK First[/b] forces the ordering OK/Cancel.
905+
How to position the Cancel and OK buttons in the editor's [AcceptDialog] windows. Different platforms have different conventions for this, which can be overridden through this setting to avoid accidental clicks when using Godot on multiple platforms.
906+
- [b]Auto[/b] follows the platform convention: OK first on Windows, KDE, and LXQt; Cancel first on macOS and other Linux desktop environments.
907+
- [b]Cancel First[/b] forces the Cancel/OK ordering.
908+
- [b]OK First[/b] forces the OK/Cancel ordering.
909+
To check if these buttons are swapped at runtime, use [method DisplayServer.get_swap_cancel_ok].
909910
</member>
910911
<member name="interface/editor/automatically_open_screenshots" type="bool" setter="" getter="">
911912
If [code]true[/code], automatically opens screenshots with the default program associated to [code].png[/code] files after a screenshot is taken using the [b]Editor &gt; Take Screenshot[/b] action.

doc/classes/FileAccess.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@
238238
<return type="bool" />
239239
<param index="0" name="file" type="String" />
240240
<description>
241-
Returns [code]true[/code], if file [code]hidden[/code] attribute is set.
241+
Returns [code]true[/code] if the [b]hidden[/b] attribute is set on the file at the given path.
242242
[b]Note:[/b] This method is implemented on iOS, BSD, macOS, and Windows.
243243
</description>
244244
</method>
@@ -304,7 +304,7 @@
304304
<return type="bool" />
305305
<param index="0" name="file" type="String" />
306306
<description>
307-
Returns [code]true[/code], if file [code]read only[/code] attribute is set.
307+
Returns [code]true[/code] if the [b]read only[/b] attribute is set on the file at the given path.
308308
[b]Note:[/b] This method is implemented on iOS, BSD, macOS, and Windows.
309309
</description>
310310
</method>
@@ -417,15 +417,15 @@
417417
<return type="void" />
418418
<param index="0" name="position" type="int" />
419419
<description>
420-
Changes the file reading/writing cursor to the specified position (in bytes from the beginning of the file). This changes the value returned by [method get_position].
420+
Sets the file cursor to the specified position in bytes, from the beginning of the file. This changes the value returned by [method get_position].
421421
</description>
422422
</method>
423423
<method name="seek_end">
424424
<return type="void" />
425425
<param index="0" name="position" type="int" default="0" />
426426
<description>
427-
Changes the file reading/writing cursor to the specified position (in bytes from the end of the file). This changes the value returned by [method get_position].
428-
[b]Note:[/b] This is an offset, so you should use negative numbers or the file cursor will be at the end of the file.
427+
Sets the file cursor to the specified position in bytes, from the end of the file. This changes the value returned by [method get_position].
428+
[b]Note:[/b] This is an offset, so you should use negative numbers otherwise the file cursor will be at the end of the file.
429429
</description>
430430
</method>
431431
<method name="set_extended_attribute" qualifiers="static">
@@ -565,7 +565,7 @@
565565
<param index="0" name="values" type="PackedStringArray" />
566566
<param index="1" name="delim" type="String" default="&quot;,&quot;" />
567567
<description>
568-
Store the given [PackedStringArray] in the file as a line formatted in the CSV (Comma-Separated Values) format. You can pass a different delimiter [param delim] to use other than the default [code]","[/code] (comma). This delimiter must be one-character long.
568+
Stores the given [PackedStringArray] in the file as a line formatted in the CSV (Comma-Separated Values) format. You can pass a different delimiter [param delim] to use other than the default [code]","[/code] (comma). This delimiter must be one-character long.
569569
Text will be encoded as UTF-8. Returns [code]true[/code] if the operation is successful.
570570
[b]Note:[/b] If an error occurs, the resulting value of the file position indicator is indeterminate.
571571
</description>

doc/classes/FileDialog.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@
123123
<param index="0" name="flag" type="int" enum="FileDialog.Customization" />
124124
<param index="1" name="enabled" type="bool" />
125125
<description>
126-
Toggles the specified customization [param flag], allowing to customize features available in this [FileDialog]. See [enum Customization] for options.
126+
Sets the specified customization [param flag], allowing to customize the features available in this [FileDialog].
127127
</description>
128128
</method>
129129
<method name="set_favorite_list" qualifiers="static">

doc/classes/Font.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -322,14 +322,14 @@
322322
<return type="bool" />
323323
<param index="0" name="language" type="String" />
324324
<description>
325-
Returns [code]true[/code], if font supports given language ([url=https://en.wikipedia.org/wiki/ISO_639-1]ISO 639[/url] code).
325+
Returns [code]true[/code] if the font supports the given language (as a [url=https://en.wikipedia.org/wiki/ISO_639-1]ISO 639[/url] code).
326326
</description>
327327
</method>
328328
<method name="is_script_supported" qualifiers="const">
329329
<return type="bool" />
330330
<param index="0" name="script" type="String" />
331331
<description>
332-
Returns [code]true[/code], if font supports given script ([url=https://en.wikipedia.org/wiki/ISO_15924]ISO 15924[/url] code).
332+
Returns [code]true[/code] if the font supports the given script (as a [url=https://en.wikipedia.org/wiki/ISO_15924]ISO 15924[/url] code).
333333
</description>
334334
</method>
335335
<method name="set_cache_capacity">

0 commit comments

Comments
 (0)