Doc: Add Qt3D QML module and QML type documentation skeletonv5.5.0-beta1

Add documentation structure and comment blocks containing \qmltype,
\qmlproperty, etc. commands for Qt3D QML module.

The actual documentation (descriptions) are still missing, but this
allows the QML type documentation to be generated.

Change-Id: Id0e1afc89c13d963c950c142a3407aa70702562f
Reviewed-by: Paul Lemire <paul.lemire@kdab.com>

14 files changed, 268 insertions, 21 deletions

diff --git a/src/core/core-components/qcamera.cpp b/src/core/core-components/qcamera.cpp
index 6fc43273a..2737daaa0 100644
--- a/src/core/core-components/qcamera.cpp
+++ b/src/core/core-components/qcamera.cpp
@@ -53,6 +53,14 @@ QCameraPrivate::QCameraPrivate(QCamera *qq)
 {
 }
 
+/*!
+    \qmltype Camera
+    \instantiates Qt3D::QCamera
+    \inherits Entity
+    \inqmlmodule Qt3D
+    \since 5.5
+*/
+
 QCamera::QCamera(QNode *parent) :
     QEntity(*new QCameraPrivate(this), parent)
 {
@@ -240,6 +248,15 @@ void QCamera::setProjectionType(QCameraLens::ProjectionType type)
     d->m_lens->setProjectionType(type);
 }
 
+/*!
+    \qmlproperty enumeration Qt3D::Camera::projectionType
+
+    Holds the type of the camera projection (orthogonal or perspective).
+
+    \value CameraLens.OrthogonalProjection Orthogonal projection
+    \value CameraLens.PerspectiveProjection Perspective projection
+*/
+
 QCameraLens::ProjectionType QCamera::projectionType() const
 {
     Q_D(const QCamera);
@@ -252,6 +269,10 @@ void QCamera::setNearPlane(float nearPlane)
     d->m_lens->setNearPlane(nearPlane);
 }
 
+/*!
+    \qmlproperty float Qt3D::Camera::nearPlane
+*/
+
 float QCamera::nearPlane() const
 {
     Q_D(const QCamera);
@@ -264,6 +285,10 @@ void QCamera::setFarPlane(float farPlane)
     d->m_lens->setFarPlane(farPlane);
 }
 
+/*!
+    \qmlproperty float Qt3D::Camera::farPlane
+*/
+
 float QCamera::farPlane() const
 {
     Q_D(const QCamera);
@@ -276,6 +301,10 @@ void QCamera::setFieldOfView(float fieldOfView)
     d->m_lens->setFieldOfView(fieldOfView);
 }
 
+/*!
+    \qmlproperty float Qt3D::Camera::fieldOfView
+*/
+
 float QCamera::fieldOfView() const
 {
     Q_D(const QCamera);
@@ -288,6 +317,10 @@ void QCamera::setAspectRatio(float aspectRatio)
     d->m_lens->setAspectRatio(aspectRatio);
 }
 
+/*!
+    \qmlproperty float Qt3D::Camera::aspectRatio
+*/
+
 float QCamera::aspectRatio() const
 {
     Q_D(const QCamera);
@@ -300,6 +333,10 @@ void QCamera::setLeft(float left)
     d->m_lens->setLeft(left);
 }
 
+/*!
+    \qmlproperty float Qt3D::Camera::left
+*/
+
 float QCamera::left() const
 {
     Q_D(const QCamera);
@@ -312,6 +349,10 @@ void QCamera::setRight(float right)
     d->m_lens->setRight(right);
 }
 
+/*!
+    \qmlproperty float Qt3D::Camera::right
+*/
+
 float QCamera::right() const
 {
     Q_D(const QCamera);
@@ -324,6 +365,10 @@ void QCamera::setBottom(float bottom)
     d->m_lens->setBottom(bottom);
 }
 
+/*!
+    \qmlproperty float Qt3D::Camera::bottom
+*/
+
 float QCamera::bottom() const
 {
     Q_D(const QCamera);
@@ -336,12 +381,21 @@ void QCamera::setTop(float top)
     d->m_lens->setTop(top);
 }
 
+/*!
+    \qmlproperty float Qt3D::Camera::top
+*/
+
 float QCamera::top() const
 {
     Q_D(const QCamera);
     return d->m_lens->top();
 }
 
