diff options
| author | Derwent Ready (drentsoft) <1520613+drentsoft@users.noreply.github.com> | 2020-10-11 00:14:17 +0100 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2022-07-08 08:49:56 +0200 |
| commit | df5a9228808497f19b5bddf7b58d2a532cd990d0 (patch) | |
| tree | 7e78bdb8130443346b53f067104a10c97082b4e0 | |
| parent | 2b6dadd46b9a2bb68c6814989360e02f064a47b1 (diff) | |
Clarified usage of TreeItem get_next*() and get_prev*() functions.
| -rw-r--r-- | doc/classes/TreeItem.xml | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index 804b8dddd9..fbba1147a2 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -223,14 +223,14 @@ <method name="get_next" qualifiers="const"> <return type="TreeItem" /> <description> - Returns the next TreeItem in the tree or a null object if there is none. + Returns the next sibling TreeItem in the tree or a null object if there is none. </description> </method> <method name="get_next_visible"> <return type="TreeItem" /> <argument index="0" name="wrap" type="bool" default="false" /> <description> - Returns the next visible TreeItem in the tree or a null object if there is none. + Returns the next visible sibling TreeItem in the tree or a null object if there is none. If [code]wrap[/code] is enabled, the method will wrap around to the first visible element in the tree when called on the last visible element, otherwise it returns [code]null[/code]. </description> </method> @@ -243,14 +243,14 @@ <method name="get_prev"> <return type="TreeItem" /> <description> - Returns the previous TreeItem in the tree or a null object if there is none. + Returns the previous sibling TreeItem in the tree or a null object if there is none. </description> </method> <method name="get_prev_visible"> <return type="TreeItem" /> <argument index="0" name="wrap" type="bool" default="false" /> <description> - Returns the previous visible TreeItem in the tree or a null object if there is none. + Returns the previous visible sibling TreeItem in the tree or a null object if there is none. If [code]wrap[/code] is enabled, the method will wrap around to the last visible element in the tree when called on the first visible element, otherwise it returns [code]null[/code]. </description> </method> |