summaryrefslogtreecommitdiffstats
path: root/src/extras/geometries/qspheremesh.cpp
diff options
context:
space:
mode:
authorMiikka Heikkinen <miikka.heikkinen@qt.io>2016-09-01 12:50:40 +0300
committerPaul Lemire <paul.lemire@kdab.com>2016-09-02 06:15:46 +0000
commit78e8f5ac9ace0701682723551cd2a70f47967168 (patch)
treed7d73c9d2c0a812f6f41c3b11b0dcffd6440cac5 /src/extras/geometries/qspheremesh.cpp
parentce1db34bf273c397bb7b4be182f274547c35ea3e (diff)
Update mesh and geometry documentation
Meshes and geometries that were moved to Qt3DExtras were still part of Qt3DRender according to the documentation. Also added some missing documentation and a few clarifications. Change-Id: I62216d718758b9f6b82df2ccc060b3c1e91b9ad4 Reviewed-by: Paul Lemire <paul.lemire@kdab.com> Reviewed-by: Antti Määttä <antti.maatta@qt.io>
Diffstat (limited to 'src/extras/geometries/qspheremesh.cpp')
-rw-r--r--src/extras/geometries/qspheremesh.cpp16
1 files changed, 9 insertions, 7 deletions
diff --git a/src/extras/geometries/qspheremesh.cpp b/src/extras/geometries/qspheremesh.cpp
index 205f6437f..90cf5a872 100644
--- a/src/extras/geometries/qspheremesh.cpp
+++ b/src/extras/geometries/qspheremesh.cpp
@@ -47,8 +47,8 @@ namespace Qt3DExtras {
/*!
* \qmltype SphereMesh
- * \instantiates Qt3DRender::QSphereMesh
- * \inqmlmodule Qt3D.Render
+ * \instantiates Qt3DExtras::QSphereMesh
+ * \inqmlmodule Qt3D.Extras
* \brief A spherical mesh.
*/
@@ -65,7 +65,7 @@ namespace Qt3DExtras {
*/
/*!
- * \qmlproperty float SphereMesh::radius
+ * \qmlproperty real SphereMesh::radius
*
* Holds the radius of the sphere.
*/
@@ -73,12 +73,13 @@ namespace Qt3DExtras {
/*!
* \qmlproperty bool SphereMesh::generateTangents
*
- * Holds the value of the automatic tangent generation flag.
+ * Holds the value of the automatic tangent vectors generation flag.
+ * Tangent vectors are orthogonal to normal vectors.
*/
/*!
- * \class Qt3DRender::QSphereMesh
- * \inmodule Qt3DRender
+ * \class Qt3DExtras::QSphereMesh
+ * \inmodule Qt3DExtras
*
* \inherits Qt3DRender::QGeometryRenderer
*
@@ -127,7 +128,8 @@ void QSphereMesh::setGenerateTangents(bool gen)
/*!
* \property QSphereMesh::generateTangents
*
- * Holds the value of the automatic tangent generation flag.
+ * Holds the value of the automatic tangent vectors generation flag.
+ * Tangent vectors are orthogonal to normal vectors.
*/
bool QSphereMesh::generateTangents() const
{