+/*!
+    \qmlproperty matrix4x4 Qt3D::Camera::projectionMatrix
+    \readonly
+*/
+
 QMatrix4x4 QCamera::projectionMatrix() const
 {
     Q_D(const QCamera);
@@ -354,6 +408,10 @@ void QCamera::setPosition(const QVector3D &position)
     d->m_lookAt->setPosition(position);
 }
 
+/*!
+    \qmlproperty vector3d Qt3D::Camera::position
+*/
+
 QVector3D QCamera::position() const
 {
     Q_D(const QCamera);
@@ -367,6 +425,10 @@ void QCamera::setUpVector(const QVector3D &upVector)
     d->m_lookAt->setUpVector(upVector);
 }
 
+/*!
+    \qmlproperty vector3d Qt3D::Camera::upVector
+*/
+
 QVector3D QCamera::upVector() const
 {
     Q_D(const QCamera);
@@ -379,6 +441,10 @@ void QCamera::setViewCenter(const QVector3D &viewCenter)
     d->m_lookAt->setViewCenter(viewCenter);
 }
 
+/*!
+    \qmlproperty vector3d Qt3D::Camera::viewCenter
+*/
+
 QVector3D QCamera::viewCenter() const
 {
     Q_D(const QCamera);
diff --git a/src/core/core-components/qcameralens.cpp b/src/core/core-components/qcameralens.cpp
index 0d5f6ea49..fde9d16ad 100644
--- a/src/core/core-components/qcameralens.cpp
+++ b/src/core/core-components/qcameralens.cpp
@@ -274,4 +274,58 @@ QMatrix4x4 QCameraLens::projectionMatrix() const
 
 } // Qt3D
 
+/*!
+    \qmltype CameraLens
+    \instantiates Qt3D::QCameraLens
+    \inqmlmodule Qt3D
+    \inherits Component3D
+    \since 5.5
+*/
+
+/*!
+    \qmlproperty enumeration Qt3D::CameraLens::projectionType
+
+    Holds the type of the camera projection (orthogonal or perspective).
+
+    \value CameraLens.OrthogonalProjection Orthogonal projection
+    \value CameraLens.PerspectiveProjection Perspective projection
+*/
+
+/*!
+    \qmlproperty float Qt3D::CameraLens::nearPlane
+*/
+
+/*!
+    \qmlproperty float Qt3D::CameraLens::farPlane
+*/
+
+/*!
+    \qmlproperty float Qt3D::CameraLens::fieldOfView
+*/
+
+/*!
+    \qmlproperty float Qt3D::CameraLens::aspectRatio
+*/
+
+/*!
+    \qmlproperty float Qt3D::CameraLens::left
+*/
+
+/*!
+    \qmlproperty float Qt3D::CameraLens::right
+*/
+
+/*!
+    \qmlproperty float Qt3D::CameraLens::bottom
+*/
+
+/*!
+    \qmlproperty float Qt3D::CameraLens::top
+*/
+
+/*!
+    \qmlproperty matrix4x4 Qt3D::CameraLens::projectionMatrix
+    \readonly
+*/
+
 QT_END_NAMESPACE
diff --git a/src/core/doc/qt3dcore.qdocconf b/src/core/doc/qt3dcore.qdocconf
index 02907b173..db2848ae8 100644
--- a/src/core/doc/qt3dcore.qdocconf
+++ b/src/core/doc/qt3dcore.qdocconf
@@ -18,20 +18,30 @@ qhp.Qt3DCore.filterAttributes                   = qt3dcore $QT_VERSION qtrefdoc
 qhp.Qt3DCore.customFilters.Qt.name              = Qt3DCore $QT_VERSION
 qhp.Qt3DCore.customFilters.Qt.filterAttributes  = qt3dcore $QT_VERSION
 
-qhp.Qt3DCore.subprojects                    = classes
+qhp.Qt3DCore.subprojects                    = classes qmltypes
+
 qhp.Qt3DCore.subprojects.classes.title      = C++ Classes
 qhp.Qt3DCore.subprojects.classes.indexTitle = Qt3D Core C++ Classes
 qhp.Qt3DCore.subprojects.classes.selectors  = class fake:headerfile
 qhp.Qt3DCore.subprojects.classes.sortPages  = true
 
