From 5d76ced033cf1b2a1466a1b1b2a3a4f1102fab3f Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Mon, 11 Nov 2019 22:45:22 +0100 Subject: Doc: Fix documentation warnings All warnings in qtquickcontrols were related to \qmlmethod or \qmlsignal parameters, except for the missing dependency to qtcore in Qt Quick Extras. There's some inconsistencies with how QDoc parses QML method parameters, especially for qml signals - in some cases the \a command is replaced with \e to clear the warning, even though the parameter name referenced with \a does exist. This commit brings the current warning count to zero. Fixes: QTBUG-79828 Change-Id: I3d3d02583498c5a579f6476273e10e75680d940c Reviewed-by: Paul Wicking --- src/controls/StackView.qml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'src/controls/StackView.qml') diff --git a/src/controls/StackView.qml b/src/controls/StackView.qml index aa3596f3..290d24c2 100644 --- a/src/controls/StackView.qml +++ b/src/controls/StackView.qml @@ -515,24 +515,24 @@ FocusScope { property StackViewDelegate delegate: StackViewSlideDelegate {} /*! \qmlmethod Item StackView::push(Item item) - Pushes an item onto the stack. + Pushes an \a item onto the stack. The function can also take a property list as argument - \c {Item StackView::push(jsobject dict)}, which should contain one or more of the following properties: \list - \li \c item: this property is required, and holds the item you want to push. - \li \c properties: a list of QML properties that should be assigned + \li \a item: this property is required, and holds the item you want to push. + \li \e properties: a list of QML properties that should be assigned to the item upon push. These properties will be copied into the item when it is loaded (in case of a component or URL), or when it becomes the current item for the first time (normally upon push). - \li \c immediate: set this property to \c true to skip transition effects. When pushing + \li \e immediate: set this property to \c true to skip transition effects. When pushing an array, you only need to set this property on the first element to make the whole operation immediate. - \li \c replace: set this property to replace the current item on the stack. When pushing + \li \e replace: set this property to replace the current item on the stack. When pushing an array, you only need to set this property on the first element to replace as many elements on the stack as inside the array. - \li \c destroyOnPop: set this property to specify if the item needs to be destroyed - when its popped off the stack. By default (if \a destroyOnPop is not specified), + \li \e destroyOnPop: set this property to specify if the item needs to be destroyed + when its popped off the stack. By default (if \e destroyOnPop is not specified), StackView will destroy items pushed as components or URLs. Items not destroyed will be re-parented to the original parents they had before being pushed onto the stack, and hidden. If you need to set this property, do it with @@ -700,7 +700,7 @@ FocusScope { } /*! \qmlmethod Item StackView::find(function, bool onlySearchLoadedItems = false) - Search for a specific item inside the stack. \a func will + Search for a specific item inside the stack. \a function will be called for each item in the stack (with the item as argument) until the function returns true. Return value will be the item found. For example: -- cgit v1.2.1