Skip to content

Commit e15770e

Browse files
committed
Merge pull request godotengine#107472 from timothyqiu/classref-fixes
Fix various errors in the class reference
2 parents 7e385da + 0e5b06c commit e15770e

File tree

6 files changed

+11
-11
lines changed

6 files changed

+11
-11
lines changed

doc/classes/@GlobalScope.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2956,7 +2956,7 @@
29562956
Hints that a property will be changed on its own after setting, such as [member AudioStreamPlayer.playing] or [member GPUParticles3D.emitting].
29572957
</constant>
29582958
<constant name="PROPERTY_HINT_GROUP_ENABLE" value="42" enum="PropertyHint">
2959-
Hints that a boolean property will enable the feature associated with the group that it occurs in. Only works within a group or subgroup. Use the optional hint string [code]"feature"[/code] when the group only has variables that are meaningful when the feature is enabled.
2959+
Hints that a boolean property will enable the feature associated with the group that it occurs in. Only works within a group or subgroup. Use the optional hint string [code]"feature"[/code] when the group only has properties that are meaningful when the feature is enabled.
29602960
[b]Note:[/b] The [code]"feature"[/code] hint string does not modify or reset any values.
29612961
</constant>
29622962
<constant name="PROPERTY_HINT_INPUT_NAME" value="43" enum="PropertyHint">

doc/classes/CPUParticles2D.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@
9191
<param index="0" name="particle_flag" type="int" enum="CPUParticles2D.ParticleFlags" />
9292
<param index="1" name="enable" type="bool" />
9393
<description>
94-
Enables or disables the given flag.
94+
Enables or disables the given particle flag.
9595
</description>
9696
</method>
9797
</methods>

doc/classes/Control.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
<description>
3838
Godot calls this method to test if [param data] from a control's [method _get_drag_data] can be dropped at [param at_position]. [param at_position] is local to this control.
3939
This method should only be used to test the data. Process the data in [method _drop_data].
40-
[b]Note:[/b] If drag was initiated by keyboard shortcut or [method accessibility_drag], [param at_position] is set to [code]Vector2(INFINITY, INFINITY)[/code] and the currently selected item/text position should be used as drop position.
40+
[b]Note:[/b] If the drag was initiated by a keyboard shortcut or [method accessibility_drag], [param at_position] is set to [constant Vector2.INF], and the currently selected item/text position should be used as the drop position.
4141
[codeblocks]
4242
[gdscript]
4343
func _can_drop_data(position, data):
@@ -62,7 +62,7 @@
6262
<param index="1" name="data" type="Variant" />
6363
<description>
6464
Godot calls this method to pass you the [param data] from a control's [method _get_drag_data] result. Godot first calls [method _can_drop_data] to test if [param data] is allowed to drop at [param at_position] where [param at_position] is local to this control.
65-
[b]Note:[/b] If drag was initiated by keyboard shortcut or [method accessibility_drag], [param at_position] is set to [code]Vector2(INFINITY, INFINITY)[/code] and the currently selected item/text position should be used as drop position.
65+
[b]Note:[/b] If the drag was initiated by a keyboard shortcut or [method accessibility_drag], [param at_position] is set to [constant Vector2.INF], and the currently selected item/text position should be used as the drop position.
6666
[codeblocks]
6767
[gdscript]
6868
func _can_drop_data(position, data):
@@ -98,7 +98,7 @@
9898
<description>
9999
Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Returns [code]null[/code] if there is no data to drag. Controls that want to receive drop data should implement [method _can_drop_data] and [method _drop_data]. [param at_position] is local to this control. Drag may be forced with [method force_drag].
100100
A preview that will follow the mouse that should represent the data can be set with [method set_drag_preview]. A good time to set the preview is in this method.
101-
[b]Note:[/b] If drag was initiated by keyboard shortcut or [method accessibility_drag], [param at_position] is set to [code]Vector2(INFINITY, INFINITY)[/code] and the currently selected item/text position should be used as drop position.
101+
[b]Note:[/b] If the drag was initiated by a keyboard shortcut or [method accessibility_drag], [param at_position] is set to [constant Vector2.INF], and the currently selected item/text position should be used as the drag position.
102102
[codeblocks]
103103
[gdscript]
104104
func _get_drag_data(position):

doc/classes/DisplayServer.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2045,7 +2045,7 @@
20452045
<return type="void" />
20462046
<description>
20472047
Stops synthesis in progress and removes all utterances from the queue.
2048-
[b]Note:[/b] This method is implemented on Android, iOS, Web, Linux (X11/Linux), macOS, and Windows.
2048+
[b]Note:[/b] This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
20492049
</description>
20502050
</method>
20512051
<method name="unregister_additional_output">
@@ -2856,13 +2856,13 @@
28562856
Set scroll offset action, callback argument is set to [Vector2] with the scroll offset.
28572857
</constant>
28582858
<constant name="ACTION_SET_VALUE" value="20" enum="AccessibilityAction">
2859-
Set value action action, callback argument is set to [String] or number with the new value.
2859+
Set value action, callback argument is set to [String] or number with the new value.
28602860
</constant>
28612861
<constant name="ACTION_SHOW_CONTEXT_MENU" value="21" enum="AccessibilityAction">
28622862
Show context menu action, callback argument is not set.
28632863
</constant>
28642864
<constant name="ACTION_CUSTOM" value="22" enum="AccessibilityAction">
2865-
Custom action, callback argument is set to the integer action id.
2865+
Custom action, callback argument is set to the integer action ID.
28662866
</constant>
28672867
<constant name="LIVE_OFF" value="0" enum="AccessibilityLiveMode">
28682868
Indicates that updates to the live region should not be presented.

doc/classes/FoldableContainer.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,10 @@
5757
The container's title text.
5858
</member>
5959
<member name="title_alignment" type="int" setter="set_title_alignment" getter="get_title_alignment" enum="HorizontalAlignment" default="0">
60-
Title's horizontal text alignment as defined in the [enum HorizontalAlignment] enum.
60+
Title's horizontal text alignment.
6161
</member>
6262
<member name="title_position" type="int" setter="set_title_position" getter="get_title_position" enum="FoldableContainer.TitlePosition" default="0">
63-
Title's position as defined in the [enum TitlePosition] enum.
63+
Title's position.
6464
</member>
6565
<member name="title_text_direction" type="int" setter="set_title_text_direction" getter="get_title_text_direction" enum="Control.TextDirection" default="0">
6666
Title text writing direction.

doc/classes/LabelSettings.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@
164164
The number of stacked outlines.
165165
</member>
166166
<member name="stacked_shadow_count" type="int" setter="set_stacked_shadow_count" getter="get_stacked_shadow_count" default="0">
167-
Returns the stacked shadow count.
167+
The number of stacked shadows.
168168
</member>
169169
</members>
170170
</class>

0 commit comments

Comments
 (0)