diff options
authorMitch Curtis <mitch.curtis@qt.io>2020-08-06 11:33:18 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2020-08-20 10:40:39 +0000
commited1c6723f33f4730db064e04c05c952e881d41cf (patch)
parent1bdb56ff9571dfbf4b7bd52b9d8a45ca00f4ecac (diff)
Document that pop() does nothing if depth is less than or equal to 1
This note is already in the detailed description, but users looking at pop() can easily miss that. Task-number: QTBUG-85903 Change-Id: I92c71c8d98b2a83aefbc99229e5b16a6fb33b937 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io> (cherry picked from commit 70686007ce8c5f237e3319525682bbb85c99c49e) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
1 files changed, 3 insertions, 0 deletions
diff --git a/src/quicktemplates2/qquickstackview.cpp b/src/quicktemplates2/qquickstackview.cpp
index b281d79d..135107ea 100644
--- a/src/quicktemplates2/qquickstackview.cpp
+++ b/src/quicktemplates2/qquickstackview.cpp
@@ -634,6 +634,9 @@ void QQuickStackView::push(QQmlV4Function *args)
items down to (but not including) the first item is popped.
If not specified, only the current item is popped.
+ \note A pop() operation on a stack with depth 1 or 0 does nothing. In such
+ cases, the stack can be emptied using the \l clear() method.
\include qquickstackview.qdocinc pop-ownership
An \a operation can be optionally specified as the last argument. Supported