Details
-
Suggestion
-
Resolution: Unresolved
-
P2: Important
-
None
-
None
-
None
Description
In https://codereview.qt-project.org/c/qt/qtdeclarative/+/446245 I'm trying to add a signal to a grouped property (QQuickDragAxis). It's documented using \qmlpropertygroup in 6 different places. So since there is not a separate page for QQuickDragAxis itself, I think I need to document the signal in the grouped property too, and that gives the opportunity to explain what the signal argument means in each case. So far, the text description is emitted into the docs, but the signal is omitted from the grouped property table:
/*!
\qmlpropertygroup QtQuick::DragHandler::xAxis
\qmlproperty real QtQuick::DragHandler::xAxis.minimum
\qmlproperty real QtQuick::DragHandler::xAxis.maximum
\qmlproperty bool QtQuick::DragHandler::xAxis.enabled
\qmlproperty real QtQuick::DragHandler::xAxis.activeValue
\qmlproperty real QtQuick::DragHandler::xAxis.persistentValue
\qmlsignal QtQuick::DragHandler::xAxis::valueDelta(real delta)
\c xAxis controls the constraints for horizontal dragging.
\c minimum is the minimum acceptable value of \l {Item::x}{x} to be
applied to the \l {PointerHandler::target} {target}.
\c maximum is the maximum acceptable value of \l {Item::x}{x} to be
applied to the \l {PointerHandler::target} {target}.
If \c enabled is true, horizontal dragging is allowed.
\c activeValue is the same as \l {QtQuick::DragHandler::activeTranslation}{activeTranslation.x}.
\c persistentValue is the same as \l {QtQuick::DragHandler::persistentTranslation}{persistentTranslation.x}.
The \c valueDelta signal is emitted when \c activeValue (and therefore
\c persistentValue) changes, to provide the increment by which it changed.
This is intended for incrementally adjusting one property via multiple handlers.
*/
