summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2020-03-03 14:50:27 +0100
committerTopi Reinio <topi.reinio@qt.io>2020-03-05 10:43:58 +0100
commit76b39dd90f613f340066cc5a4ceed65ff778bdd4 (patch)
tree8f34e3522dcbe200e17872943892c77a3bc2390f /src
parentfd520c2b9e3c57e4f63c60e6fe27af00b7b427c4 (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')
-rw-r--r--src/input/frontend/qmousedevice.cpp8
-rw-r--r--src/quick3d/imports/scene3d/scene3ditem.cpp2
-rw-r--r--src/quick3d/quick3d/items/quick3dnodev9.cpp2
-rw-r--r--src/render/materialsystem/qshaderimage.cpp22
4 files changed, 17 insertions, 17 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
*/
/*!
diff --git a/src/quick3d/imports/scene3d/scene3ditem.cpp b/src/quick3d/imports/scene3d/scene3ditem.cpp
index f824d2c4e..295217f98 100644
--- a/src/quick3d/imports/scene3d/scene3ditem.cpp
+++ b/src/quick3d/imports/scene3d/scene3ditem.cpp
@@ -303,8 +303,8 @@ void Scene3DItem::setHoverEnabled(bool enabled)
Additionally when using this mode, the window clearBeforeRendering
will be set to false automatically.
+ The default value is \c FBO.
\since 5.14
- \default FBO
*/
void Scene3DItem::setCompositingMode(Scene3DItem::CompositingMode mode)
{
diff --git a/src/quick3d/quick3d/items/quick3dnodev9.cpp b/src/quick3d/quick3d/items/quick3dnodev9.cpp
index 40edadbc4..5162c2f6d 100644
--- a/src/quick3d/quick3d/items/quick3dnodev9.cpp
+++ b/src/quick3d/quick3d/items/quick3dnodev9.cpp
@@ -52,7 +52,6 @@ Quick3DNodeV9::Quick3DNodeV9(QObject *parent)
/*!
\qmlproperty QJSValue Qt3DCore::Node::propertyTrackingOverrides
- \default {}
Assuming a Qt3DCore::Node needs to override the PropertyTrackingMode on two
properties (enabled and displacement), the value should be set as shown
@@ -65,6 +64,7 @@ Quick3DNodeV9::Quick3DNodeV9(QObject *parent)
}
\endcode
+ By default, there are no override values set.
\since 2.9
*/
diff --git a/src/render/materialsystem/qshaderimage.cpp b/src/render/materialsystem/qshaderimage.cpp
index 508cf44f2..7ab9e25e0 100644
--- a/src/render/materialsystem/qshaderimage.cpp
+++ b/src/render/materialsystem/qshaderimage.cpp
@@ -347,7 +347,7 @@ QShaderImagePrivate::~QShaderImagePrivate()
Holds which mipLevel out of the referenced texture should be used for the
ShaderImage.
- \default 0
+ The default value is 0.
*/
/*!
@@ -365,7 +365,7 @@ QShaderImagePrivate::~QShaderImagePrivate()
cubeMapFace = layer - (cubeMapLayer * 6)
\endcode
- Default value is 0.
+ The default value is 0.
*/
/*!
@@ -377,7 +377,7 @@ QShaderImagePrivate::~QShaderImagePrivate()
for all layers. If set to false, only the single layer specified by the \a
layer property will be bound.
- Default value is \c false.
+ The default value is \c false.
*/
/*!
@@ -394,7 +394,7 @@ QShaderImagePrivate::~QShaderImagePrivate()
\value ShaderImage.ReadWrite
Read-write access.
- Default value is ShaderImage.ReadWrite.
+ The default value is ShaderImage.ReadWrite.
*/
/*!
@@ -414,7 +414,7 @@ QShaderImagePrivate::~QShaderImagePrivate()
By default Qt3D will try to set the image format to match that of the
referenced texture.
- Default value is ShaderImage.Automatic.
+ The default value is ShaderImage.Automatic.
*/
/*!
@@ -695,8 +695,8 @@ QShaderImagePrivate::~QShaderImagePrivate()
Holds which mipLevel out of the referenced texture should be used for the
QShaderImage.
- \default 0
- */
+ The default value is 0.
+*/
/*!
\property Qt3DRender::QShaderImage::layer
@@ -713,7 +713,7 @@ QShaderImagePrivate::~QShaderImagePrivate()
cubeMapFace = layer - (cubeMapLayer * 6)
\endcode
- \default 0
+ The default value is 0.
*/
/*!
@@ -725,7 +725,7 @@ QShaderImagePrivate::~QShaderImagePrivate()
for all layers. If set to false, only the single layer specified by the \a
layer property will be bound.
- \default false
+ The default value is \c false.
*/
/*!
@@ -735,7 +735,7 @@ QShaderImagePrivate::~QShaderImagePrivate()
the image. If a shader tries to write or read from an image that has
incompatible access, the behavior is undefined.
- \default QShaderImage::ReadWrite
+ The default value is QShaderImage::ReadWrite.
*/
/*!
@@ -755,7 +755,7 @@ QShaderImagePrivate::~QShaderImagePrivate()
By default Qt3D will try to set the image format to match that of the
referenced texture.
- \default QShaderImage::Automatic
+ The default value is QShaderImage::Automatic.
*/
/*!