From 932b75e2477dd97775b5b29639c514e091a83cf2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Tue, 28 Jul 2020 01:08:44 +0200 Subject: doc: Sync classref with current source --- doc/classes/EditorInspector.xml | 4 +--- doc/classes/LineEdit.xml | 2 ++ doc/classes/OS.xml | 2 +- doc/classes/ProjectSettings.xml | 30 ++++++++++++++---------------- 4 files changed, 18 insertions(+), 20 deletions(-) (limited to 'doc/classes') diff --git a/doc/classes/EditorInspector.xml b/doc/classes/EditorInspector.xml index 5fbe427f67..6f03165a97 100644 --- a/doc/classes/EditorInspector.xml +++ b/doc/classes/EditorInspector.xml @@ -20,9 +20,7 @@ - - If [code]true[/code], horizontal scrolling is enabled. An horizontal scroll bar will display at the bottom of the inspector. - + diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index feac483fc4..f08a15d873 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -122,6 +122,8 @@ Duration (in seconds) of a caret's blinking cycle. + + The cursor's position inside the [LineEdit]. When set, the text may scroll to accommodate it. diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 5b4b5d02fb..26110df335 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -120,7 +120,7 @@ [codeblock] var arguments = {} for argument in OS.get_cmdline_args(): - if argument.find("=") > -1: + if argument.find("=") > -1: var key_value = argument.split("=") arguments[key_value[0].lstrip("--")] = key_value[1] [/codeblock] diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 733bb559cb..f13dbbae76 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -280,6 +280,10 @@ If [code]true[/code], displays getters and setters in autocompletion results in the script editor. This setting is meant to be used when porting old projects (Godot 2), as using member variables is the preferred style from Godot 3 onwards. + + + + If [code]true[/code], enables warnings when a constant is used as a function. @@ -292,15 +296,6 @@ If [code]true[/code], scripts in the [code]res://addons[/code] folder will not generate warnings. - - If [code]true[/code], enables warnings when a function is declared with the same name as a constant. - - - If [code]true[/code], enables warnings when a function is declared with the same name as a variable. This will turn into an error in a future version when first-class functions become supported in GDScript. - - - If [code]true[/code], enables warnings when a function assigned to a variable may yield and return a function state instead of a value. - If [code]true[/code], enables warnings when using a function as if it was a property. @@ -316,12 +311,16 @@ If [code]true[/code], enables warnings when using a property as if it was a function. + + If [code]true[/code], enables warnings when calling a function without using its return value (by assigning it to a variable or using it as a function argument). Such return values are sometimes used to denote possible errors using the [enum Error] enum. If [code]true[/code], enables warnings when defining a local or subclass member variable that would shadow a variable at an upper level (such as a member variable). + + 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. @@ -340,6 +339,8 @@ If [code]true[/code], enables warnings when unreachable code is detected (such as after a [code]return[/code] statement that will always be executed). + + If [code]true[/code], enables warnings when using an expression whose type may not be compatible with the function parameter expected. @@ -352,11 +353,11 @@ If [code]true[/code], enables warnings when accessing a property whose presence is not guaranteed at compile-time in the class. - - If [code]true[/code], enables warnings when a function parameter is unused. + - - If [code]true[/code], enables warnings when a member variable is unused. + + + If [code]true[/code], enables warnings when a signal is unused. @@ -364,9 +365,6 @@ If [code]true[/code], enables warnings when a local variable is unused. - - If [code]true[/code], enables warnings when a variable is declared with the same name as a function. This will turn into an error in a future version when first-class functions become supported in GDScript. - If [code]true[/code], enables warnings when assigning the result of a function that returns [code]void[/code] to a variable. -- cgit v1.2.3