From 7f9bf5472c299f15f01ccab82d380cd3d946e57f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Sun, 12 Jan 2020 14:30:21 +0100 Subject: [PATCH] doc: Sync classref with current source --- doc/classes/KinematicBody.xml | 9 ++++++++- doc/classes/KinematicBody2D.xml | 7 +++++++ doc/classes/LineEdit.xml | 10 +++++----- doc/classes/ProjectSettings.xml | 3 +++ doc/classes/SpinBox.xml | 14 +++++++------- doc/classes/TextEdit.xml | 12 ++++++------ doc/classes/VisibilityEnabler.xml | 2 +- doc/classes/VisibilityEnabler2D.xml | 2 +- doc/classes/VisualServer.xml | 10 +++++----- doc/classes/VisualShaderNodeFresnel.xml | 2 +- 10 files changed, 44 insertions(+), 27 deletions(-) diff --git a/doc/classes/KinematicBody.xml b/doc/classes/KinematicBody.xml index 164932749fa..f796b153078 100644 --- a/doc/classes/KinematicBody.xml +++ b/doc/classes/KinematicBody.xml @@ -21,6 +21,13 @@ Returns [code]true[/code] if the specified [code]axis[/code] is locked. See also [member move_lock_x], [member move_lock_y] and [member move_lock_z]. + + + + + Returns the normal vector of the floor. + + @@ -86,7 +93,7 @@ - + diff --git a/doc/classes/KinematicBody2D.xml b/doc/classes/KinematicBody2D.xml index 99a83765eb5..1de75cd71ba 100644 --- a/doc/classes/KinematicBody2D.xml +++ b/doc/classes/KinematicBody2D.xml @@ -13,6 +13,13 @@ https://docs.godotengine.org/en/latest/tutorials/physics/using_kinematic_body_2d.html + + + + + Returns the normal vector of the floor. + + diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index d428c133afd..31cfc156496 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -138,6 +138,11 @@ + + + Emitted when trying to append text that would overflow the [member max_length]. + + @@ -145,11 +150,6 @@ Emitted when the text changes. - - - Emitted when trying to append text that would overflow the [member max_length]. - - diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 1bc43dc9642..1e714d92c2c 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -321,6 +321,9 @@ If [code]true[/code], enables warnings when calling an expression that has no effect on the surrounding code, such as writing [code]2 + 2[/code] as a statement. + + If [code]true[/code], enables warnings when calling a ternary expression that has no effect on the surrounding code, such as writing [code]42 if active else 0[/code] as a statement. + If [code]true[/code], all warnings will be reported as if they were errors. diff --git a/doc/classes/SpinBox.xml b/doc/classes/SpinBox.xml index 1fbced77dc3..dfa14fc512f 100644 --- a/doc/classes/SpinBox.xml +++ b/doc/classes/SpinBox.xml @@ -19,13 +19,6 @@ - - - - - Returns the [LineEdit] instance from this [SpinBox]. You can use it to access properties and methods of [LineEdit]. - - @@ -33,6 +26,13 @@ Applies the current value of this [SpinBox]. + + + + + Returns the [LineEdit] instance from this [SpinBox]. You can use it to access properties and methods of [LineEdit]. + + diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index ad2cadb96b6..3deed63ae7b 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -437,6 +437,12 @@ If [code]true[/code], read-only mode is enabled. Existing text cannot be modified and new text cannot be added. + + The current horizontal scroll value. + + + The current vertical scroll value. + @@ -459,12 +465,6 @@ If [code]true[/code], enables text wrapping when it goes beyond the edge of what is visible. - - The current vertical scroll value. - - - The current horizontal scroll value. - diff --git a/doc/classes/VisibilityEnabler.xml b/doc/classes/VisibilityEnabler.xml index 56fa7b77a94..8636d9c8d23 100644 --- a/doc/classes/VisibilityEnabler.xml +++ b/doc/classes/VisibilityEnabler.xml @@ -15,7 +15,7 @@ - Returns whether the enabler identified by given [enum Enabler] constant is active. + Returns whether the enabler identified by given [enum Enabler] constant is active. diff --git a/doc/classes/VisibilityEnabler2D.xml b/doc/classes/VisibilityEnabler2D.xml index 547793c3851..095a377ccbd 100644 --- a/doc/classes/VisibilityEnabler2D.xml +++ b/doc/classes/VisibilityEnabler2D.xml @@ -15,7 +15,7 @@ - Returns whether the enabler identified by given [enum Enabler] constant is active. + Returns whether the enabler identified by given [enum Enabler] constant is active. diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index 6b667212371..c00710ade96 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -2045,7 +2045,7 @@ - Sets the lightmap to use with this instance. + Sets the lightmap to use with this instance. @@ -3371,7 +3371,7 @@ Creates a scenario and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]scenario_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. - The scenario is the 3D world that all the visual instances exist in. + The scenario is the 3D world that all the visual instances exist in. @@ -4857,10 +4857,10 @@ Use the filmic tonemapper. - Use the ACES tonemapper. + Use the ACES tonemapper. - Lowest quality of screen space ambient occlusion. + Lowest quality of screen space ambient occlusion. Medium quality screen space ambient occlusion. @@ -4872,7 +4872,7 @@ Disables the blur set for SSAO. Will make SSAO look noisier. - Perform a 1x1 blur on the SSAO output. + Perform a 1x1 blur on the SSAO output. Performs a 2x2 blur on the SSAO output. diff --git a/doc/classes/VisualShaderNodeFresnel.xml b/doc/classes/VisualShaderNodeFresnel.xml index f79ae04abf3..b71f5c6f370 100644 --- a/doc/classes/VisualShaderNodeFresnel.xml +++ b/doc/classes/VisualShaderNodeFresnel.xml @@ -9,7 +9,7 @@ - +