From 85c136bd0718d03961b030333d4a4a042486f51e Mon Sep 17 00:00:00 2001 From: Haoyu Qiu Date: Thu, 2 Dec 2021 16:15:13 +0800 Subject: [PATCH] Fix various misused code tag in classref --- doc/classes/Camera3D.xml | 4 ++-- doc/classes/Line2D.xml | 2 +- doc/classes/Node.xml | 4 ++-- doc/classes/PhysicsServer3D.xml | 8 ++++---- doc/classes/TranslationServer.xml | 2 +- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/classes/Camera3D.xml b/doc/classes/Camera3D.xml index 06e2f83f055..772396befea 100644 --- a/doc/classes/Camera3D.xml +++ b/doc/classes/Camera3D.xml @@ -218,10 +218,10 @@ Disables [url=https://en.wikipedia.org/wiki/Doppler_effect]Doppler effect[/url] simulation (default). - Simulate [url=https://en.wikipedia.org/wiki/Doppler_effect]Doppler effect[/url] by tracking positions of objects that are changed in [code]_process[/code]. Changes in the relative velocity of this camera compared to those objects affect how Audio is perceived (changing the Audio's [code]pitch shift[/code]). + Simulate [url=https://en.wikipedia.org/wiki/Doppler_effect]Doppler effect[/url] by tracking positions of objects that are changed in [code]_process[/code]. Changes in the relative velocity of this camera compared to those objects affect how audio is perceived (changing the audio's [member AudioStreamPlayer3D.pitch_scale]). - Simulate [url=https://en.wikipedia.org/wiki/Doppler_effect]Doppler effect[/url] by tracking positions of objects that are changed in [code]_physics_process[/code]. Changes in the relative velocity of this camera compared to those objects affect how Audio is perceived (changing the Audio's [code]pitch shift[/code]). + Simulate [url=https://en.wikipedia.org/wiki/Doppler_effect]Doppler effect[/url] by tracking positions of objects that are changed in [code]_physics_process[/code]. Changes in the relative velocity of this camera compared to those objects affect how audio is perceived (changing the audio's [member AudioStreamPlayer3D.pitch_scale]). diff --git a/doc/classes/Line2D.xml b/doc/classes/Line2D.xml index 4d9abbbb193..5e673cc19b8 100644 --- a/doc/classes/Line2D.xml +++ b/doc/classes/Line2D.xml @@ -82,7 +82,7 @@ The smoothness of the rounded joints and caps. This is only used if a cap or joint is set as round. - The direction difference in radians between vector points. This value is only used if [code]joint mode[/code] is set to [constant LINE_JOINT_SHARP]. + The direction difference in radians between vector points. This value is only used if [member joint_mode] is set to [constant LINE_JOINT_SHARP]. The texture used for the line's texture. Uses [code]texture_mode[/code] for drawing style. diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index c75b2e305e7..f1ab5e4843e 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -261,7 +261,7 @@ - Fetches a node. The [NodePath] can be either a relative path (from the current node) or an absolute path (in the scene tree) to a node. If the path does not exist, a [code]null instance[/code] is returned and an error is logged. Attempts to access methods on the return value will result in an "Attempt to call <method> on a null instance." error. + Fetches a node. The [NodePath] can be either a relative path (from the current node) or an absolute path (in the scene tree) to a node. If the path does not exist, [code]null[/code] is returned and an error is logged. Attempts to access methods on the return value will result in an "Attempt to call <method> on a null instance." error. [b]Note:[/b] Fetching absolute paths only works when the node is inside the scene tree (see [method is_inside_tree]). [b]Example:[/b] Assume your current node is Character and the following tree: [codeblock] @@ -322,7 +322,7 @@ - Returns the parent node of the current node, or a [code]null instance[/code] if the node lacks a parent. + Returns the parent node of the current node, or [code]null[/code] if the node lacks a parent. diff --git a/doc/classes/PhysicsServer3D.xml b/doc/classes/PhysicsServer3D.xml index dd8003be1dd..ceb3e788d21 100644 --- a/doc/classes/PhysicsServer3D.xml +++ b/doc/classes/PhysicsServer3D.xml @@ -1152,16 +1152,16 @@ Maximum acceleration for the motor at the axes. - If [code]set[/code] there is linear motion possible within the given limits. + If set, linear motion is possible within the given limits. - If [code]set[/code] there is rotational motion possible. + If set, rotational motion is possible. - If [code]set[/code] there is a rotational motor across these axes. + If set, there is a rotational motor across these axes. - If [code]set[/code] there is a linear motor on this axis that targets a specific velocity. + If set, there is a linear motor on this axis that targets a specific velocity. The [Shape3D] is a [WorldBoundaryShape3D]. diff --git a/doc/classes/TranslationServer.xml b/doc/classes/TranslationServer.xml index 519e1cb0414..a1b4404079e 100644 --- a/doc/classes/TranslationServer.xml +++ b/doc/classes/TranslationServer.xml @@ -49,7 +49,7 @@ Returns the [Translation] instance based on the [code]locale[/code] passed in. - It will return a [code]nullptr[/code] if there is no [Translation] instance that matches the [code]locale[/code]. + It will return [code]null[/code] if there is no [Translation] instance that matches the [code]locale[/code].