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/materialsystem | |
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/materialsystem')
-rw-r--r-- | src/render/materialsystem/qshaderimage.cpp | 25 |
1 files changed, 16 insertions, 9 deletions
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. */ /*! |