diff options
author | Topi Reinio <topi.reinio@qt.io> | 2020-11-25 12:23:16 +0100 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@qt.io> | 2020-11-25 21:05:43 +0000 |
commit | 2687a8b3c0428f0da71bef05324dfbdd3581fc20 (patch) | |
tree | 3df51673136b9213aaa5aa776e7c9279e4920645 /src/render | |
parent | 5457ad2a0a58157c2ba7aa77c73d4b22883e4d0b (diff) |
Doc: Fix documentation warnings
Pick-to: 6.0 6.0.0
Fixes: QTBUG-88842
Change-Id: Ie8ea1914c5e740c0c4bf25f4754a008aff6401cd
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/render')
-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 |
5 files changed, 14 insertions, 23 deletions
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 { |