From 054ac5c8f5d07ef86f76664ec6b5c3b60b812240 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Tue, 18 Jun 2019 15:07:31 +0200 Subject: doc: Sync classref with current source Fix a few bugs. --- doc/classes/CPUParticles2D.xml | 4 ++-- doc/classes/ItemList.xml | 10 +++++----- doc/classes/OS.xml | 6 +++--- doc/classes/TextEdit.xml | 6 +++--- 4 files changed, 13 insertions(+), 13 deletions(-) (limited to 'doc/classes') diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml index e6df2d2f27..7283d5084c 100644 --- a/doc/classes/CPUParticles2D.xml +++ b/doc/classes/CPUParticles2D.xml @@ -99,7 +99,7 @@ Particles will be emitted inside this region. Use [enum EmissionShape] for values. Default value: [constant EMISSION_SHAPE_POINT]. - The circle's radius if [member emission_shape] is set to [constant EMISSION_SHAPE_CIRCLE]. + The sphere's radius if [member emission_shape] is set to [constant EMISSION_SHAPE_SPHERE]. If [code]true[/code], particles are being emitted. Default value: [code]true[/code]. @@ -271,7 +271,7 @@ All particles will be emitted from a single point. - Particles will be emitted on the surface of a sphere flattened to two dimensions. + Particles will be emitted on the surface of a sphere flattened to two dimensions. Particles will be emitted in the area of a rectangle. diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index f86897a6f0..d78c930351 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -73,7 +73,7 @@ - Returns the [Color] set by [member set_custom_bg_color]. Default value is [code]Color(0, 0, 0, 0)[/code]. + Returns the custom background color of the item specified by [code]idx[/code] index. Default value is [code]Color(0, 0, 0, 0)[/code]. @@ -82,7 +82,7 @@ - Returns the [Color] set by [member set_custom_fg_color]. Default value is [code]Color(0, 0, 0, 0)[/code]. + Returns the custom foreground color of the item specified by [code]idx[/code] index. Default value is [code]Color(0, 0, 0, 0)[/code]. @@ -117,7 +117,7 @@ - Returns the metadata value of the specified index set by [member set_item_metadata]. + Returns the metadata value of the specified index. @@ -416,7 +416,7 @@ Sets the default icon size in pixels. - Sets the default position of the icon to either [const ICON_MODE_LEFT] or [const ICON_MODE_TOP]. + Sets the default position of the icon to either [constant ICON_MODE_LEFT] or [constant ICON_MODE_TOP]. Sets the icon size to its initial size multiplied by the specified scale. Default value is 1.0. @@ -431,7 +431,7 @@ If set to [code]true[/code], all columns will have the same width specified by [member fixed_column_width]. - Allow single or multiple item selection. See the [code]SELECT_*[/code] constants. + Allow single or multiple item selection. See the [enum SelectMode] constants. diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 2c680e828e..7b50021284 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -811,12 +811,12 @@ If [code]true[/code], the engine optimizes for low processor usage by only refreshing the screen if needed. Can improve battery consumption on mobile. - - The minimum size of the window (without counting window manager decorations). Does not affect fullscreen mode. Set to [code](0, 0)[/code] to reset to the system default value. - The maximum size of the window (without counting window manager decorations). Does not affect fullscreen mode. Set to [code](0, 0)[/code] to reset to the system default value. + + The minimum size of the window (without counting window manager decorations). Does not affect fullscreen mode. Set to [code](0, 0)[/code] to reset to the system default value. + The current screen orientation. diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 3e4b70f8f8..6c4411dc89 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -105,7 +105,7 @@ Moves the cursor at the specified [code]line[/code] index. If [code]adjust_viewport[/code] is set to true, the viewport will center at the cursor position after the move occurs. Default value is [code]true[/code]. - If [code]can_be_hidden[/code] is set to true, the specified [code]line[/code] can be hidden using [member set_line_as_hidden]. Default value is [code]true[/code]. + If [code]can_be_hidden[/code] is set to true, the specified [code]line[/code] can be hidden using [method set_line_as_hidden]. Default value is [code]true[/code]. @@ -369,7 +369,7 @@ - Unhide all lines that were previously set to hidden by [member set_line_as_hidden]. + Unhide all lines that were previously set to hidden by [method set_line_as_hidden]. @@ -404,7 +404,7 @@ If [code]true[/code], the fold gutter is visible. This enables folding groups of indented lines. - If [code]true[/code], all lines that have been set to hidden by [member set_line_as_hidden], will not be visible. + If [code]true[/code], all lines that have been set to hidden by [method set_line_as_hidden], will not be visible. If [code]true[/code], all occurrences of the selected text will be highlighted. -- cgit v1.2.3