summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2023-06-06 12:39:42 +0000
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2023-06-06 17:17:06 +0000
commitc732240d6d3f98d6ca7a73f42044f55c60c6a1aa (patch)
tree7180e2a56248e76d05249bc46b9180ecd6010777 /src
parentb4b8d29cf68754c72998192a212b76584646b148 (diff)
Doc: Fix incorrect module/type names in \qmlproperty commands
Multiple \qmlproperty commands used a non-existent module identifier, or the name of the C++ module in place of the QML one. Also, in some instances, the C++ type name was used in \qmlproperty signature. Fixing these also makes a number of QML properties appear in the generated docs. Change-Id: I452361d3b0397d3ce405a2fb28577c37a24f02e3 Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io> (cherry picked from commit fdd85c5f3c4b1102e8a2ceea42782bae0b0e5076) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'src')
-rw-r--r--src/animation/frontend/qabstractclipanimator.cpp10
-rw-r--r--src/extras/3dtext/qextrudedtextmesh.cpp6
-rw-r--r--src/quick3d/quick3d/items/quick3dentityloader.cpp4
-rw-r--r--src/quick3d/quick3d/items/quick3djoint.cpp2
-rw-r--r--src/quick3d/quick3d/items/quick3dnode.cpp4
-rw-r--r--src/quick3d/quick3dscene2d/items/qscene2d.cpp10
-rw-r--r--src/render/framegraph/qlayerfilter.cpp2
-rw-r--r--src/render/frontend/qcamera.cpp4
-rw-r--r--src/render/texture/qabstracttexture.cpp30
-rw-r--r--src/render/texture/qtextureimage.cpp2
10 files changed, 37 insertions, 37 deletions
diff --git a/src/animation/frontend/qabstractclipanimator.cpp b/src/animation/frontend/qabstractclipanimator.cpp
index a095cba24..9007af9af 100644
--- a/src/animation/frontend/qabstractclipanimator.cpp
+++ b/src/animation/frontend/qabstractclipanimator.cpp
@@ -90,7 +90,7 @@ QAbstractClipAnimator::~QAbstractClipAnimator()
{
}
/*!
- \qmlproperty bool Qt3DAnimation::AbstractClipAnimator::running
+ \qmlproperty bool Qt3D.Animation::AbstractClipAnimator::running
This property holds a boolean indicating whether the animation is currently running.
*/
@@ -111,7 +111,7 @@ bool QAbstractClipAnimator::isRunning() const
}
/*!
- \qmlproperty ChannelMapper Qt3DAnimation::AbstractClipAnimator::channelMapper
+ \qmlproperty ChannelMapper Qt3D.Animation::AbstractClipAnimator::channelMapper
This property holds the ChannelMapper that controls how the channels in
the animation clip map onto the properties of the target objects.
@@ -131,7 +131,7 @@ QChannelMapper *QAbstractClipAnimator::channelMapper() const
}
/*!
- \qmlproperty int Qt3DAnimation::AbstractClipAnimator::loops
+ \qmlproperty int Qt3D.Animation::AbstractClipAnimator::loops
This property holds the number of times the animation should play.
@@ -175,7 +175,7 @@ int QAbstractClipAnimator::loopCount() const
return d->m_loops;
}
/*!
- \qmlproperty Clock Qt3DAnimation::AbstractClipAnimator::clock
+ \qmlproperty Clock Qt3D.Animation::AbstractClipAnimator::clock
The clock controls the speed with which an animation is played.
*/
@@ -191,7 +191,7 @@ QClock *QAbstractClipAnimator::clock() const
return d->m_clock;
}
/*!
- \qmlproperty real Qt3DAnimation::AbstractClipAnimator::normalizedTime
+ \qmlproperty real Qt3D.Animation::AbstractClipAnimator::normalizedTime
This property holds the clips normalized time.
*/
diff --git a/src/extras/3dtext/qextrudedtextmesh.cpp b/src/extras/3dtext/qextrudedtextmesh.cpp
index e6e80a787..b7ba4b560 100644
--- a/src/extras/3dtext/qextrudedtextmesh.cpp
+++ b/src/extras/3dtext/qextrudedtextmesh.cpp
@@ -18,13 +18,13 @@ namespace Qt3DExtras {
*/
/*!
- * \qmlproperty QString Qt3DExtras::ExtrudedTextMesh::text
+ * \qmlproperty QString Qt3D.Extras::ExtrudedTextMesh::text
*
* Holds the text used for the mesh.
*/
/*!
- * \qmlproperty QFont Qt3DExtras::ExtrudedTextMesh::font
+ * \qmlproperty QFont Qt3D.Extras::ExtrudedTextMesh::font
*
* Holds the font of the text.
@@ -34,7 +34,7 @@ namespace Qt3DExtras {
*/
/*!
- * \qmlproperty float Qt3DExtras::ExtrudedTextMesh::depth
+ * \qmlproperty float Qt3D.Extras::ExtrudedTextMesh::depth
*
* Holds the extrusion depth of the text.
*/
diff --git a/src/quick3d/quick3d/items/quick3dentityloader.cpp b/src/quick3d/quick3d/items/quick3dentityloader.cpp
index 86e307065..ca25df63c 100644
--- a/src/quick3d/quick3d/items/quick3dentityloader.cpp
+++ b/src/quick3d/quick3d/items/quick3dentityloader.cpp
@@ -134,7 +134,7 @@ QObject *Quick3DEntityLoader::entity() const
}
/*!
- \qmlproperty url Qt3DCore::EntityLoader::source
+ \qmlproperty url Qt3D.Core::EntityLoader::source
Holds the source url.
*/
QUrl Quick3DEntityLoader::source() const
@@ -175,7 +175,7 @@ void Quick3DEntityLoader::setSourceComponent(QQmlComponent *component)
}
/*!
- \qmlproperty Status Qt3DCore::EntityLoader::status
+ \qmlproperty Status Qt3D.Core::EntityLoader::status
Holds the status of the entity loader.
\list
diff --git a/src/quick3d/quick3d/items/quick3djoint.cpp b/src/quick3d/quick3d/items/quick3djoint.cpp
index ac277ee35..cfe77b0a7 100644
--- a/src/quick3d/quick3d/items/quick3djoint.cpp
+++ b/src/quick3d/quick3d/items/quick3djoint.cpp
@@ -15,7 +15,7 @@ Quick3DJoint::Quick3DJoint(QObject *parent)
}
/*!
- \qmlproperty list<Joint> Qt3DCore::Joint::childJoints
+ \qmlproperty list<Joint> Qt3D.Core::Joint::childJoints
\readonly
*/
QQmlListProperty<QJoint> Quick3DJoint::childJoints()
diff --git a/src/quick3d/quick3d/items/quick3dnode.cpp b/src/quick3d/quick3d/items/quick3dnode.cpp
index 917819e26..09abcf2ae 100644
--- a/src/quick3d/quick3d/items/quick3dnode.cpp
+++ b/src/quick3d/quick3d/items/quick3dnode.cpp
@@ -25,7 +25,7 @@ Quick3DNode::Quick3DNode(QObject *parent)
}
/*!
- \qmlproperty list<QtQml::QtObject> Qt3DCore::Node::data
+ \qmlproperty list<QtQml::QtObject> Qt3D.Core::Node::data
\qmldefault
*/
@@ -58,7 +58,7 @@ QQmlListProperty<QObject> Quick3DNode::data()
}
/*!
- \qmlproperty list<Node> Qt3DCore::Node::childNodes
+ \qmlproperty list<Node> Qt3D.Core::Node::childNodes
\readonly
*/
diff --git a/src/quick3d/quick3dscene2d/items/qscene2d.cpp b/src/quick3d/quick3dscene2d/items/qscene2d.cpp
index 859ec666f..2271bdda3 100644
--- a/src/quick3d/quick3dscene2d/items/qscene2d.cpp
+++ b/src/quick3d/quick3dscene2d/items/qscene2d.cpp
@@ -117,12 +117,12 @@ namespace Quick {
*/
/*!
- \qmlproperty RenderTargetOutput Qt3D.Render::Scene2D::output
+ \qmlproperty RenderTargetOutput QtQuick.Scene2D::Scene2D::output
Holds the RenderTargetOutput, which specifies where the Scene2D is rendering to.
*/
/*!
- \qmlproperty enumeration Qt3D.Render::Scene2D::renderPolicy
+ \qmlproperty enumeration QtQuick.Scene2D::Scene2D::renderPolicy
Holds the render policy of this Scene2D.
\list
@@ -132,12 +132,12 @@ namespace Quick {
\endlist
*/
/*!
- \qmlproperty Item Qt3D.Render::Scene2D::item
+ \qmlproperty Item QtQuick.Scene2D::Scene2D::item
Holds the Item, which is rendered by Scene2D to the texture.
*/
/*!
- \qmlproperty bool Qt3D.Render::Scene2D::mouseEnabled
+ \qmlproperty bool QtQuick.Scene2D::Scene2D::mouseEnabled
Holds whether mouse events are enabled for the rendered item. The mouse events are
generated from object picking events of the entities added to the Scene2D.
Mouse is enabled by default.
@@ -146,7 +146,7 @@ namespace Quick {
happening in the backend.
*/
/*!
- \qmlproperty list<Entity> Qt3D.Render::Scene2D::entities
+ \qmlproperty list<Entity> QtQuick.Scene2D::Scene2D::entities
Holds the list of entities which are associated with the Scene2D object. If the
entities have ObjectPicker, the pick events from that entity are sent to Scene2D
and converted to mouse events.
diff --git a/src/render/framegraph/qlayerfilter.cpp b/src/render/framegraph/qlayerfilter.cpp
index 5a4c4795a..50afbcf9a 100644
--- a/src/render/framegraph/qlayerfilter.cpp
+++ b/src/render/framegraph/qlayerfilter.cpp
@@ -104,7 +104,7 @@ QLayerFilterPrivate::QLayerFilterPrivate()
*/
/*!
- \qmlproperty enumeration Qt3DRender::LayerFilter::filterMode
+ \qmlproperty enumeration Qt3D.Render::LayerFilter::filterMode
Holds the filter mode specifying the entities to select for drawing.
diff --git a/src/render/frontend/qcamera.cpp b/src/render/frontend/qcamera.cpp
index f9757f61f..43f887ed1 100644
--- a/src/render/frontend/qcamera.cpp
+++ b/src/render/frontend/qcamera.cpp
@@ -245,13 +245,13 @@ void QCameraPrivate::updateViewMatrixAndTransform(bool doEmit)
*/
/*!
- * \qmlproperty Qt3DRender::QCameraLens QCamera::lens
+ * \qmlproperty CameraLens Qt3D.Render::Camera::lens
* Holds the CameraLens component of the camera.
* \since 5.14
*/
/*!
- * \qmlproperty Qt3DCore::QTransform QCamera::transform
+ * \qmlproperty Transform Qt3D.Render::Camera::transform
* Holds the Transform component of the camera.
* \since 5.14
*/
diff --git a/src/render/texture/qabstracttexture.cpp b/src/render/texture/qabstracttexture.cpp
index 352bc4b5a..4d3d20828 100644
--- a/src/render/texture/qabstracttexture.cpp
+++ b/src/render/texture/qabstracttexture.cpp
@@ -392,7 +392,7 @@ void QAbstractTexture::setSize(int w, int h, int d)
Holds the width of the texture provider.
*/
/*!
- \qmlproperty int Qt3DRender::QAbstractTexture::width
+ \qmlproperty int Qt3D.Render::AbstractTexture::width
Holds the width of the texture provider.
*/
@@ -415,7 +415,7 @@ void QAbstractTexture::setWidth(int width)
Holds the height of the texture provider.
*/
/*!
- \qmlproperty int Qt3DRender::QAbstractTexture::height
+ \qmlproperty int Qt3D.Render::AbstractTexture::height
Holds the height of the texture provider.
*/
@@ -437,7 +437,7 @@ void QAbstractTexture::setHeight(int height)
Holds the depth of the texture provider.
*/
/*!
- \qmlproperty int Qt3DRender::QAbstractTexture::depth
+ \qmlproperty int Qt3D.Render::AbstractTexture::depth
Holds the depth of the texture provider.
*/
@@ -490,7 +490,7 @@ int QAbstractTexture::depth() const
array target formats.
*/
/*!
- \qmlproperty int Qt3DRender::QAbstractTexture::layers
+ \qmlproperty int Qt3D.Render::AbstractTexture::layers
Holds the maximum layer count of the texture provider. By default, the
maximum layer count is 1.
@@ -532,7 +532,7 @@ int QAbstractTexture::layers() const
formats.
*/
/*!
- \qmlproperty int Qt3DRender::QAbstractTexture::samples
+ \qmlproperty int Qt3D.Render::AbstractTexture::samples
Holds the number of samples per texel for the texture provider.
By default, the number of samples is 1.
@@ -590,7 +590,7 @@ int QAbstractTexture::mipLevels() const
Holds the format of the texture provider.
*/
/*!
- \qmlproperty TextureFormat Qt3DRender::QAbstractTexture::format
+ \qmlproperty TextureFormat Qt3D.Render::AbstractTexture::format
Holds the format of the texture provider.
*/
@@ -621,7 +621,7 @@ QAbstractTexture::TextureFormat QAbstractTexture::format() const
Holds the current status of the texture provider.
*/
/*!
- \qmlproperty Status Qt3DRender::QAbstractTexture::status readonly
+ \qmlproperty Status Qt3D.Render::AbstractTexture::status readonly
Holds the current status of the texture provider.
*/
@@ -695,7 +695,7 @@ QAbstractTexture::Status QAbstractTexture::status() const
\note The target format can only be set once.
*/
/*!
- \qmlproperty Target Qt3DRender::QAbstractTexture::target readonly
+ \qmlproperty Target Qt3D.Render::AbstractTexture::target readonly
Holds the target format of the texture provider.
@@ -796,7 +796,7 @@ QList<QAbstractTextureImage *> QAbstractTexture::textureImages() const
Holds whether the texture provider should auto generate mipmaps.
*/
/*!
- \qmlproperty bool Qt3DRender::QAbstractTexture::generateMipMaps
+ \qmlproperty bool Qt3D.Render::AbstractTexture::generateMipMaps
Holds whether the texture provider should auto generate mipmaps.
*/
@@ -825,7 +825,7 @@ bool QAbstractTexture::generateMipMaps() const
Holds the minification filter of the texture provider.
*/
/*!
- \qmlproperty Filter Qt3DRender::QAbstractTexture::minificationFilter
+ \qmlproperty Filter Qt3D.Render::AbstractTexture::minificationFilter
Holds the minification filter of the texture provider.
*/
@@ -864,7 +864,7 @@ void QAbstractTexture::setMinificationFilter(Filter f)
Holds the magnification filter of the texture provider.
*/
/*!
- \qmlproperty Filter Qt3DRender::QAbstractTexture::magnificationFilter
+ \qmlproperty Filter Qt3D.Render::AbstractTexture::magnificationFilter
Holds the magnification filter of the texture provider.
*/
@@ -898,7 +898,7 @@ QAbstractTexture::Filter QAbstractTexture::magnificationFilter() const
Holds the wrap mode of the texture provider.
*/
/*!
- \qmlproperty QTextureWrapMode Qt3DRender::QAbstractTexture::wrapMode
+ \qmlproperty QTextureWrapMode Qt3D.Render::AbstractTexture::wrapMode
Holds the wrap mode of the texture provider.
*/
@@ -934,7 +934,7 @@ QTextureWrapMode *QAbstractTexture::wrapMode()
Holds the maximum anisotropy of the texture provider.
*/
/*!
- \qmlproperty bool Qt3DRender::QAbstractTexture::maximumAnisotropy
+ \qmlproperty bool Qt3D.Render::AbstractTexture::maximumAnisotropy
Holds the maximum anisotropy of the texture provider.
*/
@@ -965,7 +965,7 @@ float QAbstractTexture::maximumAnisotropy() const
Holds the comparison function of the texture provider.
*/
/*!
- \qmlproperty ComparisonFunction Qt3DRender::QAbstractTexture::ComparisonFunction
+ \qmlproperty ComparisonFunction Qt3D.Render::AbstractTexture::ComparisonFunction
Holds the comparison function of the texture provider.
*/
@@ -997,7 +997,7 @@ QAbstractTexture::ComparisonFunction QAbstractTexture::comparisonFunction() cons
*/
/*!
- \qmlproperty ComparisonMode Qt3DRender::QAbstractTexture::ComparisonMode
+ \qmlproperty ComparisonMode Qt3D.Render::AbstractTexture::ComparisonMode
Holds the comparison mode of the texture provider.
*/
diff --git a/src/render/texture/qtextureimage.cpp b/src/render/texture/qtextureimage.cpp
index fa0f14a51..4c0d1d6e4 100644
--- a/src/render/texture/qtextureimage.cpp
+++ b/src/render/texture/qtextureimage.cpp
@@ -164,7 +164,7 @@ void QTextureImage::setSource(const QUrl &source)
*/
/*!
- \qmlproperty bool Qt3DRender::QTextureImage::mirrored
+ \qmlproperty bool Qt3D.Render::TextureImage::mirrored
This property specifies whether the image should be mirrored when loaded. This
is a convenience to avoid having to manipulate images to match the origin of