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/render/texture | |
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/render/texture')
-rw-r--r-- | src/render/texture/qabstracttexture.cpp | 16 | ||||
-rw-r--r-- | src/render/texture/qabstracttextureimage.cpp | 4 | ||||
-rw-r--r-- | src/render/texture/qtexturegenerator.cpp | 3 |
3 files changed, 12 insertions, 11 deletions
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. */ |