summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAntti Määttä <antti.maatta@qt.io>2016-09-02 14:56:36 +0300
committerAntti Määttä <antti.maatta@qt.io>2016-09-05 08:50:42 +0000
commitd804e3026c7e1517ee2dffdabaa7ed31c5d8e629 (patch)
tree43fec3c5858a2e2218f69161f90f2f9b23cafdc8
parent62870fd336b04e210d1ac5b7a8e5d653c04512c2 (diff)
Update QCameraSelector docs
Change-Id: I349f40e488465a147970f1d52696cf1fa9e22063 Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io> Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
-rw-r--r--src/render/framegraph/qcameraselector.cpp38
1 files changed, 24 insertions, 14 deletions
diff --git a/src/render/framegraph/qcameraselector.cpp b/src/render/framegraph/qcameraselector.cpp
index a9188cd99..c7d299b9b 100644
--- a/src/render/framegraph/qcameraselector.cpp
+++ b/src/render/framegraph/qcameraselector.cpp
@@ -48,13 +48,15 @@ QT_BEGIN_NAMESPACE
namespace Qt3DRender {
/*!
- \class Qt3DRender::QCameraSelector
- \inmodule Qt3DRender
- \since 5.5
- \ingroup framegraph
+ \class Qt3DRender::QCameraSelector
+ \inmodule Qt3DRender
+ \since 5.5
+ \ingroup framegraph
- \brief Class to allow for selection of camera to be used
+ \brief Class to allow for selection of camera to be used
+ A Qt3DRender::QCameraSelector can be used to select the camera, which is used
+ by the FrameGraph when drawing the entities.
*/
/*!
@@ -63,9 +65,25 @@ namespace Qt3DRender {
\instantiates Qt3DRender::QCameraSelector
\inherits FrameGraphNode
\since 5.5
- \qmlabstract
+ \brief Class to allow for selection of camera to be used
+
+ A CameraSelector can be used to select the camera, which is used
+ by the FrameGraph when drawing the entities.
+*/
+
+/*!
+ \qmlproperty Entity Qt3D.Render::CameraSelector::camera
+
+ Holds the currently selected camera.
*/
+/*!
+ \property Qt3DRender::QCameraSelector::camera
+
+ Holds the currently selected camera.
+*/
+
+
/*! \internal */
QCameraSelector::QCameraSelector(QCameraSelectorPrivate &dd, QNode *parent)
: QFrameGraphNode(dd, parent)
@@ -91,14 +109,6 @@ QCameraSelector::~QCameraSelector()
{
}
-/*!
- \property Qt3DRender::QCameraSelector::camera
-*/
-
-/*!
- \qmlproperty Entity Qt3D.Render::CameraSelector::camera
-
-*/
void QCameraSelector::setCamera(Qt3DCore::QEntity *camera)
{
Q_D(QCameraSelector);