document what happens to the page after pop()

Change-Id: I85b6cca525ced119329e1c28807efb6befcb4af3
2015-02-04 13:23:02 +01:00 · 2015-02-04 13:23:02 +01:00 · b484b7faf0
commit b484b7faf0
parent 03bae89ac5
1 changed files with 3 additions and 0 deletions
--- a/src/declarativeimports/plasmacomponents/qml/PageStack.qml
+++ b/src/declarativeimports/plasmacomponents/qml/PageStack.qml
@ -130,6 +130,9 @@ Item {

    /**
     * Pops a page off the stack.
+     * If the page used to have another parent before being pushed, it will be reparented
+     * to this old parent. If the page was created from a component at push time,
+     * it will be deleted.
     *
     * @param type:Page page if page is specified then the stack is unwound to that
     * page, to unwind to the first page specify page as null.