diff options
author | Sarah Smith <sarah.j.smith@nokia.com> | 2011-07-13 18:50:10 +1000 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2011-07-18 01:03:37 +0200 |
commit | a1e7bb5f5ce6d2bcffdfd91006158f4ba44338bd (patch) | |
tree | 9e2b63a54d7526dc021e402049fe8de6e6a6add4 | |
parent | 03c2d076cbbe95a1c1de89b3f6aa725c5169a37a (diff) |
Fix doc build for new tutorials directory.
Change-Id: I995f8101bccd61c28d2404c60d67db33270782cc
Reviewed-on: http://codereview.qt.nokia.com/1688
Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Sarah Jane Smith
-rw-r--r-- | doc/config/qt3d-project.qdocconf | 1 | ||||
-rw-r--r-- | doc/src/examples/teapot-qml.qdoc | 16 | ||||
-rw-r--r-- | doc/src/tutorials/penguin.qdoc | 12 | ||||
-rw-r--r-- | doc/src/tutorials/shaders.qdoc | 4 | ||||
-rw-r--r-- | doc/src/tutorials/simpleobject.qdoc | 22 |
5 files changed, 28 insertions, 27 deletions
diff --git a/doc/config/qt3d-project.qdocconf b/doc/config/qt3d-project.qdocconf index 258dfe4b..78f8fab1 100644 --- a/doc/config/qt3d-project.qdocconf +++ b/doc/config/qt3d-project.qdocconf @@ -28,6 +28,7 @@ sourcedirs = $TOPSRC/src/imports \ exampledirs = $TOPSRC/examples \ $TOPSRC/demos \ + $TOPSRC/tutorials \ $TOPSRC/src/plugins imagedirs = $TOPSRC/doc/src/images \ diff --git a/doc/src/examples/teapot-qml.qdoc b/doc/src/examples/teapot-qml.qdoc index 10b7aec0..9f8153cc 100644 --- a/doc/src/examples/teapot-qml.qdoc +++ b/doc/src/examples/teapot-qml.qdoc @@ -26,28 +26,28 @@ ****************************************************************************/ /*! - \example quick3d/tutorials/teapot_qml + \example quick3d/teapot_qml \title Teapot Example in QtQuick3D This example shows to use QtQuick3D to display a teapot on the screen. The QML is fairly simple: - \snippet quick3d/tutorials/teapot_qml/qml/teapot.qml 1 + \snippet quick3d/teapot_qml/qml/teapot.qml 1 \image teapot-qml-screenshot.png The example starts by importing the Qt and Qt3D QML modules: - \snippet quick3d/tutorials/teapot_qml/qml/teapot.qml 2 + \snippet quick3d/teapot_qml/qml/teapot.qml 2 Then we create a viewport of size 640x480 to display the teapot: - \snippet quick3d/tutorials/teapot_qml/qml/teapot.qml 3 + \snippet quick3d/teapot_qml/qml/teapot.qml 3 And now we create a \l Item3D to display the teapot with a default lit material effect: - \snippet quick3d/tutorials/teapot_qml/qml/teapot.qml 4 + \snippet quick3d/teapot_qml/qml/teapot.qml 4 The teapot data itself is loaded from \c{teapot.bez}, which contains Bezier patch data that describes the geometry of the teapot. @@ -55,15 +55,15 @@ Let's make the teapot a little more interesting by adding a material to simulate bone china: - \snippet quick3d/tutorials/teapot_bounce_qml/qml/teapot-bounce.qml 1 - \snippet quick3d/tutorials/teapot_bounce_qml/qml/teapot-bounce.qml 2 + \snippet quick3d/teapot_bounce_qml/qml/teapot-bounce.qml 1 + \snippet quick3d/teapot_bounce_qml/qml/teapot-bounce.qml 2 \image teapot-china-screenshot.png To make the teapot even more interesting, we can cause it to bounce up and down using a QML animation item: - \snippet quick3d/tutorials/teapot_bounce_qml/qml/teapot-bounce.qml 3 + \snippet quick3d/teapot_bounce_qml/qml/teapot-bounce.qml 3 This QML teapot example can be compared with the \l{qt3d/teapot}{C++ version}. Using QML is briefer than C++, and easier to modify to adjust diff --git a/doc/src/tutorials/penguin.qdoc b/doc/src/tutorials/penguin.qdoc index ff423ac1..94d3de14 100644 --- a/doc/src/tutorials/penguin.qdoc +++ b/doc/src/tutorials/penguin.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! - \example qt3d/tutorials/penguin + \example qt3d/penguin \title Loading a 3DS model with Qt3D This tutorial shows how Qt3D can be used to load a simple @@ -36,7 +36,7 @@ We start by defining a class that inherits from QGLView, which provides some basic scene setup logic and 3D camera navigation: - \snippet qt3d/tutorials/penguin/modelview.h class-defn + \snippet qt3d/penguin/modelview.h class-defn Refer first to the \l{Teapot Example} for the basics of using the QGLView class, lighting and so on. @@ -45,12 +45,12 @@ resource file, and store the result in a member variable, so we can refer to it in the paint function: - \snippet qt3d/tutorials/penguin/modelview.cpp initialize + \snippet qt3d/penguin/modelview.cpp initialize In the teapot example we had to specify appropriate effects but the model loader sets appropriate effects on the scene for us. - \snippet qt3d/tutorials/penguin/modelview.cpp paint + \snippet qt3d/penguin/modelview.cpp paint Here in the paint function we call the \c{draw()} function of the scene's main object, in order to display the fully @@ -72,7 +72,7 @@ Let's make a few changes to have our penguin display nicely when the application opens. - \snippet qt3d/tutorials/penguin_advanced/modelview.cpp initialize + \snippet qt3d/penguin_advanced/modelview.cpp initialize First of all, let move the camera away from the penguin and up so he fits in the frame and we can get a better angle on him, @@ -95,7 +95,7 @@ calculated and stored as a quaternion - we want the x twist first so that goes last in the product of the two quaternions. - \snippet qt3d/tutorials/penguin_advanced/modelview.cpp paint + \snippet qt3d/penguin_advanced/modelview.cpp paint Now all that remains in the updated paint function is to apply the new pose, and then paint the penguin. diff --git a/doc/src/tutorials/shaders.qdoc b/doc/src/tutorials/shaders.qdoc index 53829793..5f48e264 100644 --- a/doc/src/tutorials/shaders.qdoc +++ b/doc/src/tutorials/shaders.qdoc @@ -27,7 +27,7 @@ /*! \title Using GLSL shaders in QtQuick3D - \example quick3d/tutorials/shaders + \example quick3d/shaders In this tutorial, we will show how to apply QML property animations to @@ -42,7 +42,7 @@ <table align="left" width="100%"> <tr class="qt-code"><td> \endraw - \snippet quick3d/tutorials/shaders/shader-tutorial.qml 1 + \snippet quick3d/shaders/shader-tutorial.qml 1 \raw HTML </td><td align="right"> \endraw diff --git a/doc/src/tutorials/simpleobject.qdoc b/doc/src/tutorials/simpleobject.qdoc index 2cda740c..647c7e04 100644 --- a/doc/src/tutorials/simpleobject.qdoc +++ b/doc/src/tutorials/simpleobject.qdoc @@ -28,7 +28,7 @@ /*! \title Applying Transformations and Materials \keyword Object Effects - \example qt3d/tutorials/cube4 + \example qt3d/cube4 In this tutorial we will apply transformations and materials to a simple cube object to demonstrate how to modify the QGLPainter @@ -45,7 +45,7 @@ In the C++ world we start by declaring a view class to show our cube on the screen: - \snippet qt3d/tutorials/cube1/cubeview.h 1 + \snippet qt3d/cube1/cubeview.h 1 QGLView provides most of the logic for initializing the view, setting the camera position, and handling navigation via @@ -53,12 +53,12 @@ QGLBuilder to create the geometry for the cube object that we will be using in later steps: - \snippet qt3d/tutorials/cube1/cubeview.cpp 1 + \snippet qt3d/cube1/cubeview.cpp 1 Then it is a simple matter to draw the object in our \c{paintGL()} method: - \snippet qt3d/tutorials/cube1/cubeview.cpp 2 + \snippet qt3d/cube1/cubeview.cpp 2 If we run the program now, we get the following output, which isn't very cube-like: @@ -71,7 +71,7 @@ matrix a little bit to apply a 45 degree rotation around the axis (1, 1, 1): - \snippet qt3d/tutorials/cube2/cubeview.cpp 2 + \snippet qt3d/cube2/cubeview.cpp 2 Now the results are a little better: @@ -83,7 +83,7 @@ (white in this case). So let's change to a lit material effect with a nice green color: - \snippet qt3d/tutorials/cube3/cubeview.cpp 2 + \snippet qt3d/cube3/cubeview.cpp 2 That's much better; now it looks like a cube: @@ -92,13 +92,13 @@ To complete this tutorial, let's make the cube a little more interesting by adding a texture to the side: - \snippet qt3d/tutorials/cube4/cubeview.h 1 + \snippet qt3d/cube4/cubeview.h 1 \dots - \snippet qt3d/tutorials/cube4/cubeview.h 2 - \snippet qt3d/tutorials/cube4/cubeview.cpp 1 + \snippet qt3d/cube4/cubeview.h 2 + \snippet qt3d/cube4/cubeview.cpp 1 \dots - \snippet qt3d/tutorials/cube4/cubeview.cpp 2 - \snippet qt3d/tutorials/cube4/cubeview.cpp 3 + \snippet qt3d/cube4/cubeview.cpp 2 + \snippet qt3d/cube4/cubeview.cpp 3 \image tutorials/cube4-screenshot.png |