summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVenugopal Shivashankar <venugopal.shivashankar@digia.com>2016-01-20 17:30:03 +0100
committerTopi Reiniƶ <topi.reinio@theqtcompany.com>2016-01-22 12:09:10 +0000
commit02c64c14fe44986fc5fe031730ba79274a1a2d93 (patch)
tree74653e74559353f7c19f1b6c9228fa9d4c64c5c1
parenta203ce0742105557a7e4641f6a37e462f231d0b0 (diff)
Doc: Add skeletal doc structure for the Transform QML type
Also improvised on the \brief statements for other QML types in Qt3D.Core, based on the corresponding C++ class \briefs. Change-Id: I7780e12d9a50a0c0a9b9e83c028f14bd76a237de Reviewed-by: Topi Reiniƶ <topi.reinio@theqtcompany.com>
-rw-r--r--src/core/core-components/qcameralens.cpp1
-rw-r--r--src/core/nodes/qcomponent.cpp3
-rw-r--r--src/core/transforms/qtransform.cpp6
-rw-r--r--src/quick3d/quick3d/qquaternionanimation.cpp2
4 files changed, 11 insertions, 1 deletions
diff --git a/src/core/core-components/qcameralens.cpp b/src/core/core-components/qcameralens.cpp
index d544d8767..ca24cc0c8 100644
--- a/src/core/core-components/qcameralens.cpp
+++ b/src/core/core-components/qcameralens.cpp
@@ -425,6 +425,7 @@ QMatrix4x4 QCameraLens::projectionMatrix() const
\inqmlmodule Qt3D.Core
\inherits Component3D
\since 5.5
+ \brief Provides the projection matrix that is used to define a Camera for 3D scene.
*/
/*!
diff --git a/src/core/nodes/qcomponent.cpp b/src/core/nodes/qcomponent.cpp
index e4fbcb67d..f979754a3 100644
--- a/src/core/nodes/qcomponent.cpp
+++ b/src/core/nodes/qcomponent.cpp
@@ -184,6 +184,9 @@ QComponent::QComponent(QComponentPrivate &dd, QNode *parent)
\inqmlmodule Qt3D.Core
\inherits Node
\since 5.5
+ \brief Provides the base type for creating Qt 3D components.
+
+ \TODO
*/
/*!
diff --git a/src/core/transforms/qtransform.cpp b/src/core/transforms/qtransform.cpp
index e54c11bec..973f86764 100644
--- a/src/core/transforms/qtransform.cpp
+++ b/src/core/transforms/qtransform.cpp
@@ -62,6 +62,12 @@ QTransform::QTransform(QNode *parent)
: QComponent(*new QTransformPrivate, parent)
{
}
+/*!
+ \qmltype Transform
+ \inqmlmodule Qt3D.Core
+ \since 5.6
+ \TODO
+*/
/*! \internal */
QTransform::QTransform(QTransformPrivate &dd, QNode *parent)
diff --git a/src/quick3d/quick3d/qquaternionanimation.cpp b/src/quick3d/quick3d/qquaternionanimation.cpp
index 2af0b717a..5dc63995c 100644
--- a/src/quick3d/quick3d/qquaternionanimation.cpp
+++ b/src/quick3d/quick3d/qquaternionanimation.cpp
@@ -43,7 +43,7 @@ QT_BEGIN_NAMESPACE
\qmltype QuaternionAnimation
\instantiates Qt3DCore::Quick::QQuaternionAnimation
\inherits PropertyAnimation
- \inqmlmodule Qt3D
+ \inqmlmodule Qt3D.Core
\since 5.6
\brief A PropertyAnimation for quaternions.