From c09b9c488fcc423d58ed26447b6e2614b106afdb Mon Sep 17 00:00:00 2001
From: Tomasz Chabora <kobewi4e@gmail.com>
Date: Mon, 13 Jan 2020 23:08:42 +0100
Subject: Complete documentation of some more classes

---
 doc/classes/BaseButton.xml        | 1 +
 doc/classes/CollisionObject2D.xml | 2 ++
 doc/classes/ColorPickerButton.xml | 2 ++
 doc/classes/MainLoop.xml          | 1 +
 doc/classes/NinePatchRect.xml     | 2 ++
 doc/classes/PoolByteArray.xml     | 5 +++++
 doc/classes/ShaderMaterial.xml    | 2 ++
 doc/classes/SpriteFrames.xml      | 1 +
 doc/classes/StyleBox.xml          | 8 +++++++-
 doc/classes/Thread.xml            | 3 +++
 10 files changed, 26 insertions(+), 1 deletion(-)

(limited to 'doc/classes')

diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml
index 21f46efe84..0128e7b220 100644
--- a/doc/classes/BaseButton.xml
+++ b/doc/classes/BaseButton.xml
@@ -112,6 +112,7 @@
 			The state of buttons are disabled.
 		</constant>
 		<constant name="DRAW_HOVER_PRESSED" value="4" enum="DrawMode">
+			The state of buttons are both hovered and pressed.
 		</constant>
 		<constant name="ACTION_MODE_BUTTON_PRESS" value="0" enum="ActionMode">
 			Require just a press to consider the button clicked.
diff --git a/doc/classes/CollisionObject2D.xml b/doc/classes/CollisionObject2D.xml
index b9ec9480cf..bbc2e44dc0 100644
--- a/doc/classes/CollisionObject2D.xml
+++ b/doc/classes/CollisionObject2D.xml
@@ -44,6 +44,7 @@
 			<argument index="0" name="owner_id" type="int">
 			</argument>
 			<description>
+				Returns the [code]one_way_collision_margin[/code] of the shape owner identified by given [code]owner_id[/code].
 			</description>
 		</method>
 		<method name="get_shape_owners">
@@ -199,6 +200,7 @@
 			<argument index="1" name="margin" type="float">
 			</argument>
 			<description>
+				Sets the [code]one_way_collision_margin[/code] of the shape owner identified by given [code]owner_id[/code] to [code]margin[/code] pixels.
 			</description>
 		</method>
 		<method name="shape_owner_set_transform">
diff --git a/doc/classes/ColorPickerButton.xml b/doc/classes/ColorPickerButton.xml
index e8c78fb6bf..37116b096a 100644
--- a/doc/classes/ColorPickerButton.xml
+++ b/doc/classes/ColorPickerButton.xml
@@ -43,10 +43,12 @@
 		</signal>
 		<signal name="picker_created">
 			<description>
+				Emitted when the [ColorPicker] is created (the button is pressed for the first time).
 			</description>
 		</signal>
 		<signal name="popup_closed">
 			<description>
+				Emitted when the [ColorPicker] is closed.
 			</description>
 		</signal>
 	</signals>
diff --git a/doc/classes/MainLoop.xml b/doc/classes/MainLoop.xml
index d5ca39e09a..606c898a35 100644
--- a/doc/classes/MainLoop.xml
+++ b/doc/classes/MainLoop.xml
@@ -69,6 +69,7 @@
 			<argument index="1" name="meta" type="Variant">
 			</argument>
 			<description>
+				Called when the user performs an action in the system global menu (e.g. the Mac OS menu bar).
 			</description>
 		</method>
 		<method name="_idle" qualifiers="virtual">
diff --git a/doc/classes/NinePatchRect.xml b/doc/classes/NinePatchRect.xml
index 8935ac9d94..7a7973684d 100644
--- a/doc/classes/NinePatchRect.xml
+++ b/doc/classes/NinePatchRect.xml
@@ -15,6 +15,7 @@
 			<argument index="0" name="margin" type="int" enum="Margin">
 			</argument>
 			<description>
+				Returns the size of the margin identified by the given [enum Margin] constant.
 			</description>
 		</method>
 		<method name="set_patch_margin">
@@ -25,6 +26,7 @@
 			<argument index="1" name="value" type="int">
 			</argument>
 			<description>
+				Sets the size of the margin identified by the given [enum Margin] constant to [code]value[/code] in pixels.
 			</description>
 		</method>
 	</methods>
