From cec070f3905bcf6127e4e14236d5c61f09e3a61f Mon Sep 17 00:00:00 2001
From: Rhys Weatherley <rhys.weatherley@nokia.com>
Date: Thu, 5 Nov 2009 15:59:53 +1000
Subject: Document the vector3d type in QML

Task-number: QTBUG-5334
Reviewed-by: Aaron Kennedy
---
 doc/src/declarative/basictypes.qdoc | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/doc/src/declarative/basictypes.qdoc b/doc/src/declarative/basictypes.qdoc
index 80ec211..0551443 100644
--- a/doc/src/declarative/basictypes.qdoc
+++ b/doc/src/declarative/basictypes.qdoc
@@ -233,4 +233,25 @@
     \endqml
     \c Child1, \c Child2 and \c Child3 will all be added to the children list
     in the order in which they appear.
+
+    \target basicqmlvector3d
+    \section1 vector3d
+
+    A \c vector3d is specified in \c "x,y,z" format:
+
+    \qml
+    Rotation { angle: 60; axis: "0,1,0" }
+    \endqml
+
+    or with the \c{Qt.vector3d()} helper function:
+
+    \qml
+    Rotation { angle: 60; axis: Qt.vector3d(0, 1, 0) }
+    \endqml
+
+    or as separate \c x, \c y, and \c z components:
+
+    \qml
+    Rotation { angle: 60; axis.x: 0; axis.y: 1; axis.z: 0 }
+    \endqml
 */
-- 
cgit v0.12