diff options
author | Topi Reinio <topi.reinio@qt.io> | 2019-11-13 09:19:05 +0100 |
---|---|---|
committer | Topi Reinio <topi.reinio@qt.io> | 2019-11-13 11:29:48 +0100 |
commit | 0b5d01eeec9913a0bb0d545b48d13cec8dde5354 (patch) | |
tree | 987a7b04d65b4e27f86687b8eee5e8c16f0ad6e2 /src | |
parent | 8de836c63eb0a0e484ae4c9e02f0a5f23ef49b65 (diff) |
Doc: Fix documentation warnings
- Add (basic) documentation for Qt3DAnimation::QAnimationCallback.
- Add missing namespace qualifiers for \class, \fn, \instantiates,
\sa, and \property commands.
- Remove linking to example file pages, as QDoc no longe treats them
as linkable targets.
- Fix function/QML method parameter documentation
- Fix missing \qmlproperty types
- Fix linking to QKeyEvent in QtGui.
- Move Qt3DRender::Quick namespace documentation to where QDoc can
see it.
- Add enum documentation for
Qt3DRender::QBlitFramebuffer::InterpolationMethod and
Qt3DRender::QMesh::Status.
- Other minor fixes
This brings the current warning count to zero.
Fixes: QTBUG-79822
Change-Id: I1154a7f9c34917a3f240e99da0e7a300be7d65a0
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'src')
34 files changed, 144 insertions, 82 deletions
diff --git a/src/animation/frontend/qabstractanimationclip.cpp b/src/animation/frontend/qabstractanimationclip.cpp index 53ae46809..08133072c 100644 --- a/src/animation/frontend/qabstractanimationclip.cpp +++ b/src/animation/frontend/qabstractanimationclip.cpp @@ -121,7 +121,7 @@ void QAbstractAnimationClipPrivate::setDuration(float duration) animator->setRunning(true); \endcode - \sa QAnimationClip, QAnimationClipLoader + \sa Qt3DAnimation::QAnimationClip, Qt3DAnimation::QAnimationClipLoader */ /*! diff --git a/src/animation/frontend/qanimationcallback.qdoc b/src/animation/frontend/qanimationcallback.qdoc new file mode 100644 index 000000000..5c6e8e212 --- /dev/null +++ b/src/animation/frontend/qanimationcallback.qdoc @@ -0,0 +1,51 @@ +/**************************************************************************** +** +** Copyright (C) 2019 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \class Qt3DAnimation::QAnimationCallback + \inmodule Qt3DAnimation + \brief Represents an animation callback object. +*/ + +/*! + \enum Qt3DAnimation::QAnimationCallback::Flag + + Flags to indicate how the valueChanged() function is called. + + \value OnOwningThread + Callback function is called on the owning (GUI or main) thread. + \value OnThreadPool + Callback function is called on the thread pool's worker thread. +*/ + +/*! + \fn Qt3DAnimation::QAnimationCallback::valueChanged(const QVariant &value) + + Callback function that is triggered for changes in the animated \a value. + + \sa QCallbackMapping::setCallback() +*/ diff --git a/src/animation/frontend/qanimationclip.cpp b/src/animation/frontend/qanimationclip.cpp index d624a246a..74a9b8371 100644 --- a/src/animation/frontend/qanimationclip.cpp +++ b/src/animation/frontend/qanimationclip.cpp @@ -51,8 +51,8 @@ QAnimationClipPrivate::QAnimationClipPrivate() } /*! - \class QAnimationClip - \inherits QAbstractAnimationClip + \class Qt3DAnimation::QAnimationClip + \inherits Qt3dAnimation::QAbstractAnimationClip \inmodule Qt3DAnimation \brief Specifies key frame animation data. */ diff --git a/src/animation/frontend/qanimationclipdata.cpp b/src/animation/frontend/qanimationclipdata.cpp index 49de71e79..e105b7b43 100644 --- a/src/animation/frontend/qanimationclipdata.cpp +++ b/src/animation/frontend/qanimationclipdata.cpp @@ -53,7 +53,7 @@ public: }; /*! - \class QAnimationClipData + \class Qt3DAnimation::QAnimationClipData \inmodule Qt3DAnimation \brief Class containing the animation data. */ diff --git a/src/animation/frontend/qcallbackmapping.cpp b/src/animation/frontend/qcallbackmapping.cpp index 53f7a5e33..24b5d2e6e 100644 --- a/src/animation/frontend/qcallbackmapping.cpp +++ b/src/animation/frontend/qcallbackmapping.cpp @@ -57,7 +57,7 @@ QCallbackMappingPrivate::QCallbackMappingPrivate() } /*! - \class QCallbackMapping + \class Qt3DAnimation::QCallbackMapping \inherits Qt3DCore::QAbstractChannelMapping \inmodule Qt3DAnimation \brief Allows to map the channels within the clip onto an invocation diff --git a/src/animation/frontend/qchannel.cpp b/src/animation/frontend/qchannel.cpp index eab7f0df4..1e0da3c3f 100644 --- a/src/animation/frontend/qchannel.cpp +++ b/src/animation/frontend/qchannel.cpp @@ -54,7 +54,7 @@ public: }; /*! - \class QChannel + \class Qt3DAnimation::QChannel \inmodule Qt3DAnimation \brief Defines a channel for a QAnimationClipData. The animation system interpolates each channel component independently diff --git a/src/animation/frontend/qchannelmapper.cpp b/src/animation/frontend/qchannelmapper.cpp index ab98039b4..c5909adbc 100644 --- a/src/animation/frontend/qchannelmapper.cpp +++ b/src/animation/frontend/qchannelmapper.cpp @@ -49,7 +49,7 @@ QChannelMapperPrivate::QChannelMapperPrivate() } /*! - \class QChannelMapper + \class Qt3DAnimation::QChannelMapper \inmodule Qt3DAnimation \brief Allows to map the channels within the clip onto properties of objects in the application. diff --git a/src/animation/frontend/qchannelmapping.cpp b/src/animation/frontend/qchannelmapping.cpp index 59620ab49..16651afe6 100644 --- a/src/animation/frontend/qchannelmapping.cpp +++ b/src/animation/frontend/qchannelmapping.cpp @@ -161,7 +161,7 @@ void QChannelMappingPrivate::updatePropertyNameTypeAndComponentCount() } /*! - \class QChannelMapping + \class Qt3DAnimation::QChannelMapping \inherits Qt3DCore::QNode \inmodule Qt3DAnimation \brief Allows to map the channels within the clip onto properties of diff --git a/src/animation/frontend/qclipanimator.cpp b/src/animation/frontend/qclipanimator.cpp index 03510aa93..ffad588c1 100644 --- a/src/animation/frontend/qclipanimator.cpp +++ b/src/animation/frontend/qclipanimator.cpp @@ -107,7 +107,8 @@ bool QClipAnimatorPrivate::canPlay() const The properties for controlling the animator are provided by the QAbstractClipAnimator base class. - \sa QAbstractClipAnimator, QAbstractAnimationClip, QChannelMapper, QBlendedClipAnimator + \sa Qt3DAnimation::QAbstractClipAnimator, Qt3DAnimation::QAbstractAnimationClip, + Qt3DAnimation::QChannelMapper, Qt3DAnimation::QBlendedClipAnimator */ QClipAnimator::QClipAnimator(Qt3DCore::QNode *parent) diff --git a/src/animation/frontend/qclipblendvalue.cpp b/src/animation/frontend/qclipblendvalue.cpp index 72a7dd796..053453e33 100644 --- a/src/animation/frontend/qclipblendvalue.cpp +++ b/src/animation/frontend/qclipblendvalue.cpp @@ -53,14 +53,14 @@ QClipBlendValuePrivate::QClipBlendValuePrivate() } /*! - \class QClipBlendValue + \class Qt3DAnimation::QClipBlendValue \inherits Qt3DAnimation::QAbstractClipBlendNode \inmodule Qt3DAnimation \brief Class used for including a clip in a blend tree. */ /*! \qmltype ClipBlendValue - \instantiates QClipBlendValue + \instantiates Qt3DAnimation::QClipBlendValue \inqmlmodule Qt3D.Animation \brief Type used for including a clip in a blend tree. */ diff --git a/src/animation/frontend/qmorphtarget.cpp b/src/animation/frontend/qmorphtarget.cpp index 76b1a598e..da068d477 100644 --- a/src/animation/frontend/qmorphtarget.cpp +++ b/src/animation/frontend/qmorphtarget.cpp @@ -86,8 +86,8 @@ namespace Qt3DAnimation { */ /*! \qmlmethod MorphTarget Qt3D.Animation::MorphTarget::fromGeometry(geometry, stringList) - Returns a morph target based on the attributes defined by the given stringList from - the given geometry. + Returns a morph target based on the attributes defined by the given \a stringList from + the given \a geometry. */ QMorphTargetPrivate::QMorphTargetPrivate() diff --git a/src/core/nodes/qentity.cpp b/src/core/nodes/qentity.cpp index 024991387..93601901f 100644 --- a/src/core/nodes/qentity.cpp +++ b/src/core/nodes/qentity.cpp @@ -75,7 +75,7 @@ namespace Qt3DCore { */ /*! - \fn template<typename T> QVector<T *> QEntity::componentsOfType() const + \fn template<typename T> QVector<T *> Qt3DCore::QEntity::componentsOfType() const Returns all the components added to this entity that can be cast to type T or an empty vector if there are no such components. diff --git a/src/extras/defaults/qabstractspritesheet.cpp b/src/extras/defaults/qabstractspritesheet.cpp index 640e600c7..2cf134f7c 100644 --- a/src/extras/defaults/qabstractspritesheet.cpp +++ b/src/extras/defaults/qabstractspritesheet.cpp @@ -100,7 +100,7 @@ QAbstractSpriteSheet::~QAbstractSpriteSheet() } /*! - \property QAbstractSpriteSheet::texture + \property Qt3DExtras::QAbstractSpriteSheet::texture Holds the current texture used by the material. */ diff --git a/src/input/frontend/qactioninput.cpp b/src/input/frontend/qactioninput.cpp index 9f32f57cc..f013147f2 100644 --- a/src/input/frontend/qactioninput.cpp +++ b/src/input/frontend/qactioninput.cpp @@ -181,7 +181,7 @@ QAbstractPhysicalDevice *QActionInput::sourceDevice() const /*! \qmlsignal Qt3D.Input::ActionInput::buttonsChanged(const QVector<int> &buttons) - This signal is emitted when the buttons associated with the action input is changed. + This signal is emitted when the \a buttons associated with the action input is changed. The corresponding handler is \c onbuttonsChanged */ diff --git a/src/input/frontend/qkeyevent.cpp b/src/input/frontend/qkeyevent.cpp index a70a2970b..efbddc771 100644 --- a/src/input/frontend/qkeyevent.cpp +++ b/src/input/frontend/qkeyevent.cpp @@ -160,7 +160,7 @@ QKeyEvent::~QKeyEvent() /*! \qmlmethod bool Qt3D.Input::KeyEvent::matches(StandardKey key) - Returns \c true if the key event matches the given standard key; otherwise + Returns \c true if the key event matches the given standard \a key; otherwise returns \c false. \sa QKeySequence::StandardKey @@ -174,7 +174,7 @@ QKeyEvent::~QKeyEvent() See \l [CPP] {Qt::Key}{Qt.Key} for the list of keyboard codes. - \sa {QKeyEvent::key} + \b {See also} \l [QtGui] {QKeyEvent::key()}. */ /*! @@ -194,7 +194,7 @@ QKeyEvent::~QKeyEvent() This property holds the keyboard modifier flags that existed immediately before the event occurred. - \sa {QKeyEvent::modifiers} + \b {See also} \l [QtGui] {QKeyEvent::modifiers()}. */ /*! diff --git a/src/input/frontend/qmousehandler.cpp b/src/input/frontend/qmousehandler.cpp index 1d45d85b6..89d76a057 100644 --- a/src/input/frontend/qmousehandler.cpp +++ b/src/input/frontend/qmousehandler.cpp @@ -197,21 +197,21 @@ void QMouseHandlerPrivate::mouseEvent(const QMouseEventPtr &event) \qmlsignal Qt3D.Input::MouseHandler::wheel(MouseEvent mouse) This signal is emitted when the mouse wheel is used with the event details - being contained within \a wheel + being contained within \a mouse. */ /*! \fn Qt3DInput::QMouseHandler::clicked(Qt3DInput::QMouseEvent *mouse) This signal is emitted when a mouse button is clicked with the event details - being contained within \a mouse + being contained within \a mouse. */ /*! \fn Qt3DInput::QMouseHandler::doubleClicked(Qt3DInput::QMouseEvent *mouse) This signal is emitted when a mouse button is double clicked with the event - details being contained within \a mouse + details being contained within \a mouse. */ /*! diff --git a/src/input/frontend/qphysicaldevicecreatedchange.cpp b/src/input/frontend/qphysicaldevicecreatedchange.cpp index c14770d80..905633b7f 100644 --- a/src/input/frontend/qphysicaldevicecreatedchange.cpp +++ b/src/input/frontend/qphysicaldevicecreatedchange.cpp @@ -54,7 +54,7 @@ QPhysicalDeviceCreatedChangeBasePrivate::QPhysicalDeviceCreatedChangeBasePrivate } /*! - \class QPhysicalDeviceCreatedChangeBase + \class Qt3DInput::QPhysicalDeviceCreatedChangeBase \inmodule Qt3DInput \brief Base class for handling changes in physical devices. */ diff --git a/src/quick3d/imports/scene3d/scene3ditem.cpp b/src/quick3d/imports/scene3d/scene3ditem.cpp index 0fbde1191..5a1cec495 100644 --- a/src/quick3d/imports/scene3d/scene3ditem.cpp +++ b/src/quick3d/imports/scene3d/scene3ditem.cpp @@ -558,7 +558,7 @@ void Scene3DItem::setWindowSurface(QObject *rootObject) /*! \qmlmethod void Scene3D::setItemAreaAndDevicePixelRatio(size area, real devicePixelRatio) - \brief \TODO + Sets the item area to \a area and the pixel ratio to \a devicePixelRatio. */ void Scene3DItem::setItemAreaAndDevicePixelRatio(QSize area, qreal devicePixelRatio) { diff --git a/src/quick3d/quick3dscene2d/items/qscene2d.cpp b/src/quick3d/quick3dscene2d/items/qscene2d.cpp index dfa3f261f..09d50a5aa 100644 --- a/src/quick3d/quick3dscene2d/items/qscene2d.cpp +++ b/src/quick3d/quick3dscene2d/items/qscene2d.cpp @@ -52,6 +52,12 @@ namespace Qt3DRender { namespace Quick { /*! + \namespace Qt3DRender::Quick + \inmodule Qt3DScene2D + \brief Internal namespace to import QML types. +*/ + +/*! \class Qt3DRender::Quick::QScene2D \inheaderfile Qt3DQuickScene2D/QScene2D \inmodule Qt3DScene2D diff --git a/src/quick3d/quick3dscene2d/items/qscene2d.h b/src/quick3d/quick3dscene2d/items/qscene2d.h index eab900ca4..45d0f26c9 100644 --- a/src/quick3d/quick3dscene2d/items/qscene2d.h +++ b/src/quick3d/quick3dscene2d/items/qscene2d.h @@ -51,11 +51,6 @@ QT_BEGIN_NAMESPACE namespace Qt3DRender { -/*! - \namespace Qt3DRender::Quick - - \brief Internal namespace to import QML types. -*/ namespace Quick { class QScene2DPrivate; diff --git a/src/render/framegraph/qblitframebuffer.cpp b/src/render/framegraph/qblitframebuffer.cpp index 3a26e3d56..252758af4 100644 --- a/src/render/framegraph/qblitframebuffer.cpp +++ b/src/render/framegraph/qblitframebuffer.cpp @@ -70,6 +70,10 @@ namespace Qt3DRender { Specifies the interpolation applied if the image is stretched. + \value Nearest + Nearest-neighbor interpolation. + \value Linear + Linear interpolation. */ /*! \property Qt3DRender::QBlitFramebuffer::destination diff --git a/src/render/framegraph/qsetfence.cpp b/src/render/framegraph/qsetfence.cpp index 5cb82f3db..262dbd4ad 100644 --- a/src/render/framegraph/qsetfence.cpp +++ b/src/render/framegraph/qsetfence.cpp @@ -54,7 +54,8 @@ QSetFencePrivate::QSetFencePrivate() } /*! - \class QSetFence + \class Qt3DRender::QSetFence + \inmodule Qt3DRender \brief FrameGraphNode used to insert a fence in the graphics command stream. Fence allow to synchronosize GPU and CPU workloads. GPU commands usually @@ -100,7 +101,7 @@ QSetFence::QSetFence(QSetFencePrivate &dd, Qt3DCore::QNode *parent) are supported. */ /*! - \property QSetFence::handleType + \property Qt3DRender::QSetFence::handleType Specifies the type of handle being used. Currently only OpenGL Fence ids are supported. @@ -123,12 +124,12 @@ void QSetFencePrivate::setHandleType(QSetFence::HandleType type) } /*! - \qmlproperty variant AbstractFence::handle + \qmlproperty variant SetFence::handle Holds the underlying fence handle wrapped in a variant. */ /*! - \property QAbstractFence::handle + \property Qt3DRender::QSetFence::handle Holds the underlying fence handle wrapped in a QVariant. */ diff --git a/src/render/framegraph/qwaitfence.cpp b/src/render/framegraph/qwaitfence.cpp index 5195653ce..737f4e54d 100644 --- a/src/render/framegraph/qwaitfence.cpp +++ b/src/render/framegraph/qwaitfence.cpp @@ -56,8 +56,8 @@ QWaitFencePrivate::QWaitFencePrivate() } /*! - \class QWaitFence - + \class Qt3DRender::QWaitFence + \inmodule Qt3DRender \brief FrameGraphNode used to wait for a fence in the graphics command stream to become signaled. @@ -98,7 +98,7 @@ QWaitFence::~QWaitFence() become signaled. This is false by default. */ /*! - \property QWaitFence::waitOnCPU + \property Qt3DRender::QWaitFence::waitOnCPU Specifies whether the CPU should be block while waiting for the fence to become signaled. This is false by default. @@ -125,7 +125,7 @@ void QWaitFence::setWaitOnCPU(bool waitOnCPU) to become signaled. */ /*! - \property QWaitFence::timeout + \property Qt3DRender::QWaitFence::timeout Specifies the maximum amount of time in nanoseconds to wait for the fence to become signaled. @@ -157,7 +157,7 @@ QWaitFence::QWaitFence(QWaitFencePrivate &dd, Qt3DCore::QNode *parent) are supported. */ /*! - \property QWaitFence::handleType + \property Qt3DRender::QWaitFence::handleType Specifies the type of handle being used. Currently only OpenGL Fence ids are supported. @@ -183,7 +183,7 @@ void QWaitFence::setHandleType(QWaitFence::HandleType type) Holds the underlying fence handle wrapped in a variant. */ /*! - \property QWaitFence::handle + \property Qt3DRender::QWaitFence::handle Holds the underlying fence handle wrapped in a QVariant. */ diff --git a/src/render/frontend/qcamera.cpp b/src/render/frontend/qcamera.cpp index 2dcec7ed6..b0fd16182 100644 --- a/src/render/frontend/qcamera.cpp +++ b/src/render/frontend/qcamera.cpp @@ -235,7 +235,7 @@ void QCameraPrivate::updateViewMatrixAndTransform(bool doEmit) * \qmlmethod void Qt3D.Render::Camera::viewEntity(Entity entity) * * Rotates and moves the camera so that it's viewCenter is the center of the entity's bounding volume - * and the entire entity fits in the view port. + * and the entire \a entity fits in the view port. * * \note Only works if the lens is in perspective projection mode. * \sa Qt3D.Render::Camera::projectionType diff --git a/src/render/frontend/qcomputecommand.cpp b/src/render/frontend/qcomputecommand.cpp index d0c9f5805..dfd9c2033 100644 --- a/src/render/frontend/qcomputecommand.cpp +++ b/src/render/frontend/qcomputecommand.cpp @@ -92,15 +92,15 @@ namespace Qt3DRender { */ /*! - \qmlproperty QComputeCommand::runType + \qmlproperty enumeration ComputeCommand::runType Specifies whether the compute command should be performed every frame or manually triggered. - \value Continuous Compute command is executed everyframe. This is the + \value ComputeCommand.Continuous Compute command is executed everyframe. This is the default. - \value Manual CompouteCommand is executed for a given number of frames and + \value ComputeCommand.Manual CompouteCommand is executed for a given number of frames and then the component disables itself. */ diff --git a/src/render/geometry/qmesh.cpp b/src/render/geometry/qmesh.cpp index f5307f7a9..1f05a71f6 100644 --- a/src/render/geometry/qmesh.cpp +++ b/src/render/geometry/qmesh.cpp @@ -148,17 +148,6 @@ void QMeshPrivate::setStatus(QMesh::Status status) */ /*! - \enum QMesh::Status - - This enum identifies the status of shader used. - - \value None A source mesh hasn't been assigned a source yet - \value Loading The mesh geometry is loading - \value Ready The mesh geometry was successfully loaded - \value Error An error occurred while loading the mesh -*/ - -/*! \qmlproperty enumeration Mesh::status Holds the status of the mesh loading. @@ -197,6 +186,17 @@ void QMeshPrivate::setStatus(QMesh::Status status) */ /*! + \enum Qt3DRender::QMesh::Status + + This enum identifies the status of shader used. + + \value None A source mesh hasn't been assigned a source yet + \value Loading The mesh geometry is loading + \value Ready The mesh geometry was successfully loaded + \value Error An error occurred while loading the mesh +*/ + +/*! * Constructs a new QMesh with \a parent. */ QMesh::QMesh(QNode *parent) diff --git a/src/render/io/qsceneloader.cpp b/src/render/io/qsceneloader.cpp index 7d4413bff..2d53702f6 100644 --- a/src/render/io/qsceneloader.cpp +++ b/src/render/io/qsceneloader.cpp @@ -317,7 +317,7 @@ QStringList QSceneLoader::entityNames() const /*! \qmlmethod Entity SceneLoader::component(string entityName, enumeration componentType) - Returns a component matching \a componentType of a loaded entity with an \a objectName matching + Returns a component matching \a componentType of a loaded entity with an \e objectName matching the \a entityName. If the entity has multiple matching components, the first match in the component list of the entity is returned. diff --git a/src/render/materialsystem/qshaderimage.cpp b/src/render/materialsystem/qshaderimage.cpp index f2ce04c3d..508cf44f2 100644 --- a/src/render/materialsystem/qshaderimage.cpp +++ b/src/render/materialsystem/qshaderimage.cpp @@ -342,7 +342,7 @@ QShaderImagePrivate::~QShaderImagePrivate() */ /*! - \qmlproperty Qt3DRender::QShaderImage::mipLevel + \qmlproperty int Qt3D.Render::ShaderImage::mipLevel Holds which mipLevel out of the referenced texture should be used for the ShaderImage. @@ -351,7 +351,7 @@ QShaderImagePrivate::~QShaderImagePrivate() */ /*! - \qmlproperty Qt3DRender::QShaderImage::layer + \qmlproperty int Qt3D.Render::ShaderImage::layer Holds which layer out of the referenced texture should be used for the ShaderImage. This property does nothing if \a layered is set to true or if @@ -365,11 +365,11 @@ QShaderImagePrivate::~QShaderImagePrivate() cubeMapFace = layer - (cubeMapLayer * 6) \endcode - \default 0 + Default value is 0. */ /*! - * \qmlproperty Qt3DRender::QShaderImage::layered + * \qmlproperty bool Qt3D.Render::ShaderImage::layered If set to true, if the referenced texture is a one-dimensional array, two-dimensional array, three-dimensional, cube map, cube map array, or @@ -377,21 +377,28 @@ QShaderImagePrivate::~QShaderImagePrivate() for all layers. If set to false, only the single layer specified by the \a layer property will be bound. - \default false + Default value is \c false. */ /*! - \qmlproperty Qt3DRender::QShaderImage::access + \qmlproperty enumeration Qt3D.Render::ShaderImage::access Specifies the type of access we want to allow from our shader instances to the image. If a shader tries to write or read from an image that has incompatible access, the behavior is undefined. - \default ShaderImage.ReadWrite + \value ShaderImage.ReadOnly + Read-only access. + \value ShaderImage.WriteOnly + Write-only access. + \value ShaderImage.ReadWrite + Read-write access. + + Default value is ShaderImage.ReadWrite. */ /*! - \qmlproperty Qt3DRender::QShaderImage::format + \qmlproperty enumeration Qt3D.Render::ShaderImage::format Specifies the image format, which is essentially important when storing values in the ShaderImage from a shader. @@ -407,7 +414,7 @@ QShaderImagePrivate::~QShaderImagePrivate() By default Qt3D will try to set the image format to match that of the referenced texture. - \default ShaderImage.Automatic + Default value is ShaderImage.Automatic. */ /*! diff --git a/src/render/picking/qabstractraycaster.cpp b/src/render/picking/qabstractraycaster.cpp index ab0916401..5f4c4c490 100644 --- a/src/render/picking/qabstractraycaster.cpp +++ b/src/render/picking/qabstractraycaster.cpp @@ -58,10 +58,6 @@ QAbstractRayCasterPrivate::QAbstractRayCasterPrivate() m_shareable = false; } -/*! - \property Qt3DRender::QAbstractRayCaster::Hits -*/ - QAbstractRayCasterPrivate *QAbstractRayCasterPrivate::get(QAbstractRayCaster *obj) { return obj->d_func(); diff --git a/src/render/picking/qobjectpicker.cpp b/src/render/picking/qobjectpicker.cpp index b7f2c0815..4f039b361 100644 --- a/src/render/picking/qobjectpicker.cpp +++ b/src/render/picking/qobjectpicker.cpp @@ -152,7 +152,7 @@ namespace Qt3DRender { This signal is emitted when the bounding volume defined by the pickAttribute property intersects with a ray on a mouse click. Intersection - information are accessible through the pick \a parameter. + information are accessible through the \a pick parameter. */ /*! diff --git a/src/render/renderstates/qrastermode.cpp b/src/render/renderstates/qrastermode.cpp index c432f1063..648872a84 100644 --- a/src/render/renderstates/qrastermode.cpp +++ b/src/render/renderstates/qrastermode.cpp @@ -48,7 +48,7 @@ namespace Qt3DRender { /*! \class Qt3DRender::QRasterMode \brief The QRasterMode render state allows to control the type of - rasterization to be performed + rasterization to be performed. \since 5.14 \inmodule Qt3DRender \ingroup renderstates @@ -65,7 +65,7 @@ namespace Qt3DRender { /*! \qmltype RasterMode \brief The RasterMode render state allows to control the type of - rasterization to be performed + rasterization to be performed. \since 5.14 \inqmlmodule Qt3D.Render \inherits RenderState diff --git a/src/render/texture/qabstracttexture.cpp b/src/render/texture/qabstracttexture.cpp index 7fca2ba3f..b92576d99 100644 --- a/src/render/texture/qabstracttexture.cpp +++ b/src/render/texture/qabstracttexture.cpp @@ -977,7 +977,7 @@ float QAbstractTexture::maximumAnisotropy() const } /*! - \property Qt3DRender::QAbstractTexture::ComparisonFunction + \property Qt3DRender::QAbstractTexture::comparisonFunction Holds the comparison function of the texture provider. */ @@ -1008,7 +1008,7 @@ QAbstractTexture::ComparisonFunction QAbstractTexture::comparisonFunction() cons } /*! - \property Qt3DRender::QAbstractTexture::ComparisonMode + \property Qt3DRender::QAbstractTexture::comparisonMode Holds the comparison mode of the texture provider. */ @@ -1055,9 +1055,12 @@ QTextureGeneratorPtr QAbstractTexture::dataGenerator() const */ /*! - * \qmlproperty handleType + * \qmlproperty enumeration AbstractTexture::handleType * * Holds the current texture handle type. + * + * \value AbstractTexture.NoHandle + * \value AbstractTexture.OpenGLTextureId */ /*! @@ -1070,7 +1073,6 @@ QAbstractTexture::HandleType QAbstractTexture::handleType() const return d->m_handleType; } - /*! * \property Qt3DRender::QAbstractTexture::handle * @@ -1079,7 +1081,7 @@ QAbstractTexture::HandleType QAbstractTexture::handleType() const */ /*! - * \qmlproperty handle + * \qmlproperty var AbstractTexture::handle * * Holds the current texture handle, if Qt 3D is using the OpenGL renderer, * handle is a texture id integer. @@ -1098,8 +1100,8 @@ QVariant QAbstractTexture::handle() const } /*! - * Allow to update a sub region of the texture without having to change the data - * generator or rely on adding or removing texture images. + * Updates a sub region of the texture, defined by \a update, without having + * to change the data generator or rely on adding or removing texture images. * \since 5.14 */ void QAbstractTexture::updateData(const QTextureDataUpdate &update) diff --git a/src/render/texture/qabstracttextureimage.cpp b/src/render/texture/qabstracttextureimage.cpp index 9ca4599c5..6f68221fd 100644 --- a/src/render/texture/qabstracttextureimage.cpp +++ b/src/render/texture/qabstracttextureimage.cpp @@ -131,8 +131,8 @@ QTextureImageDataGeneratorPtr QAbstractTextureImagePrivate::dataGenerator() cons /*! \fn Qt3DRender::QTextureImageDataGeneratorPtr Qt3DRender::QAbstractTextureImage::dataGenerator() const - Implement this method to return the \l QTextureImageDataGeneratorPtr, which will - provide the data for the texture image. + Implement this method to return the QTextureImageDataGeneratorPtr instance, + which will provide the data for the texture image. */ /*! diff --git a/src/render/texture/qtexturegenerator.cpp b/src/render/texture/qtexturegenerator.cpp index 5e350af2d..36b5f6498 100644 --- a/src/render/texture/qtexturegenerator.cpp +++ b/src/render/texture/qtexturegenerator.cpp @@ -52,8 +52,7 @@ QTextureGenerator::~QTextureGenerator() } /*! - \class QTextureGenerator - \inherits QAbstractFunctor + \class Qt3DRender::QTextureGenerator \inmodule Qt3DRender \brief Provides the image data for a texture. */ |