From 2f5164d78c8c4e2f28de14741716b5d7e24f3b71 Mon Sep 17 00:00:00 2001
From: James Westman <james@flyingpimonster.net>
Date: Thu, 28 Jan 2021 22:34:29 -0600
Subject: docs: Add TreeItem method descriptions

---
 doc/classes/TreeItem.xml | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

(limited to 'doc/classes/TreeItem.xml')

diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml
index e97c1e580c..fd157e5eb9 100644
--- a/doc/classes/TreeItem.xml
+++ b/doc/classes/TreeItem.xml
@@ -208,6 +208,7 @@
 			<argument index="0" name="column" type="int">
 			</argument>
 			<description>
+				Returns the metadata value that was set for the given column using [method set_metadata].
 			</description>
 		</method>
 		<method name="get_next">
@@ -268,6 +269,7 @@
 			<argument index="0" name="column" type="int">
 			</argument>
 			<description>
+				Returns the value of a [constant CELL_MODE_RANGE] column.
 			</description>
 		</method>
 		<method name="get_range_config">
@@ -276,6 +278,7 @@
 			<argument index="0" name="column" type="int">
 			</argument>
 			<description>
+				Returns a dictionary containing the range parameters for a given column. The keys are "min", "max", "step", and "expr".
 			</description>
 		</method>
 		<method name="get_structured_text_bidi_override" qualifiers="const">
@@ -300,6 +303,7 @@
 			<argument index="0" name="column" type="int">
 			</argument>
 			<description>
+				Gets the suffix string shown after the column value.
 			</description>
 		</method>
 		<method name="get_text" qualifiers="const">
@@ -606,6 +610,7 @@
 			<argument index="1" name="meta" type="Variant">
 			</argument>
 			<description>
+				Sets the metadata value for the given column, which can be retrieved later using [method get_metadata]. This can be used, for example, to store a reference to the original data.
 			</description>
 		</method>
 		<method name="set_opentype_feature">
@@ -629,6 +634,7 @@
 			<argument index="1" name="value" type="float">
 			</argument>
 			<description>
+				Sets the value of a [constant CELL_MODE_RANGE] column.
 			</description>
 		</method>
 		<method name="set_range_config">
@@ -645,6 +651,8 @@
 			<argument index="4" name="expr" type="bool" default="false">
 			</argument>
 			<description>
+				Sets the range of accepted values for a column. The column must be in the [constant CELL_MODE_RANGE] mode.
+				If [code]expr[/code] is [code]true[/code], the edit mode slider will use an exponential scale as with [member Range.exp_edit].
 			</description>
 		</method>
 		<method name="set_selectable">
@@ -686,6 +694,7 @@
 			<argument index="1" name="text" type="String">
 			</argument>
 			<description>
+				Sets a string to be shown after a column's value (for example, a unit abbreviation).
 			</description>
 		</method>
 		<method name="set_text">
@@ -696,6 +705,7 @@
 			<argument index="1" name="text" type="String">
 			</argument>
 			<description>
+				Sets the given column's text value.
 			</description>
 		</method>
 		<method name="set_text_align">
@@ -748,7 +758,7 @@
 			Cell contains a string.
 		</constant>
 		<constant name="CELL_MODE_CHECK" value="1" enum="TreeCellMode">
-			Cell can be checked.
+			Cell contains a checkbox.
 		</constant>
 		<constant name="CELL_MODE_RANGE" value="2" enum="TreeCellMode">
 			Cell contains a range.
-- 
cgit v1.2.3