diff options
author | Rémi Verschelde <rverschelde@gmail.com> | 2019-06-18 15:07:31 +0200 |
---|---|---|
committer | Rémi Verschelde <rverschelde@gmail.com> | 2019-06-18 15:07:31 +0200 |
commit | 054ac5c8f5d07ef86f76664ec6b5c3b60b812240 (patch) | |
tree | f94f72ed29122ed26c108933fb1b57f5847c3b21 | |
parent | 08ebeee0e14b123a4b6c5b6b01c5f250f7b5662c (diff) |
doc: Sync classref with current source
Fix a few bugs.
-rw-r--r-- | doc/classes/CPUParticles2D.xml | 4 | ||||
-rw-r--r-- | doc/classes/ItemList.xml | 10 | ||||
-rw-r--r-- | doc/classes/OS.xml | 6 | ||||
-rw-r--r-- | doc/classes/TextEdit.xml | 6 |
4 files changed, 13 insertions, 13 deletions
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]. </member> <member name="emission_sphere_radius" type="float" setter="set_emission_sphere_radius" getter="get_emission_sphere_radius"> - 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]. </member> <member name="emitting" type="bool" setter="set_emitting" getter="is_emitting"> 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. </constant> <constant name="EMISSION_SHAPE_SPHERE" value="1" enum="EmissionShape"> - 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. </constant> <constant name="EMISSION_SHAPE_RECTANGLE" value="2" enum="EmissionShape"> 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 @@ <argument index="0" name="idx" type="int"> </argument> <description> - 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]. </description> </method> <method name="get_item_custom_fg_color" qualifiers="const"> @@ -82,7 +82,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - 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]. </description> </method> <method name="get_item_icon" qualifiers="const"> @@ -117,7 +117,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns the metadata value of the specified index set by [member set_item_metadata]. + Returns the metadata value of the specified index. </description> </method> <method name="get_item_text" qualifiers="const"> @@ -416,7 +416,7 @@ Sets the default icon size in pixels. </member> <member name="icon_mode" type="int" setter="set_icon_mode" getter="get_icon_mode" enum="ItemList.IconMode"> - 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]. </member> <member name="icon_scale" type="float" setter="set_icon_scale" getter="get_icon_scale"> 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]. </member> <member name="select_mode" type="int" setter="set_select_mode" getter="get_select_mode" enum="ItemList.SelectMode"> - Allow single or multiple item selection. See the [code]SELECT_*[/code] constants. + Allow single or multiple item selection. See the [enum SelectMode] constants. </member> </members> <signals> 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 @@ <member name="low_processor_usage_mode" type="bool" setter="set_low_processor_usage_mode" getter="is_in_low_processor_usage_mode"> If [code]true[/code], the engine optimizes for low processor usage by only refreshing the screen if needed. Can improve battery consumption on mobile. </member> - <member name="min_window_size" type="Vector2" setter="set_min_window_size" getter="get_min_window_size"> - 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. - </member> <member name="max_window_size" type="Vector2" setter="set_max_window_size" getter="get_max_window_size"> 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. </member> + <member name="min_window_size" type="Vector2" setter="set_min_window_size" getter="get_min_window_size"> + 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. + </member> <member name="screen_orientation" type="int" setter="set_screen_orientation" getter="get_screen_orientation" enum="_OS.ScreenOrientation"> The current screen orientation. </member> 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 @@ <description> 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]. </description> </method> <method name="cut"> @@ -369,7 +369,7 @@ <return type="void"> </return> <description> - 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]. </description> </method> </methods> @@ -404,7 +404,7 @@ If [code]true[/code], the fold gutter is visible. This enables folding groups of indented lines. </member> <member name="hiding_enabled" type="bool" setter="set_hiding_enabled" getter="is_hiding_enabled"> - 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. </member> <member name="highlight_all_occurrences" type="bool" setter="set_highlight_all_occurrences" getter="is_highlight_all_occurrences_enabled"> If [code]true[/code], all occurrences of the selected text will be highlighted. |