diff options
author | Topi Reinio <topi.reinio@qt.io> | 2020-11-25 12:23:16 +0100 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2020-11-25 22:32:06 +0000 |
commit | c908d0262fafb3710e89c02b7bbdf2867ddd9ecd (patch) | |
tree | 4005e96781ccd8897d8cf517bec38e4531b0d78b | |
parent | d6d7e4a46ddd1ad14a3a4874b06f59d68e734b64 (diff) |
Doc: Fix documentation warnings
Fixes: QTBUG-88842
Change-Id: Ie8ea1914c5e740c0c4bf25f4754a008aff6401cd
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
(cherry picked from commit 2687a8b3c0428f0da71bef05324dfbdd3581fc20)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r-- | src/animation/frontend/qmorphtarget.cpp | 4 | ||||
-rw-r--r-- | src/core/geometry/qboundingvolume.cpp | 95 | ||||
-rw-r--r-- | src/core/geometry/qbuffer.cpp | 28 | ||||
-rw-r--r-- | src/core/geometry/qgeometry.cpp | 11 | ||||
-rw-r--r-- | src/core/jobs/qaspectjob.cpp | 5 | ||||
-rw-r--r-- | src/core/nodes/qbackendnode.cpp | 2 | ||||
-rw-r--r-- | src/core/nodes/qnode.cpp | 69 | ||||
-rw-r--r-- | src/core/nodes/qnodeid.cpp | 2 | ||||
-rw-r--r-- | src/core/nodes/qnodeid.h | 1 | ||||
-rw-r--r-- | src/doc/Qt3DDoc | 1 | ||||
-rw-r--r-- | src/doc/qt3d.qdocconf | 1 | ||||
-rw-r--r-- | src/doc/src/qt3d-overview.qdoc | 5 | ||||
-rw-r--r-- | src/doc/src/qt3drender-module.qdoc | 2 | ||||
-rw-r--r-- | src/doc/src/qt6-changes.qdoc | 2 | ||||
-rw-r--r-- | src/extras/geometries/qcylindergeometryview.cpp | 8 | ||||
-rw-r--r-- | src/render/frontend/qrendercapabilities.cpp | 3 | ||||
-rw-r--r-- | src/render/materialsystem/qgraphicsapifilter.cpp | 2 | ||||
-rw-r--r-- | src/render/picking/qpicktriangleevent.cpp | 2 | ||||
-rw-r--r-- | src/render/texture/qabstracttexture.cpp | 5 | ||||
-rw-r--r-- | src/render/texture/qtextureimagedata.cpp | 25 |
20 files changed, 82 insertions, 191 deletions
diff --git a/src/animation/frontend/qmorphtarget.cpp b/src/animation/frontend/qmorphtarget.cpp index bca51cfe4..537dc0d86 100644 --- a/src/animation/frontend/qmorphtarget.cpp +++ b/src/animation/frontend/qmorphtarget.cpp @@ -63,9 +63,9 @@ namespace Qt3DAnimation { \instantiates Qt3DAnimation::QMorphTarget A MorphTarget type is a convenience type, which provides a list - of \l {Qt3D.Render::Attribute} {Attributes}, which the MorphingAnimation uses + of \l {Qt3D.Core::Attribute} {Attributes}, which the MorphingAnimation uses to animate geometry. A MorphTarget can also be created based on existing - \l {Qt3D.Render::Geometry}{Geometry}. + \l {Qt3D.Core::Geometry}{Geometry}. */ diff --git a/src/core/geometry/qboundingvolume.cpp b/src/core/geometry/qboundingvolume.cpp index ebe524601..54bf9ffa8 100644 --- a/src/core/geometry/qboundingvolume.cpp +++ b/src/core/geometry/qboundingvolume.cpp @@ -154,42 +154,41 @@ QBoundingVolumePrivate *QBoundingVolumePrivate::get(QBoundingVolume *q) */ /*! - * \class Qt3DCore::QBoundingVolume - * \inheaderfile Qt3DCore/QBoundingVolume - * \inmodule Qt3DCore - * \inherits Qt3DCore::QComponent - * \since 6.0 - * - * \brief can be used to override an entity's bounding volume. - * - * An entity's bounding volume is used for many operations such as - * picking or view frustum culling. It is normally computed by - * traversing the rendered geometry. - * - * QBoundingVolume can be used when the extent of the geometry is - * known to the application so that Qt 3D does not have to - * compute it. - * - * A bounding volume can be provided either as minimum and maximum - * extent coordinates, or a separate, usually simpler, geometry - * that approximates the rendered mesh. - * - * When using minimum and maximum extents, these are considered - * to be the opposite corners of an axis aligned bounding box, - * in the geometry's local coordinate system. - * - * QBoundingVolume can also be used to query the computed bounding - * volume of a GeometryView. The implicitMinPoint and implicitMaxPoint - * properties will be updated if the geometry changes. Note that this - * is done asynchronously on a background thread so you should check - * the value of implicitPointsValid before reading them. - * - * You can force the implicit extents to be updated by calling - * updateImplicitBounds. This will block on the calling thread until - * the results are available. - * - * \note GeometryRenderer inherits BoundingVolume and thus supports - * reading implicit bounds or setting explicit bounds also. + \class Qt3DCore::QBoundingVolume + \inheaderfile Qt3DCore/QBoundingVolume + \inmodule Qt3DCore + \inherits Qt3DCore::QComponent + \since 6.0 + \brief can be used to override the bounding volume of an entity. + + An entity's bounding volume is used for many operations such as + picking or view frustum culling. It is normally computed by + traversing the rendered geometry. + + QBoundingVolume can be used when the extent of the geometry is + known to the application so that Qt 3D does not have to + compute it. + + A bounding volume can be provided either as minimum and maximum + extent coordinates, or a separate, usually simpler, geometry + that approximates the rendered mesh. + + When using minimum and maximum extents, these are considered + to be the opposite corners of an axis aligned bounding box, + in the geometry's local coordinate system. + + QBoundingVolume can also be used to query the computed bounding + volume of a GeometryView. The implicitMinPoint and implicitMaxPoint + properties will be updated if the geometry changes. Note that this + is done asynchronously on a background thread so you should check + the value of implicitPointsValid before reading them. + + You can force the implicit extents to be updated by calling + updateImplicitBounds. This will block on the calling thread until + the results are available. + + \note GeometryRenderer inherits BoundingVolume and thus supports + reading implicit bounds or setting explicit bounds also. */ /*! @@ -222,7 +221,7 @@ QBoundingVolume::~QBoundingVolume() * to compute the bounding volume. */ /*! -* \property QAttribute::view +* \property QBoundingVolume::view * * Holds a pointer to the instance of QGeometryView which will be used, if set, * to compute the bounding volume. @@ -239,7 +238,7 @@ QGeometryView *QBoundingVolume::view() const * Holds minimum extent of the bounding volume computed from the specified view. */ /*! -* \property QAttribute::implicitMinPoint +* \property QBoundingVolume::implicitMinPoint * * Holds minimum extent of the bounding volume computed from the specified view. */ @@ -255,7 +254,7 @@ QVector3D QBoundingVolume::implicitMinPoint() const * Holds maximum extent of the bounding volume computed from the specified view. */ /*! -* \property QAttribute::implicitMaxPoint +* \property QBoundingVolume::implicitMaxPoint * * Holds maximum extent of the bounding volume computed from the specified view. */ @@ -273,7 +272,7 @@ QVector3D QBoundingVolume::implicitMaxPoint() const * \sa updateImplicitBounds */ /*! -* \property QAttribute::implicitPointsValid +* \property QBoundingVolume::implicitPointsValid * * True if a view has been assigned and the implicit extent properties are up to date. * @@ -293,7 +292,7 @@ bool QBoundingVolume::areImplicitPointsValid() const * geometry. */ /*! -* \property QAttribute::minPoint +* \property QBoundingVolume::minPoint * * User specified minimum extent of the bounding volume. When set (along with maximum * extent), this will be used internally to avoid computing the volume from the @@ -313,7 +312,7 @@ QVector3D QBoundingVolume::minPoint() const * geometry. */ /*! -* \property QAttribute::maxPoint +* \property QBoundingVolume::maxPoint * * User specified maximum extent of the bounding volume. When set (along with minimum * extent), this will be used internally to avoid computing the volume from the @@ -354,10 +353,18 @@ void QBoundingVolume::setMaxPoint(const QVector3D &maxPoint) } /*! -* \brief QBoundingVolume::updateImplicitBounds +* \qmlmethod bool BoundingVolume::updateImplicitBounds() * * Updates the implicit bounds of the specified view. Returns -* true if the computation succeeded and false otherwise. +* \c true if the computation succeeded and false otherwise. +* +* \note The calculations are done in the call thread, this +* could take significant time for large meshes. +*/ + +/*! +* Updates the implicit bounds of the specified view. Returns +* \c true if the computation succeeded and false otherwise. * * \note The calculations are done in the call thread, this * could take significant time for large meshes. diff --git a/src/core/geometry/qbuffer.cpp b/src/core/geometry/qbuffer.cpp index c94b59206..9169442f1 100644 --- a/src/core/geometry/qbuffer.cpp +++ b/src/core/geometry/qbuffer.cpp @@ -122,29 +122,6 @@ void QBufferPrivate::setData(const QByteArray &data) */ /*! - * \enum QBuffer::BufferType - * - * The type of the buffer. - * - * \value VertexBuffer - * GL_ARRAY_BUFFER - * \value IndexBuffer - * GL_ELEMENT_ARRAY_BUFFER - * \value PixelPackBuffer - * GL_PIXEL_PACK_BUFFER - * \value PixelUnpackBuffer - * GL_PIXEL_UNPACK_BUFFER - * \value UniformBuffer - * GL_UNIFORM_BUFFER - * \value ShaderStorageBuffer - * GL_SHADER_STORAGE_BUFFER - * \value DrawIndirectBuffer - * GL_DRAW_INDIRECT_BUFFER - * - * \deprecated - */ - -/*! * \enum QBuffer::UsageType * * The type of the usage. @@ -181,11 +158,6 @@ void QBufferPrivate::setData(const QByteArray &data) */ /*! - * \typedef Qt3DCore::QBufferDataGeneratorPtr - * \relates Qt3DCore::QBuffer - */ - -/*! * Constructs a new QBuffer with \a parent. */ QBuffer::QBuffer(QNode *parent) diff --git a/src/core/geometry/qgeometry.cpp b/src/core/geometry/qgeometry.cpp index 6b1af6804..cc459a07b 100644 --- a/src/core/geometry/qgeometry.cpp +++ b/src/core/geometry/qgeometry.cpp @@ -162,17 +162,6 @@ QGeometry::QGeometry(QNode *parent) : QGeometry(*new QGeometryPrivate(), parent) {} /*! - \fn Qt3DCore::QGeometryFactory::operator()() - - Returns the generated geometry. -*/ -/*! - \fn bool Qt3DCore::QGeometryFactory::operator==(const QGeometryFactory &other) const = 0 - - Compares the factory with the factory specified in \a other. - Returns true if they are equal. -*/ -/*! \internal */ QGeometry::~QGeometry() diff --git a/src/core/jobs/qaspectjob.cpp b/src/core/jobs/qaspectjob.cpp index 186624aec..cf4fb07d6 100644 --- a/src/core/jobs/qaspectjob.cpp +++ b/src/core/jobs/qaspectjob.cpp @@ -153,8 +153,9 @@ const std::vector<QWeakPointer<QAspectJob> > &QAspectJob::dependencies() const } /*! - * This is called, in the main thread, when all the jobs have completed. - * It's a good point to push changes back to the frontend. + * Called in the main thread when all the jobs have completed. + * This is a good point to push changes back to the frontend. + * \a aspectEngine is the engine responsible for the run loop. */ void QAspectJob::postFrame(QAspectEngine *aspectEngine) { diff --git a/src/core/nodes/qbackendnode.cpp b/src/core/nodes/qbackendnode.cpp index ae7a3023b..9855baeb2 100644 --- a/src/core/nodes/qbackendnode.cpp +++ b/src/core/nodes/qbackendnode.cpp @@ -106,7 +106,7 @@ void QBackendNodePrivate::componentRemoved(QNode *frontend) * * \TODO * - * \a change + * \a id * * \return created node. */ diff --git a/src/core/nodes/qnode.cpp b/src/core/nodes/qnode.cpp index baf9525cb..d9ab8f0dc 100644 --- a/src/core/nodes/qnode.cpp +++ b/src/core/nodes/qnode.cpp @@ -631,36 +631,6 @@ void QNodePrivate::nodePtrDeleter(QNode *q) */ /*! - \fn void Qt3DCore::QNodeCommand::setReplyToCommandId(CommandId id) - - Sets the command \a id to which the message is a reply. - -*/ -/*! - \fn Qt3DCore::QNode::PropertyTrackingMode Qt3DCore::QNode::defaultPropertyTrackingMode() const - - Returns the default property tracking mode which determines whether a - QNode should be listening for property updates. - -*/ -/*! - \fn Qt3DCore::QNode::clearPropertyTracking(const QString &propertyName) - - Clears the tracking property called \a propertyName. -*/ -/*! - \fn Qt3DCore::QNode::PropertyTrackingMode Qt3DCore::QNode::propertyTracking(const QString &propertyName) const - - Returns the tracking mode of \a propertyName. -*/ - -/*! - \fn Qt3DCore::QNode::setPropertyTracking(const QString &propertyName, Qt3DCore::QNode::PropertyTrackingMode trackMode) - - Sets the property tracking for \a propertyName and \a trackMode. -*/ - -/*! Creates a new QNode instance with parent \a parent. \note The backend aspects will be notified that a QNode instance is @@ -839,45 +809,6 @@ bool QNode::isEnabled() const return d->m_enabled; } -/*! - \fn Qt3DCore::QNodeCommand::CommandId Qt3DCore::QNodeCommand::inReplyTo() const - - Returns the id of the original QNodeCommand message that - was sent to the backend. - -*/ -/*! - \fn void Qt3DCore::QNodeCommand::setData(const QVariant &data) - - Sets the data (\a data) in the backend node to perform - the operations requested. -*/ -/*! - \fn void Qt3DCore::QNodeCommand::setName(const QString &name) - - - Sets the data (\a name) in the backend node to perform - the operations requested. -*/ - -/*! - \enum Qt3DCore::QNode::PropertyTrackingMode - - Indicates how a QNode listens for property updates. - - \value TrackFinalValues - Tracks final values - \value DontTrackValues - Does not track values - \value TrackAllValues - Tracks all values -*/ -/*! - \fn Qt3DCore::QNode::clearPropertyTrackings() - - Erases all values that have been saved by the property tracking. -*/ - namespace { /*! \internal */ diff --git a/src/core/nodes/qnodeid.cpp b/src/core/nodes/qnodeid.cpp index 2e4d10374..459c41654 100644 --- a/src/core/nodes/qnodeid.cpp +++ b/src/core/nodes/qnodeid.cpp @@ -93,7 +93,7 @@ namespace Qt3DCore { */ /*! - * \fn uint Qt3DCore::qHash(QNodeId id, uint seed = 0) + * \fn [nodeid-qhash] constexpr size_t Qt3DCore::qHash(QNodeId id, uint seed) * \relates Qt3DCore::QNodeId * \return hash of node with \a id and optional \a seed. */ diff --git a/src/core/nodes/qnodeid.h b/src/core/nodes/qnodeid.h index a51ce684f..487cbcab1 100644 --- a/src/core/nodes/qnodeid.h +++ b/src/core/nodes/qnodeid.h @@ -106,6 +106,7 @@ using QNodeIdVector = QList<QNodeId>; Q_3DCORESHARED_EXPORT QDebug operator<<(QDebug d, QNodeId id); #endif +//! [nodeid-qhash] inline constexpr size_t qHash(QNodeId id, size_t seed = 0) noexcept { using QT_PREPEND_NAMESPACE(qHash); diff --git a/src/doc/Qt3DDoc b/src/doc/Qt3DDoc index 496730dd4..d2292cab4 100644 --- a/src/doc/Qt3DDoc +++ b/src/doc/Qt3DDoc @@ -16,6 +16,7 @@ #include "../core/transforms/matrix4x4_p.h" #include "../core/transforms/vector3d_p.h" #include "../render/raycasting/qray3d_p.h" +#include "../render/texture/qtexturegenerator_p.h" #include "../input/frontend/qabstractphysicaldeviceproxy_p.h" #include "../input/frontend/qinputdeviceintegration_p.h" #include "../animation/frontend/qchannelmappingcreatedchange_p.h" diff --git a/src/doc/qt3d.qdocconf b/src/doc/qt3d.qdocconf index ded8fea7a..aa6be3c33 100644 --- a/src/doc/qt3d.qdocconf +++ b/src/doc/qt3d.qdocconf @@ -62,7 +62,6 @@ excludefiles += "*_p.h" headers = ../core/transforms/matrix4x4_p.h \ ../core/transforms/vector3d_p.h \ ../render/raycasting/qray3d_p.h \ - ../animation/frontend/qchannelmappingcreatedchange_p.h \ ../input/frontend/qabstractphysicaldeviceproxy_p.h \ ../input/frontend/qinputdeviceintegration_p.h \ ../quick3d/imports/scene3d/scene3ditem_p.h diff --git a/src/doc/src/qt3d-overview.qdoc b/src/doc/src/qt3d-overview.qdoc index aaf246203..23ed83dcd 100644 --- a/src/doc/src/qt3d-overview.qdoc +++ b/src/doc/src/qt3d-overview.qdoc @@ -89,9 +89,8 @@ vertex, tessellation control, tessellation evaluation, geometry, and fragment shaders. Compute shaders are planned for a future release. - For examples of using shaders, see the \l {Simple Shader Example}, - \l {Qt 3D: Shadow Map QML Example}, \l{Qt 3D: Wireframe QML Example}, and - \l {Qt 3D: Wave QML Example}. + For examples of using shaders, see the \l {Qt 3D: Shadow Map QML Example}, + \l{Qt 3D: Wireframe QML Example}, and \l {Qt 3D: Wave QML Example}. \section2 Shadow Mapping diff --git a/src/doc/src/qt3drender-module.qdoc b/src/doc/src/qt3drender-module.qdoc index aa73c167a..b11ba3dad 100644 --- a/src/doc/src/qt3drender-module.qdoc +++ b/src/doc/src/qt3drender-module.qdoc @@ -160,6 +160,6 @@ If not specified, RHI will default to what it deduces to be the best backend for the platform. - Alternatively, if using a QQuickWindow, \l [QQuickWindow::setGraphicsApi()] + Alternatively, if using a QQuickWindow, QQuickWindow::setGraphicsApi() can be used to specify the RHI internal rendering backend. */ diff --git a/src/doc/src/qt6-changes.qdoc b/src/doc/src/qt6-changes.qdoc index 04c9d6c57..904a510e4 100644 --- a/src/doc/src/qt6-changes.qdoc +++ b/src/doc/src/qt6-changes.qdoc @@ -65,7 +65,7 @@ the size of the axis aligned bounding box of a geometry \li \l {Qt3DRender::QPickingProxy} provides a way of specifying an alternative (usually simpler) geometry for picking - \li \l {Qt3DCore::QAbstractAspect} and \l {Qt3DCore::QAspectJobs} add methods + \li \l {Qt3DCore::QAbstractAspect} and \l {Qt3DCore::QAspectJob} add methods to facilitate and optimize the synchronization of backend operations. \endlist */ diff --git a/src/extras/geometries/qcylindergeometryview.cpp b/src/extras/geometries/qcylindergeometryview.cpp index 3a0fbfd81..9347f1134 100644 --- a/src/extras/geometries/qcylindergeometryview.cpp +++ b/src/extras/geometries/qcylindergeometryview.cpp @@ -65,25 +65,25 @@ namespace Qt3DExtras { */ /*! - * \qmlproperty int CylinderMesh::rings + * \qmlproperty int CylinderGeometryView::rings * * Holds the number of rings in the mesh. */ /*! - * \qmlproperty int CylinderMesh::slices + * \qmlproperty int CylinderGeometryView::slices * * Holds the number of slices in the mesh. */ /*! - * \qmlproperty real CylinderMesh::radius + * \qmlproperty real CylinderGeometryView::radius * * Holds the radius of the cylinder. */ /*! - * \qmlproperty real CylinderMesh::length + * \qmlproperty real CylinderGeometryView::length * * Holds the length of the cylinder. */ diff --git a/src/render/frontend/qrendercapabilities.cpp b/src/render/frontend/qrendercapabilities.cpp index 392f68cb1..afe5d04a8 100644 --- a/src/render/frontend/qrendercapabilities.cpp +++ b/src/render/frontend/qrendercapabilities.cpp @@ -106,6 +106,7 @@ namespace Qt3DRender { /*! \class Qt3DRender::QRenderCapabilities + \inmodule Qt3DRender \brief The QRenderCapabilities class holds settings related to available rendering engines. QRenderCapabilities provides details of graphical features that are available at runtime. @@ -117,7 +118,7 @@ on whether compute shaders are available or not. /*! \qmltype RenderCapabilities - \brief The QRenderCapabilities class holds settings related to available rendering engines + \brief The QRenderCapabilities class holds settings related to available rendering engines. \since 5.15 \inqmlmodule Qt3D.Render \instantiates Qt3DRender::QRenderCapabilities diff --git a/src/render/materialsystem/qgraphicsapifilter.cpp b/src/render/materialsystem/qgraphicsapifilter.cpp index e8b93de6e..ae85af6b2 100644 --- a/src/render/materialsystem/qgraphicsapifilter.cpp +++ b/src/render/materialsystem/qgraphicsapifilter.cpp @@ -170,7 +170,7 @@ QGraphicsApiFilter::~QGraphicsApiFilter() \value OpenGL QSurfaceFormat::OpenGL \value Vulkan Vulkan \value DirectX DirectX - + \value RHI RHI */ /*! diff --git a/src/render/picking/qpicktriangleevent.cpp b/src/render/picking/qpicktriangleevent.cpp index c077d412f..b33c7c0dd 100644 --- a/src/render/picking/qpicktriangleevent.cpp +++ b/src/render/picking/qpicktriangleevent.cpp @@ -97,7 +97,7 @@ QPickTriangleEvent *QPickTriangleEventPrivate::clone() const \note In the case of indexed rendering, the point indices are relative to the array of coordinates, not the array of indices. - \sa QPickingSettings, QPickEvent, QObjectPicker, QAttribute + \sa QPickingSettings, QPickEvent, QObjectPicker \since 5.7 */ diff --git a/src/render/texture/qabstracttexture.cpp b/src/render/texture/qabstracttexture.cpp index 0e8abe090..506627105 100644 --- a/src/render/texture/qabstracttexture.cpp +++ b/src/render/texture/qabstracttexture.cpp @@ -614,11 +614,6 @@ int QAbstractTexture::samples() const Holds the mipmap levels of the texture provider. */ -/*! - \qmlproperty int Qt3DRender::QAbstractTexture::format - - Holds the mipmap levels of the texture provider. - */ int QAbstractTexture::mipLevels() const { Q_D(const QAbstractTexture); diff --git a/src/render/texture/qtextureimagedata.cpp b/src/render/texture/qtextureimagedata.cpp index 37401ea4a..6661db678 100644 --- a/src/render/texture/qtextureimagedata.cpp +++ b/src/render/texture/qtextureimagedata.cpp @@ -330,8 +330,7 @@ void QTextureImageData::setFaces(int faces) noexcept } /*! - * Sets the alignment requirements for the image - * \param alignment + * Sets the \a alignment requirements for the image. */ void QTextureImageData::setAlignment(int alignment) noexcept { @@ -340,7 +339,7 @@ void QTextureImageData::setAlignment(int alignment) noexcept } /*! - \return the alignment requirement for the image + \return the alignment requirement for the image. */ int QTextureImageData::alignment() const noexcept { @@ -349,7 +348,7 @@ int QTextureImageData::alignment() const noexcept } /*! - \return the target for the stored texture + \return the target for the stored texture. */ QOpenGLTexture::Target QTextureImageData::target() const noexcept { @@ -358,7 +357,7 @@ QOpenGLTexture::Target QTextureImageData::target() const noexcept } /*! - \return the format of the stored texture + \return the format of the stored texture. */ QOpenGLTexture::TextureFormat QTextureImageData::format() const noexcept { @@ -368,7 +367,6 @@ QOpenGLTexture::TextureFormat QTextureImageData::format() const noexcept /*! * Sets the target to \a target. - * \param target */ void QTextureImageData::setTarget(QOpenGLTexture::Target target) noexcept { @@ -378,7 +376,6 @@ void QTextureImageData::setTarget(QOpenGLTexture::Target target) noexcept /*! * Sets the format to \a format. - * \param */ void QTextureImageData::setFormat(QOpenGLTexture::TextureFormat format) noexcept { @@ -388,7 +385,6 @@ void QTextureImageData::setFormat(QOpenGLTexture::TextureFormat format) noexcept /*! * Sets the pixel format to \a pixelFormat. - * \param setPixelFormat */ void QTextureImageData::setPixelFormat(QOpenGLTexture::PixelFormat pixelFormat) noexcept { @@ -397,8 +393,7 @@ void QTextureImageData::setPixelFormat(QOpenGLTexture::PixelFormat pixelFormat) } /*! - * Sets the pixel type to \a pixelType - * \param setPixelType + * Sets the pixel type to \a pixelType. */ void QTextureImageData::setPixelType(QOpenGLTexture::PixelType pixelType) noexcept { @@ -407,7 +402,7 @@ void QTextureImageData::setPixelType(QOpenGLTexture::PixelType pixelType) noexce } /*! - Copies the image \a image as raw data within this object + Copies the image \a image as raw data within this object. */ void QTextureImageData::setImage(const QImage &image) { @@ -431,7 +426,7 @@ void QTextureImageData::setImage(const QImage &image) } /*! - Store the data \a data with blocksize \a blockSize and if the data to be stored is compressed \a isCompressed + Stores the data \a data with blocksize \a blockSize and if the data to be stored is compressed \a isCompressed. */ void QTextureImageData::setData(const QByteArray &data, int blockSize, bool isCompressed) { @@ -446,7 +441,7 @@ void QTextureImageData::setData(const QByteArray &data, std::function<QByteArray } /*! - \return the raw image data for the texture at layer \a layer, face \a face and mipmapLevel \a mipmapLevel + \return the raw image data for the texture at layer \a layer, face \a face and mipmapLevel \a mipmapLevel. */ QByteArray QTextureImageData::data(int layer, int face, int mipmapLevel) const { @@ -455,7 +450,7 @@ QByteArray QTextureImageData::data(int layer, int face, int mipmapLevel) const } /*! - \return the pixel format of the stored texture + \return the pixel format of the stored texture. */ QOpenGLTexture::PixelFormat QTextureImageData::pixelFormat() const noexcept { @@ -464,7 +459,7 @@ QOpenGLTexture::PixelFormat QTextureImageData::pixelFormat() const noexcept } /*! - \return the pixel type of the stored texture + \return the pixel type of the stored texture. */ QOpenGLTexture::PixelType QTextureImageData::pixelType() const noexcept { |