diff options
author | Topi Reinio <topi.reinio@qt.io> | 2020-03-03 14:50:27 +0100 |
---|---|---|
committer | Topi Reinio <topi.reinio@qt.io> | 2020-03-05 10:43:58 +0100 |
commit | 76b39dd90f613f340066cc5a4ceed65ff778bdd4 (patch) | |
tree | 8f34e3522dcbe200e17872943892c77a3bc2390f /src/input | |
parent | fd520c2b9e3c57e4f63c60e6fe27af00b7b427c4 (diff) |
Doc: Fix incorrect use of \default QDoc command
The command, despite its name, does not document a default value of
a property or a parameter. Instead, it's specific to QML properties,
marking a property as a default QML property.
Replace incorrect use of the command with descriptions of default
values.
Fixes: QTBUG-82645
Change-Id: I5b457062ffe2e8d81c358119e6bebc11b0063090
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/input')
-rw-r--r-- | src/input/frontend/qmousedevice.cpp | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/input/frontend/qmousedevice.cpp b/src/input/frontend/qmousedevice.cpp index d74ea0353..bc783fbfa 100644 --- a/src/input/frontend/qmousedevice.cpp +++ b/src/input/frontend/qmousedevice.cpp @@ -110,23 +110,23 @@ QMouseDevicePrivate::QMouseDevicePrivate() /*! \property Qt3DInput::QMouseDevice::updateAxesContinuously - If true, axes will be updated anytime they change regardless of whether + If \c true, axes will be updated anytime they change regardless of whether any mouse button is being pressed. Otherwise, axes are updated only when one of the mouse buttons is being pressed. + The default value is \c false. \since 5.15 - \default false */ /*! \qmlproperty bool MouseDevice::updateAxesContinuously - If true, axes will be updated anytime they change regardless of whether + If \c true, axes will be updated anytime they change regardless of whether any mouse button is being pressed. Otherwise, axes are updated only when one of the mouse buttons is being pressed. + The default value is \c false. \since 5.15 - \default false */ /*! |