diff options
| author | Martin Smith <martin.smith@qt.io> | 2018-02-13 11:05:22 +0100 |
|---|---|---|
| committer | Martin Smith <martin.smith@qt.io> | 2018-02-14 07:45:23 +0000 |
| commit | 874cd47ae427e6f08a6e362f28af5038a2bc9872 (patch) | |
| tree | aa5dade6dd422c58a434681d12f9630339eec87c /src/quick/scenegraph/util | |
| parent | b704faaa45d3e3ca8bc7ce11aeb1e533a9563a0f (diff) | |
doc: Add documentation for undocumented things
There were several undocumented elements in the API that clang-qdoc
warned about. These are now documented, although original authors
might want to contribute better descriptions. A few uses of a macro
"qdoc" were corrected to Q_CLANG_QDOC.
Change-Id: I4e1d4c5f3266a334d7286e55ed1b113319de2273
Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
Diffstat (limited to 'src/quick/scenegraph/util')
| -rw-r--r-- | src/quick/scenegraph/util/qsgimagenode.cpp | 11 | ||||
| -rw-r--r-- | src/quick/scenegraph/util/qsgsimplematerial.h | 2 | ||||
| -rw-r--r-- | src/quick/scenegraph/util/qsgtexturematerial.cpp | 10 |
3 files changed, 21 insertions, 2 deletions
diff --git a/src/quick/scenegraph/util/qsgimagenode.cpp b/src/quick/scenegraph/util/qsgimagenode.cpp index c03c91d1cb..b154023247 100644 --- a/src/quick/scenegraph/util/qsgimagenode.cpp +++ b/src/quick/scenegraph/util/qsgimagenode.cpp @@ -168,7 +168,7 @@ QT_BEGIN_NAMESPACE */ /*! - \fn QSGImageNode::TextureCoordinatesTransformMode textureCoordinatesTransform() const + \fn QSGImageNode::TextureCoordinatesTransformMode QSGImageNode::textureCoordinatesTransform() const Returns the mode used to generate texture coordinates for this node. */ @@ -187,6 +187,15 @@ QT_BEGIN_NAMESPACE \return \c true if the node takes ownership of the texture; otherwise \c false. */ +/*! + Updates the geometry \a g with the \a texture, the coordinates + in \a rect, and the texture coordinates from \a sourceRect. + + \a g is assumed to be a triangle strip of four vertices of type + QSGGeometry::TexturedPoint2D. + + \a texCoordMode is used for normalizing the \a sourceRect. + */ void QSGImageNode::rebuildGeometry(QSGGeometry *g, QSGTexture *texture, const QRectF &rect, diff --git a/src/quick/scenegraph/util/qsgsimplematerial.h b/src/quick/scenegraph/util/qsgsimplematerial.h index b5b8815b4a..8a81917bd2 100644 --- a/src/quick/scenegraph/util/qsgsimplematerial.h +++ b/src/quick/scenegraph/util/qsgsimplematerial.h @@ -138,7 +138,7 @@ template <typename State> class QSGSimpleMaterial : public QSGMaterial { public: -#ifndef qdoc +#ifndef Q_CLANG_QDOC QSGSimpleMaterial(const State &aState, PtrShaderCreateFunc func) : m_state(aState) , m_func(func) diff --git a/src/quick/scenegraph/util/qsgtexturematerial.cpp b/src/quick/scenegraph/util/qsgtexturematerial.cpp index fbc8f27a63..0f9ee9cfde 100644 --- a/src/quick/scenegraph/util/qsgtexturematerial.cpp +++ b/src/quick/scenegraph/util/qsgtexturematerial.cpp @@ -304,7 +304,17 @@ void QSGOpaqueTextureMaterial::setTexture(QSGTexture *texture) The default vertical wrap mode is \c QSGTexture::ClampToEdge. */ +/*! + \fn void QSGOpaqueTextureMaterial::setAnisotropyLevel(QSGTexture::AnisotropyLevel level) + + Sets this material's anistropy level to \a level. +*/ + +/*! + \fn QSGTexture::AnisotropyLevel QSGOpaqueTextureMaterial::anisotropyLevel() const + Returns this material's anistropy level. +*/ /*! \internal |