Andrew/redot-engine
1
0
Fork 0
mirror of https://github.com/Redot-Engine/redot-engine.git synced 2025-12-06 07:17:42 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #107895 from AThousandShips/fix_doc_spelling

Browse Source 
[Docs] Various grammar and spelling fixes
This commit is contained in:
Thaddeus Crews
2025-06-24 09:58:50 -05:00
parent 6277e9d02b 2db7ecd410
commit 987832be46
41 changed files with 61 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
modules/openxr/doc_classes/OpenXRAPIExtension.xml
View File

@@ -140,7 +140,7 @@
<method name="get_system_id">
<return type="int" />
<description>
Returns the id of the system, which is a [url=https://registry.khronos.org/OpenXR/specs/1.0/man/html/XrSystemId.html]XrSystemId[/url] cast to an integer.
Returns the id of the system, which is an [url=https://registry.khronos.org/OpenXR/specs/1.0/man/html/XrSystemId.html]XrSystemId[/url] cast to an integer.
</description>
</method>
<method name="insert_debug_label">

2
modules/openxr/doc_classes/OpenXRBindingModifier.xml
View File

@@ -19,7 +19,7 @@
<return type="PackedByteArray" />
<description>
Returns the data that is sent to OpenXR when submitting the suggested interacting bindings this modifier is a part of.
[b]Note:[/b] This must be data compatible with a [code]XrBindingModificationBaseHeaderKHR[/code] structure.
[b]Note:[/b] This must be data compatible with an [code]XrBindingModificationBaseHeaderKHR[/code] structure.
</description>
</method>
</methods>

2
modules/openxr/doc_classes/OpenXRInteractionProfileMetadata.xml
View File

@@ -47,7 +47,7 @@
<description>
Registers a top level path to which profiles can be bound. For instance [code]/user/hand/left[/code] refers to the bind point for the player's left hand. Extensions can register additional top level paths, for instance a haptic vest extension might register [code]/user/body/vest[/code].
[param display_name] is the name shown to the user. [param openxr_path] is the top level path being registered. [param openxr_extension_name] is optional and ensures the top level path is only used if the specified extension is available/enabled.
When a top level path ends up being bound by OpenXR, a [XRPositionalTracker] is instantiated to manage the state of the device.
When a top level path ends up being bound by OpenXR, an [XRPositionalTracker] is instantiated to manage the state of the device.
</description>
</method>
</methods>

2
modules/openxr/doc_classes/OpenXRRenderModelExtension.xml
View File

@@ -87,7 +87,7 @@
<return type="String" />
<param index="0" name="render_model" type="RID" />
<description>
Returns the top level path associated with this [param render_model]. If provided this identifies whether the render model is associated with the players hands or other body part.
Returns the top level path associated with this [param render_model]. If provided this identifies whether the render model is associated with the player's hands or other body part.
</description>
</method>
<method name="render_model_is_animatable_node_visible" qualifiers="const">

2
modules/theora/doc_classes/VideoStreamTheora.xml
View File

@@ -5,7 +5,7 @@
</brief_description>
<description>
[VideoStream] resource handling the [url=https://www.theora.org/]Ogg Theora[/url] video format with [code].ogv[/code] extension. The Theora codec is decoded on the CPU.
[b]Note:[/b] While Ogg Theora videos can also have an [code].ogg[/code] extension, you will have to rename the extension to [code].ogv[/code] to use those videos within Godot.
[b]Note:[/b] While Ogg Theora videos can also have a [code].ogg[/code] extension, you will have to rename the extension to [code].ogv[/code] to use those videos within Godot.
</description>
<tutorials>
</tutorials>

2
modules/upnp/doc_classes/UPNP.xml
View File

@@ -173,7 +173,7 @@
Inconsistent parameters.
</constant>
<constant name="UPNP_RESULT_NO_SUCH_ENTRY_IN_ARRAY" value="4" enum="UPNPResult">
No such entry in array. May be returned if a given port, protocol combination is not found on an [UPNPDevice].
No such entry in array. May be returned if a given port, protocol combination is not found on a [UPNPDevice].
</constant>
<constant name="UPNP_RESULT_ACTION_FAILED" value="5" enum="UPNPResult">
The action failed.

2
modules/webxr/doc_classes/WebXRInterface.xml
View File

@@ -174,7 +174,7 @@
</member>
<member name="requested_reference_space_types" type="String" setter="set_requested_reference_space_types" getter="get_requested_reference_space_types">
A comma-seperated list of reference space types used by [method XRInterface.initialize] when setting up the WebXR session.
The reference space types are requested in order, and the first one supported by the users device or browser will be used. The [member reference_space_type] property contains the reference space type that was ultimately selected.
The reference space types are requested in order, and the first one supported by the user's device or browser will be used. The [member reference_space_type] property contains the reference space type that was ultimately selected.
This doesn't have any effect on the interface when already initialized.
Possible values come from [url=https://developer.mozilla.org/en-US/docs/Web/API/XRReferenceSpaceType]WebXR's XRReferenceSpaceType[/url]. If you want to use a particular reference space type, it must be listed in either [member required_features] or [member optional_features].
</member>