From 52e799b6d4dce34bce0b1a96cf9d35d18cb7b3ae Mon Sep 17 00:00:00 2001 From: PouleyKetchoupp Date: Sat, 2 Nov 2019 12:14:15 +0100 Subject: [PATCH] Code format for true/false/null to make documentation consistent --- doc/classes/AnimationNodeBlendSpace2D.xml | 2 +- doc/classes/Array.xml | 2 +- doc/classes/Control.xml | 2 +- doc/classes/EditorInspectorPlugin.xml | 4 ++-- doc/classes/Image.xml | 2 +- doc/classes/PopupMenu.xml | 2 +- doc/classes/SoftBody.xml | 2 +- doc/classes/TextEdit.xml | 6 +++--- 8 files changed, 11 insertions(+), 11 deletions(-) diff --git a/doc/classes/AnimationNodeBlendSpace2D.xml b/doc/classes/AnimationNodeBlendSpace2D.xml index c71a06d9319..d8ea7fea5b7 100644 --- a/doc/classes/AnimationNodeBlendSpace2D.xml +++ b/doc/classes/AnimationNodeBlendSpace2D.xml @@ -125,7 +125,7 @@ - If true, the blend space is triangulated automatically. The mesh updates every time you add or remove points with [method add_blend_point] and [method remove_blend_point]. + If [code]true[/code], the blend space is triangulated automatically. The mesh updates every time you add or remove points with [method add_blend_point] and [method remove_blend_point]. Controls the interpolation between animations. See [enum BlendMode] constants. diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index a1529f3eb3c..e09c1f4b080 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -316,7 +316,7 @@ - Duplicates the subset described in the function and returns it in an array, deeply copying the array if [code]deep[/code] is true. Lower and upper index are inclusive, with the [code]step[/code] describing the change between indices while slicing. + Duplicates the subset described in the function and returns it in an array, deeply copying the array if [code]deep[/code] is [code]true[/code]. Lower and upper index are inclusive, with the [code]step[/code] describing the change between indices while slicing. diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 05ffac803af..f5a8683a393 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -62,7 +62,7 @@ Virtual method to be implemented by the user. Returns a [Control] node that should be used as a tooltip instead of the default one. Use [code]for_text[/code] parameter to determine what text the tooltip should contain (likely the contents of [member hint_tooltip]). - The returned node must be of type [Control] or Control-derieved. It can have child nodes of any type. It is freed when the tooltip disappears, so make sure you always provide a new instance, not e.g. a node from scene. When null or non-Control node is returned, the default tooltip will be used instead. + The returned node must be of type [Control] or Control-derieved. It can have child nodes of any type. It is freed when the tooltip disappears, so make sure you always provide a new instance, not e.g. a node from scene. When [code]null[/code] or non-Control node is returned, the default tooltip will be used instead. [b]Note:[/b] The tooltip is shrunk to minimal size. If you want to ensure it's fully visible, you might want to set its [member rect_min_size] to some non-zero value. Example of usage with custom-constructed node: [codeblock] diff --git a/doc/classes/EditorInspectorPlugin.xml b/doc/classes/EditorInspectorPlugin.xml index cab5af3985b..a713e065853 100644 --- a/doc/classes/EditorInspectorPlugin.xml +++ b/doc/classes/EditorInspectorPlugin.xml @@ -6,7 +6,7 @@ This plugins allows adding custom property editors to [EditorInspector]. Plugins are registered via [method EditorPlugin.add_inspector_plugin]. - When an object is edited, the [method can_handle] function is called and must return true if the object type is supported. + When an object is edited, the [method can_handle] function is called and must return [code]true[/code] if the object type is supported. If supported, the function [method parse_begin] will be called, allowing to place custom controls at the beginning of the class. Subsequently, the [method parse_category] and [method parse_property] are called for every category and property. They offer the ability to add custom controls to the inspector too. Finally [method parse_end] will be called. @@ -54,7 +54,7 @@ - Returns true if this object can be handled by this plugin. + Returns [code]true[/code] if this object can be handled by this plugin. diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index d297bc98ae7..2f9503cc498 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -415,7 +415,7 @@ - Saves the image as an EXR file to [code]path[/code]. If grayscale is true and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return [constant ERR_UNAVAILABLE] if Godot was compiled without the TinyEXR module. + Saves the image as an EXR file to [code]path[/code]. If grayscale is [code]true[/code] and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return [constant ERR_UNAVAILABLE] if Godot was compiled without the TinyEXR module. diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 691aec2eb11..bdb6ca84ee2 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -444,7 +444,7 @@ - Sets the type of the item at the specified index [code]idx[/code] to radio button. If false, sets the type of the item to plain text. + Sets the type of the item at the specified index [code]idx[/code] to radio button. If [code]false[/code], sets the type of the item to plain text. diff --git a/doc/classes/SoftBody.xml b/doc/classes/SoftBody.xml index e4a5087db54..93f02c0e01f 100644 --- a/doc/classes/SoftBody.xml +++ b/doc/classes/SoftBody.xml @@ -78,7 +78,7 @@ - If true, the [SoftBody] will respond to [RayCast]s. + If [code]true[/code], the [SoftBody] will respond to [RayCast]s. diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 71a949a4af4..e8833411077 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -94,7 +94,7 @@ Moves the cursor at the specified [code]column[/code] index. - If [code]adjust_viewport[/code] is set to true, the viewport will center at the cursor position after the move occurs. + If [code]adjust_viewport[/code] is set to [code]true[/code], the viewport will center at the cursor position after the move occurs. @@ -110,8 +110,8 @@ 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. - If [code]can_be_hidden[/code] is set to true, the specified [code]line[/code] can be hidden using [method set_line_as_hidden]. + If [code]adjust_viewport[/code] is set to [code]true[/code], the viewport will center at the cursor position after the move occurs. + If [code]can_be_hidden[/code] is set to [code]true[/code], the specified [code]line[/code] can be hidden using [method set_line_as_hidden].