+qhp.Qt3DCore.subprojects.qmltypes.title      = QML Types
+qhp.Qt3DCore.subprojects.qmltypes.indexTitle = Qt3D Core QML Types
+qhp.Qt3DCore.subprojects.qmltypes.selectors  = qmlclass
+qhp.Qt3DCore.subprojects.qmltypes.sortPages  = true
+
 tagfile                 = ../../../doc/qt3dcore/qt3dcore.tags
 
 depends                 += qtcore qtqml qtquick qtdoc qt3drender
 
 headerdirs += .. \
-              ../../plugins
+              ../../plugins \
+              ../../quick3d/quick3d
+
 sourcedirs += .. \
-              ../../plugins
+              ../../plugins \
+              ../../quick3d/quick3d
+
 exampledirs += src/snippets
 
 #excludedirs +=
@@ -45,3 +55,4 @@ Cpp.ignoredirectives += Q_DECLARE_LOGGING_CATEGORY
 
 navigation.landingpage = "Qt3D Core"
 navigation.cppclassespage = "Qt3D Core C++ Classes"
+navigation.qmltypespage = "Qt3D Core QML Types"
diff --git a/src/core/doc/src/qt3dcore-index.qdoc b/src/core/doc/src/qt3dcore-index.qdoc
index 184068337..b2908264b 100644
--- a/src/core/doc/src/qt3dcore-index.qdoc
+++ b/src/core/doc/src/qt3dcore-index.qdoc
@@ -58,6 +58,7 @@
 
     \list
        \li \l {Qt3D Core C++ Classes}
+       \li \l {Qt3D Core QML Types}
        \li \l {Qt3D Examples}
     \endlist
 
diff --git a/src/core/doc/src/qt3dcore-module.qdoc b/src/core/doc/src/qt3dcore-module.qdoc
index 453152d85..d664b8bf6 100644
--- a/src/core/doc/src/qt3dcore-module.qdoc
+++ b/src/core/doc/src/qt3dcore-module.qdoc
@@ -54,3 +54,17 @@
     framework, as well as classes that provide the ability to render using the Qt3D
     framework.
 */
+
+/*!
+   \qmlmodule Qt3D 2.0
+   \title Qt3D Core QML Types
+   \ingroup qmlmodules
+
+   \brief Provides core Qt3D QML types.
+
+   To import and use the module's QML types, use the following statement:
+
+   \badcode
+   import Qt3D 2.0
+   \endcode
+*/
diff --git a/src/core/nodes/qcomponent.cpp b/src/core/nodes/qcomponent.cpp
index 7cd68dc73..52fa77905 100644
--- a/src/core/nodes/qcomponent.cpp
+++ b/src/core/nodes/qcomponent.cpp
@@ -195,4 +195,20 @@ QComponent::QComponent(QComponentPrivate &dd, QNode *parent)
 
 } // namespace Qt3D
 
+/*!
+    \qmltype Component3D
+    \instantiates Qt3D::QComponent
+    \inqmlmodule Qt3D
+    \inherits Node
+    \since 5.5
+*/
+
+/*!
+    \qmlproperty bool Qt3D::Component3D::shareable
+*/
+
+/*!
+    \qmlproperty bool Qt3D::Component3D::enabled
+*/
+
 QT_END_NAMESPACE
diff --git a/src/core/transforms/qmatrixtransform.cpp b/src/core/transforms/qmatrixtransform.cpp
index 706a183f1..298b85c1a 100644
--- a/src/core/transforms/qmatrixtransform.cpp
+++ b/src/core/transforms/qmatrixtransform.cpp
@@ -91,4 +91,15 @@ QMatrix4x4 QMatrixTransform::transformMatrix() const
 
 } // namespace Qt3D
 
+/*!
+    \qmltype MatrixTransform
+    \inqmlmodule Qt3D
+    \since 5.5
+    \instantiates Qt3D::QMatrixTransform
+*/
+
+/*!
+    \qmlproperty matrix4x4 Qt3D::MatrixTransform::matrix
+*/
+
 QT_END_NAMESPACE
