From 055fb93e562e54417a7da4b325b6c40d1424da9e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Tue, 25 Jan 2022 00:54:21 +0100 Subject: [PATCH] doc: Clarify expected type of `Object *` parameters in Tree methods They're meant to be `TreeItem *` but this can't be bound in Variant. Fixes #20538. (cherry picked from commit 81f2ce4e46ac2c542bb7527efddfa30e377234ef) --- doc/classes/Tree.xml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index b57d3ef045c..657e0f08c4d 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -38,7 +38,7 @@ - Creates an item in the tree and adds it as a child of [code]parent[/code]. + Creates an item in the tree and adds it as a child of [code]parent[/code], which can be either a valid [TreeItem] or [code]null[/code]. If [code]parent[/code] is [code]null[/code], the root item will be the parent, or the new item will be the root itself if the tree is empty. The new item will be the [code]idx[/code]th child of parent, or it will be the last child if there are not enough siblings. @@ -117,7 +117,7 @@ - Returns the rectangle area for the specified item. If [code]column[/code] is specified, only get the position and size of that column, otherwise get the rectangle containing all columns. + Returns the rectangle area for the specified [TreeItem]. If [code]column[/code] is specified, only get the position and size of that column, otherwise get the rectangle containing all columns. @@ -131,7 +131,7 @@ - Returns the next selected item after the given one, or [code]null[/code] if the end is reached. + Returns the next selected [TreeItem] after the given one, or [code]null[/code] if the end is reached. If [code]from[/code] is [code]null[/code], this returns the first selected item. @@ -173,7 +173,7 @@ - Causes the [Tree] to jump to the specified item. + Causes the [Tree] to jump to the specified [TreeItem].