diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2019-11-11 22:45:22 +0100 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2019-11-14 12:14:57 +0100 |
| commit | 5d76ced033cf1b2a1466a1b1b2a3a4f1102fab3f (patch) | |
| tree | be508feadc8113d9aa1024764aa91587068a8df0 /src/controls/qquickaction.cpp | |
| parent | 724c8d81b0ce39ffc32dfdcf1b134ac4befb0127 (diff) | |
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 <paul.wicking@qt.io>
Diffstat (limited to 'src/controls/qquickaction.cpp')
| -rw-r--r-- | src/controls/qquickaction.cpp | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/src/controls/qquickaction.cpp b/src/controls/qquickaction.cpp index 27fd33771..479bb7fbf 100644 --- a/src/controls/qquickaction.cpp +++ b/src/controls/qquickaction.cpp @@ -169,28 +169,30 @@ QT_BEGIN_NAMESPACE \endqml */ -/*! \qmlsignal Action::triggered(QObject *source) +/*! \qmlsignal Action::triggered(QtObject source) Emitted when either the menu item or its bound action have been activated. Includes - the object that triggered the event if relevant (e.g. a Button or MenuItem). + the object (\a source) that triggered the event if relevant (e.g. a Button or MenuItem). You shouldn't need to emit this signal, use \l trigger() instead. The corresponding handler is \c onTriggered. */ -/*! \qmlmethod void Action::trigger(QObject *source) +/*! \qmlmethod void Action::trigger(QtObject source) - Will emit the \l triggered signal if the action is enabled. You may provide a source - object if the Action would benefit from knowing the origin of the triggering (e.g. - for analytics). Will also emit the \l toggled signal if it is checkable. + Will emit the \l triggered signal on \a source if the action is enabled. You may provide + a source object if the Action would benefit from knowing the origin of the triggering + (e.g. for analytics). Will also emit the \l toggled signal if it is checkable. */ /*! \qmlsignal Action::toggled(checked) - Emitted whenever a action's \l checked property changes. + Emitted whenever an action's \a checked property changes. This usually happens at the same time as \l triggered. The corresponding handler is \c onToggled. + + \sa checked */ QQuickAction1::QQuickAction1(QObject *parent) |