diff --git a/src/quick3d/quick3d/items/quick3dconfiguration.cpp b/src/quick3d/quick3d/items/quick3dconfiguration.cpp
index 5e205cb6e..2ee792af7 100644
--- a/src/quick3d/quick3d/items/quick3dconfiguration.cpp
+++ b/src/quick3d/quick3d/items/quick3dconfiguration.cpp
@@ -50,6 +50,11 @@ namespace Qt3D {
 
 namespace Quick {
 
+/*!
+    \qmltype Configuration
+    \inqmlmodule Qt3D
+    \since 5.5
+*/
 Quick3DConfiguration::Quick3DConfiguration(QObject *parent)
     : QObject(parent)
     , m_camera(Q_NULLPTR)
@@ -65,6 +70,9 @@ void Quick3DConfiguration::setControlledCamera(QCamera *camera)
     }
 }
 
+/*!
+    \qmlproperty Camera Qt3D::Configuration::controlledCamera
+*/
 QCamera *Quick3DConfiguration::controlledCamera() const
 {
     return m_camera;
diff --git a/src/quick3d/quick3d/items/quick3dentity.cpp b/src/quick3d/quick3d/items/quick3dentity.cpp
index d98c7c826..c00eb0899 100644
--- a/src/quick3d/quick3d/items/quick3dentity.cpp
+++ b/src/quick3d/quick3d/items/quick3dentity.cpp
@@ -43,11 +43,22 @@ namespace Qt3D {
 
 namespace Quick {
 
+/*!
+    \qmltype Entity
+    \inherits Node
+    \inqmlmodule Qt3D
+    \since 5.5
+*/
+
 Quick3DEntity::Quick3DEntity(QObject *parent)
     : QObject(parent)
 {
 }
 
+/*!
+    \qmlproperty list<Component3D> Qt3D::Entity::components
+    \readonly
+*/
 QQmlListProperty<QComponent> Quick3DEntity::componentList()
 {
     return QQmlListProperty<Qt3D::QComponent>(this, 0,
diff --git a/src/quick3d/quick3d/items/quick3dentityloader.cpp b/src/quick3d/quick3d/items/quick3dentityloader.cpp
index f15ad8d18..66c892d4a 100644
--- a/src/quick3d/quick3d/items/quick3dentityloader.cpp
+++ b/src/quick3d/quick3d/items/quick3dentityloader.cpp
@@ -75,17 +75,29 @@ private:
     Quick3DEntityLoader *m_loader;
 };
 
+/*!
+    \qmltype EntityLoader
+    \inqmlmodule Qt3D
+    \since 5.5
+*/
 Quick3DEntityLoader::Quick3DEntityLoader(QNode *parent)
     : QEntity(*new Quick3DEntityLoaderPrivate(this), parent)
 {
 }
 
+/*!
+    \qmlproperty QtQml::QtObject Qt3D::EntityLoader::entity
+    \readonly
+*/
 QObject *Quick3DEntityLoader::entity() const
 {
     Q_D(const Quick3DEntityLoader);
     return d->m_entity;
 }
 
+/*!
+    \qmlproperty url Qt3D::EntityLoader::source
+*/
 QUrl Quick3DEntityLoader::source() const
 {
     Q_D(const Quick3DEntityLoader);
@@ -114,6 +126,10 @@ void Quick3DEntityLoader::copy(const QNode *ref)
     d_func()->m_entity->setParent(this);
 }
 
+/*!
+    \class Qt3D::Quick::Quick3DEntityLoaderPrivate
+    \internal
+*/
 Quick3DEntityLoaderPrivate::Quick3DEntityLoaderPrivate(Quick3DEntityLoader *qq)
     : QEntityPrivate(qq),
       m_incubator(Q_NULLPTR),
diff --git a/src/quick3d/quick3d/items/quick3dnode.cpp b/src/quick3d/quick3d/items/quick3dnode.cpp
index 44e41c2f7..3a93e0211 100644
--- a/src/quick3d/quick3d/items/quick3dnode.cpp
+++ b/src/quick3d/quick3d/items/quick3dnode.cpp
@@ -43,11 +43,25 @@ namespace Qt3D {
 
 namespace Quick {
 
+/*!
+    \qmltype Node
+    \inqmlmodule Qt3D
+    \since 5.5
+
+    \brief A base QML type that other types inherit. It cannot be directly
+    created.
+*/
+
 Quick3DNode::Quick3DNode(QObject *parent)
     : QObject(parent)
 {
 }
 
+/*!
+    \qmlproperty list<QtQml::QtObject> Qt3D::Node::data
+    \default
+*/
+
 QQmlListProperty<QObject> Quick3DNode::data()
 {
     return QQmlListProperty<QObject>(this, 0,
@@ -57,6 +71,11 @@ QQmlListProperty<QObject> Quick3DNode::data()
                                      Quick3DNode::clearData);
 }
 
+/*!
+    \qmlproperty list<Node> Qt3D::Node::childNodes
+    \readonly
+*/
+
 QQmlListProperty<QNode> Quick3DNode::childNodes()
 {
     return QQmlListProperty<QNode>(this, 0,
diff --git a/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp b/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp
index 4684bd212..0d34159d4 100644
--- a/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp
+++ b/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp
@@ -50,6 +50,10 @@ QT_BEGIN_NAMESPACE
 namespace Qt3D {
 namespace Quick {
 
+/*!
+    \class Qt3D::Quick::Quick3DNodeInstantiatorPrivate
+    \internal
+*/
 Quick3DNodeInstantiatorPrivate::Quick3DNodeInstantiatorPrivate(QNode *qq)
     : QNodePrivate(qq)
     , m_componentComplete(true)
@@ -192,12 +196,12 @@ void Quick3DNodeInstantiatorPrivate::makeModel()
 /*!
     \qmltype NodeInstantiator
     \instantiates Quick3DNodeInstantiator
-    \inqmlmodule Quick3D
-    \brief Dynamically creates nodes
+    \inqmlmodule Qt3D
+    \brief Dynamically creates nodes.
     \since 5.5
 
-    A NodeInstantiator can be used to control the dynamic creation of nodes, or to dynamically
-    create multiple objects from a template.
+    A NodeInstantiator can be used to control the dynamic creation of nodes,
+    or to dynamically create multiple objects from a template.
 
     The NodeInstantiator element will manage the objects it creates. Those
     objects are parented to the Instantiator and can also be deleted by the
@@ -217,7 +221,7 @@ Quick3DNodeInstantiator::~Quick3DNodeInstantiator()
 }
 
 /*!
-    \qmlsignal Quick3D::NodeInstantiator::objectAdded(int index, QtObject node)
+    \qmlsignal Qt3D::NodeInstantiator::objectAdded(int index, QtObject node)
 
     This signal is emitted when a node is added to the NodeInstantiator. The \a index
     parameter holds the index which the node has been given, and the \a node
@@ -227,7 +231,7 @@ Quick3DNodeInstantiator::~Quick3DNodeInstantiator()
 */
 
 /*!
-    \qmlsignal Quick3D::NodeInstantiator::objectRemoved(int index, QtObject object)
+    \qmlsignal Qt3D::NodeInstantiator::objectRemoved(int index, QtObject object)
 
     This signal is emitted when an object is removed from the Instantiator. The \a index
     parameter holds the index which the object had been given, and the \a object
@@ -239,13 +243,13 @@ Quick3DNodeInstantiator::~Quick3DNodeInstantiator()
     The corresponding handler is \c onObjectRemoved.
 */
 /*!
-    \qmlproperty bool Quick3D::NodeInstantiator::active
+    \qmlproperty bool Qt3D::NodeInstantiator::active
 
-    When active is true, and the delegate component is ready, the Instantiator will
-    create objects according to the model. When active is false, no objects
+    When active is \c true, and the delegate component is ready, the Instantiator will
+    create objects according to the model. When active is \c false, no objects
     will be created and any previously created objects will be destroyed.
 
-    Default is true.
+    Default is \c true.
 */
 bool Quick3DNodeInstantiator::isActive() const
 {
@@ -264,7 +268,7 @@ void Quick3DNodeInstantiator::setActive(bool newVal)
 }
 
 /*!
-    \qmlproperty bool Quick3D::NodeInstantiator::asynchronous
+    \qmlproperty bool Qt3D::NodeInstantiator::asynchronous
 
     When asynchronous is true the Instantiator will attempt to create objects
     asynchronously. This means that objects may not be available immediately,
@@ -291,7 +295,8 @@ void Quick3DNodeInstantiator::setAsync(bool newVal)
 
 
 /*!
-    \qmlproperty int Quick3D::NodeInstantiator::count
+    \qmlproperty int Qt3D::NodeInstantiator::count
+    \readonly
 
     The number of objects the Instantiator is currently managing.
 */
@@ -303,7 +308,7 @@ int Quick3DNodeInstantiator::count() const
 }
 
 /*!
-    \qmlproperty QtQml::Component Quick3D::NodeInstantiator::delegate
+    \qmlproperty QtQml::Component Qt3D::NodeInstantiator::delegate
     \default
 
     The component used to create all objects.
@@ -340,13 +345,13 @@ void Quick3DNodeInstantiator::setDelegate(QQmlComponent *c)
 }
 
 /*!
-    \qmlproperty variant Quick3D::NodeInstantiator::model
+    \qmlproperty variant Qt3D::NodeInstantiator::model
 
     This property can be set to any of the supported \l {qml-data-models}{data models}:
 
     \list
     \li A number that indicates the number of delegates to be created by the repeater
-    \li A model (e.g. a ListModel item, or a QAbstractItemModel subclass)
+    \li A model (for example, a ListModel item or a QAbstractItemModel subclass)
     \li A string list
     \li An object list
     \endlist
@@ -415,7 +420,8 @@ void Quick3DNodeInstantiator::setModel(const QVariant &v)
 }
 
 /*!
-    \qmlproperty QtQml::QtObject Quick3D::NodeInstantiator::object
+    \qmlproperty QtQml::QtObject Qt3D::NodeInstantiator::object
+    \readonly
 
     This is a reference to the first created object, intended as a convenience
     for the case where only one object has been created.
@@ -429,7 +435,7 @@ QObject *Quick3DNodeInstantiator::object() const
 }
 
 /*!
-    \qmlmethod QtQml::QtObject Quick3D::NodeInstantiator::objectAt
+    \qmlmethod QtQml::QtObject Qt3D::NodeInstantiator::objectAt(int index)
 
     Returns a reference to the object with the given \a index.
 */
diff --git a/src/quick3d/quick3d/items/quick3dtransform.cpp b/src/quick3d/quick3d/items/quick3dtransform.cpp
index b236b1dd7..56556d491 100644
--- a/src/quick3d/quick3d/items/quick3dtransform.cpp
+++ b/src/quick3d/quick3d/items/quick3dtransform.cpp
@@ -43,6 +43,11 @@ namespace Qt3D {
 
 namespace Quick {
 
+/*!
+    \qmltype Transform
+    \inqmlmodule Qt3D
+    \since 5.5
+*/
 Quick3DTransform::Quick3DTransform(QObject *parent)
     : QObject(parent)
 {
@@ -50,6 +55,15 @@ Quick3DTransform::Quick3DTransform(QObject *parent)
     QObject::connect(parent, SIGNAL(transformsChanged()), this, SIGNAL(transformsChanged()));
 }
 
+/*!
+    \qmlproperty matrix4x4 Qt3D::Transform::matrix
+    \readonly
+*/
+
+/*!
+    \qmlproperty list<QAbstractTransform> Qt3D::Transform::transforms
+    \default
+*/
 QQmlListProperty<QAbstractTransform> Quick3DTransform::transformList()
 {
     return QQmlListProperty<QAbstractTransform>(this, 0,
diff --git a/src/quick3d/quick3d/qqmlaspectengine.cpp b/src/quick3d/quick3d/qqmlaspectengine.cpp
index ec00cdf75..335c76827 100644
--- a/src/quick3d/quick3d/qqmlaspectengine.cpp
+++ b/src/quick3d/quick3d/qqmlaspectengine.cpp
@@ -48,7 +48,7 @@ namespace Qt3D {
 namespace Quick {
 
 /*!
-    \class Qt3D::QQmlAspectEnginePrivate
+    \class Qt3D::Quick::QQmlAspectEnginePrivate
     \internal
 */
 QQmlAspectEnginePrivate::QQmlAspectEnginePrivate(QQmlAspectEngine *qq)