diff options
| author | Miikka Heikkinen <miikka.heikkinen@qt.io> | 2016-09-01 12:50:40 +0300 |
|---|---|---|
| committer | Paul Lemire <paul.lemire@kdab.com> | 2016-09-02 06:15:46 +0000 |
| commit | 78e8f5ac9ace0701682723551cd2a70f47967168 (patch) | |
| tree | d7d73c9d2c0a812f6f41c3b11b0dcffd6440cac5 /src/extras/geometries/qtorusgeometry.cpp | |
| parent | ce1db34bf273c397bb7b4be182f274547c35ea3e (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/qtorusgeometry.cpp')
| -rw-r--r-- | src/extras/geometries/qtorusgeometry.cpp | 27 |
1 files changed, 18 insertions, 9 deletions
diff --git a/src/extras/geometries/qtorusgeometry.cpp b/src/extras/geometries/qtorusgeometry.cpp index 5ca8c3ce1..09a69a45a 100644 --- a/src/extras/geometries/qtorusgeometry.cpp +++ b/src/extras/geometries/qtorusgeometry.cpp @@ -264,8 +264,12 @@ void QTorusGeometryPrivate::init() /*! * \qmltype TorusGeometry - * \instantiates Qt3DRender::QTorusGeometry - * \inqmlmodule Qt3D.Render + * \instantiates Qt3DExtras::QTorusGeometry + * \inqmlmodule Qt3D.Extras + * \brief TorusGeometry allows creation of a torus in 3D space. + * + * The TorusGeometry type is most commonly used internally by the TorusMesh type + * but can also be used in custom GeometryRenderer types. */ /*! @@ -281,13 +285,13 @@ void QTorusGeometryPrivate::init() */ /*! - * \qmlproperty float TorusGeometry::radius + * \qmlproperty real TorusGeometry::radius * * Holds the outer radius of the torus. */ /*! - * \qmlproperty float TorusGeometry::minorRadius + * \qmlproperty real TorusGeometry::minorRadius * * Holds the inner radius of the torus. */ @@ -317,10 +321,15 @@ void QTorusGeometryPrivate::init() */ /*! - * \class Qt3DRender::QTorusGeometry - * \inmodule Qt3DRender - * + * \class Qt3DExtras::QTorusGeometry + * \inmodule Qt3DExtras + * \brief The QTorusGeometry class allows creation of a torus in 3D space. + * \since 5.7 + * \ingroup geometries * \inherits Qt3DRender::QGeometry + * + * The QTorusGeometry class is most commonly used internally by the QTorusMesh + * but can also be used in custom Qt3DRender::QGeometryRenderer subclasses. */ /*! @@ -351,7 +360,7 @@ QTorusGeometry::~QTorusGeometry() } /*! - * Updates vertices based on rings and slices. + * Updates vertices based on rings, slices, and radius properties. */ void QTorusGeometry::updateVertices() { @@ -364,7 +373,7 @@ void QTorusGeometry::updateVertices() } /*! - * Updates indices based on rings and slices. + * Updates indices based on rings and slices properties. */ void QTorusGeometry::updateIndices() { |