diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-07-31 13:04:13 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-07-31 13:04:13 +0200 |
| commit | 932a719f6e80493345ca2374c93d8c50f53b3a9e (patch) | |
| tree | 10fa6b8ddfcf741fdbbb03705ebb3ba9f80ac807 /doc/classes | |
| parent | 1cee89467b355b8b5b8e42d71ff5a6983b100d07 (diff) | |
| parent | 0ff1ca4655863056240dc1e186bbeebf3d10b218 (diff) | |
Merge pull request #40540 from TheDuriel/patch-2
Clarify TreeItem return values
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/TreeItem.xml | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index 126d6b4180..22e643a51d 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -118,7 +118,7 @@ <return type="TreeItem"> </return> <description> - Returns the TreeItem's child items. + Returns the TreeItem's first child item or a null object if there is none. </description> </method> <method name="get_custom_bg_color" qualifiers="const"> @@ -196,7 +196,7 @@ <return type="TreeItem"> </return> <description> - Returns the next TreeItem in the tree. + Returns the next TreeItem in the tree or a null object if there is none. </description> </method> <method name="get_next_visible"> @@ -205,7 +205,7 @@ <argument index="0" name="wrap" type="bool" default="false"> </argument> <description> - Returns the next visible TreeItem in the tree. + Returns the next visible 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> @@ -213,14 +213,14 @@ <return type="TreeItem"> </return> <description> - Returns the parent TreeItem. + Returns the parent TreeItem or a null object if there is none. </description> </method> <method name="get_prev"> <return type="TreeItem"> </return> <description> - Returns the previous TreeItem in the tree. + Returns the previous TreeItem in the tree or a null object if there is none. </description> </method> <method name="get_prev_visible"> @@ -229,7 +229,7 @@ <argument index="0" name="wrap" type="bool" default="false"> </argument> <description> - Returns the previous visible TreeItem in the tree. + Returns the previous visible 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> |