diff --git a/doc/classes/PoolByteArray.xml b/doc/classes/PoolByteArray.xml
index 867f042cd2..83c348f6be 100644
--- a/doc/classes/PoolByteArray.xml
+++ b/doc/classes/PoolByteArray.xml
@@ -78,6 +78,11 @@
 			<return type="String">
 			</return>
 			<description>
+				Returns a hexadecimal representation of this array as a [String].
+				[codeblock]
+				var array = PoolByteArray([11, 46, 255])
+				print(array.hex_encode()) # Prints: 0b2eff
+				[/codeblock]
 			</description>
 		</method>
 		<method name="insert">
diff --git a/doc/classes/ShaderMaterial.xml b/doc/classes/ShaderMaterial.xml
index ef355c4417..0f39b703ca 100644
--- a/doc/classes/ShaderMaterial.xml
+++ b/doc/classes/ShaderMaterial.xml
@@ -25,6 +25,7 @@
 			<argument index="0" name="name" type="String">
 			</argument>
 			<description>
+				Returns [code]true[/code] if the property identified by [code]name[/code] can be reverted to a default value.
 			</description>
 		</method>
 		<method name="property_get_revert">
@@ -33,6 +34,7 @@
 			<argument index="0" name="name" type="String">
 			</argument>
 			<description>
+				Returns the default value of the material property with given [code]name[/code].
 			</description>
 		</method>
 		<method name="set_shader_param">
diff --git a/doc/classes/SpriteFrames.xml b/doc/classes/SpriteFrames.xml
index f28192519e..2f2075074c 100644
--- a/doc/classes/SpriteFrames.xml
+++ b/doc/classes/SpriteFrames.xml
@@ -170,6 +170,7 @@
 	</methods>
 	<members>
 		<member name="frames" type="Array" setter="_set_frames" getter="_get_frames">
+			Compatibility property, always equals to an empty array.
 		</member>
 	</members>
 	<constants>
diff --git a/doc/classes/StyleBox.xml b/doc/classes/StyleBox.xml
index 1d873ef0b1..1a11904792 100644
--- a/doc/classes/StyleBox.xml
+++ b/doc/classes/StyleBox.xml
@@ -17,18 +17,22 @@
 			<argument index="1" name="rect" type="Rect2">
 			</argument>
 			<description>
+				Draws this stylebox using a [CanvasItem] with given [RID].
+				You can get a [RID] value using [method Object.get_instance_id] on a [CanvasItem]-derived node.
 			</description>
 		</method>
 		<method name="get_center_size" qualifiers="const">
 			<return type="Vector2">
 			</return>
 			<description>
+				Returns the size of this [StyleBox] without the margins.
 			</description>
 		</method>
 		<method name="get_current_item_drawn" qualifiers="const">
 			<return type="CanvasItem">
 			</return>
 			<description>
+				Returns the [CanvasItem] that handles its [constant CanvasItem.NOTIFICATION_DRAW] or [method CanvasItem._draw] callback at this moment.
 			</description>
 		</method>
 		<method name="get_default_margin" qualifiers="const">
@@ -37,6 +41,7 @@
 			<argument index="0" name="margin" type="int" enum="Margin">
 			</argument>
 			<description>
+				Returns the default value of the specified [enum Margin].
 			</description>
 		</method>
 		<method name="get_margin" qualifiers="const">
@@ -45,7 +50,7 @@
 			<argument index="0" name="margin" type="int" enum="Margin">
 			</argument>
 			<description>
-				Returns the content margin offset for the specified margin.
+				Returns the content margin offset for the specified [enum Margin].
 				Positive values reduce size inwards, unlike [Control]'s margin values.
 			</description>
 		</method>
@@ -71,6 +76,7 @@
 			<argument index="1" name="offset" type="float">
 			</argument>
 			<description>
+				Sets the default value of the specified [enum Margin] to given [code]offset[/code] in pixels.
 			</description>
 		</method>
 		<method name="test_mask" qualifiers="const">
diff --git a/doc/classes/Thread.xml b/doc/classes/Thread.xml
index 25e40d4c1f..e56ea2325e 100644
--- a/doc/classes/Thread.xml
+++ b/doc/classes/Thread.xml
@@ -50,10 +50,13 @@
 	</methods>
 	<constants>
 		<constant name="PRIORITY_LOW" value="0" enum="Priority">
+			A thread running with lower priority than normally.
 		</constant>
 		<constant name="PRIORITY_NORMAL" value="1" enum="Priority">
+			A thread with a standard priority.
 		</constant>
 		<constant name="PRIORITY_HIGH" value="2" enum="Priority">
+			A thread running with higher priority than normally.
 		</constant>
 	</constants>
 </class>
-- 
cgit v1.2.3