From 872efa5619d20a421142a88e1a38f131c08d44d1 Mon Sep 17 00:00:00 2001 From: Venugopal Shivashankar Date: Fri, 30 Oct 2015 14:18:19 +0100 Subject: Doc: Documentation clean up MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Changed 'Qt3D' references to 'Qt 3D'. - Fixed incorrect \inqmlmodule instances. - Fixed broken \printuntil instances in the example docs. - Updated the namespace qualifier for a few class references. Change-Id: I250afe6843b10ed520f9ce5d7465203cc5c212c1 Reviewed-by: Topi Reiniö --- examples/qt3d/assimp/doc/src/assimp.qdoc | 2 +- examples/qt3d/basicshapes-cpp/doc/src/basicshapes.qdoc | 2 +- examples/qt3d/bigmodel-qml/doc/src/bigmodel-qml.qdoc | 2 +- examples/qt3d/bigscene-cpp/doc/src/bigscene-cpp.qdoc | 2 +- examples/qt3d/cpp_example/doc/src/cpp_example.qdoc | 2 +- examples/qt3d/cylinder-cpp/doc/src/cylinder-cpp.qdoc | 2 +- examples/qt3d/cylinder-qml/doc/src/cylinder-qml.qdoc | 2 +- .../qt3d/deferred-renderer-cpp/doc/src/deferred-renderer-cpp.qdoc | 2 +- .../qt3d/deferred-renderer-qml/doc/src/deferred-renderer-qml.qdoc | 2 +- examples/qt3d/dynamicscene-cpp/doc/src/dynamicscene-cpp.qdoc | 2 +- examples/qt3d/enabled-qml/doc/src/enabled-qml.qdoc | 2 +- examples/qt3d/gltf/doc/src/gltf.qdoc | 2 +- examples/qt3d/keyboardinput-qml/doc/src/keyboardinput-qml.qdoc | 2 +- examples/qt3d/loader-qml/doc/src/loader-qml.qdoc | 2 +- examples/qt3d/materials-cpp/doc/src/materials-cpp.qdoc | 2 +- examples/qt3d/materials/doc/src/materials.qdoc | 2 +- examples/qt3d/multiviewport/doc/src/multiviewport.qdoc | 2 +- examples/qt3d/planets-qml/doc/src/planets-qml.qdoc | 2 +- examples/qt3d/playground-qml/doc/src/playground-qml.qdoc | 2 +- examples/qt3d/scene3d/doc/src/scene3d.qdoc | 2 +- examples/qt3d/shadow-map-qml/doc/src/shadow-map-qml.qdoc | 8 ++++---- examples/qt3d/simple-cpp/doc/src/simple-cpp.qdoc | 2 +- examples/qt3d/simple-qml/doc/src/simple-qml.qdoc | 2 +- examples/qt3d/skybox/doc/src/skybox.qdoc | 2 +- examples/qt3d/tessellation-modes/doc/src/tessellation-modes.qdoc | 2 +- examples/qt3d/torus-qml/doc/src/torus-qml.qdoc | 2 +- examples/qt3d/wave/doc/src/wave.qdoc | 2 +- examples/qt3d/wireframe/doc/src/wireframe.qdoc | 4 ++-- 28 files changed, 32 insertions(+), 32 deletions(-) (limited to 'examples') diff --git a/examples/qt3d/assimp/doc/src/assimp.qdoc b/examples/qt3d/assimp/doc/src/assimp.qdoc index c0955c4f5..c3ab093a1 100644 --- a/examples/qt3d/assimp/doc/src/assimp.qdoc +++ b/examples/qt3d/assimp/doc/src/assimp.qdoc @@ -27,6 +27,6 @@ /*! \example assimp - \title Qt3D: assimp Example + \title Qt 3D: assimp Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/basicshapes-cpp/doc/src/basicshapes.qdoc b/examples/qt3d/basicshapes-cpp/doc/src/basicshapes.qdoc index 75da8e12d..86ed7e3e8 100644 --- a/examples/qt3d/basicshapes-cpp/doc/src/basicshapes.qdoc +++ b/examples/qt3d/basicshapes-cpp/doc/src/basicshapes.qdoc @@ -27,7 +27,7 @@ /*! \example basicshapes-cpp - \title Qt3D: Basic Shapes C++ Example + \title Qt 3D: Basic Shapes C++ Example \ingroup qt3d-examples-cpp \brief Shows four basic shapes that Qt3D offers and sets up a mesh for each of them. diff --git a/examples/qt3d/bigmodel-qml/doc/src/bigmodel-qml.qdoc b/examples/qt3d/bigmodel-qml/doc/src/bigmodel-qml.qdoc index 1a2ea6d2d..d7061bd74 100644 --- a/examples/qt3d/bigmodel-qml/doc/src/bigmodel-qml.qdoc +++ b/examples/qt3d/bigmodel-qml/doc/src/bigmodel-qml.qdoc @@ -27,6 +27,6 @@ /*! \example bigmodel-qml - \title Qt3D: Big Model QML Example + \title Qt 3D: Big Model QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/bigscene-cpp/doc/src/bigscene-cpp.qdoc b/examples/qt3d/bigscene-cpp/doc/src/bigscene-cpp.qdoc index 75f2dab20..39a3d370d 100644 --- a/examples/qt3d/bigscene-cpp/doc/src/bigscene-cpp.qdoc +++ b/examples/qt3d/bigscene-cpp/doc/src/bigscene-cpp.qdoc @@ -27,6 +27,6 @@ /*! \example bigscene-cpp - \title Qt3D: Big Scene C++ Example + \title Qt 3D: Big Scene C++ Example \ingroup qt3d-examples-cpp */ diff --git a/examples/qt3d/cpp_example/doc/src/cpp_example.qdoc b/examples/qt3d/cpp_example/doc/src/cpp_example.qdoc index c27590221..84e3cb4d7 100644 --- a/examples/qt3d/cpp_example/doc/src/cpp_example.qdoc +++ b/examples/qt3d/cpp_example/doc/src/cpp_example.qdoc @@ -27,6 +27,6 @@ /*! \example cpp_example - \title Qt3D: C++ Example + \title Qt 3D: C++ Example \ingroup qt3d-examples-cpp */ diff --git a/examples/qt3d/cylinder-cpp/doc/src/cylinder-cpp.qdoc b/examples/qt3d/cylinder-cpp/doc/src/cylinder-cpp.qdoc index f33cfb7e1..45b74a4ba 100644 --- a/examples/qt3d/cylinder-cpp/doc/src/cylinder-cpp.qdoc +++ b/examples/qt3d/cylinder-cpp/doc/src/cylinder-cpp.qdoc @@ -27,6 +27,6 @@ /*! \example cylinder-cpp - \title Qt3D: Cylinder C++ Example + \title Qt 3D: Cylinder C++ Example \ingroup qt3d-examples-cpp */ diff --git a/examples/qt3d/cylinder-qml/doc/src/cylinder-qml.qdoc b/examples/qt3d/cylinder-qml/doc/src/cylinder-qml.qdoc index 841604eb9..7ab372c72 100644 --- a/examples/qt3d/cylinder-qml/doc/src/cylinder-qml.qdoc +++ b/examples/qt3d/cylinder-qml/doc/src/cylinder-qml.qdoc @@ -27,6 +27,6 @@ /*! \example cylinder-qml - \title Qt3D: Cylinder QML Example + \title Qt 3D: Cylinder QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/deferred-renderer-cpp/doc/src/deferred-renderer-cpp.qdoc b/examples/qt3d/deferred-renderer-cpp/doc/src/deferred-renderer-cpp.qdoc index 7c7beb369..d5327345a 100644 --- a/examples/qt3d/deferred-renderer-cpp/doc/src/deferred-renderer-cpp.qdoc +++ b/examples/qt3d/deferred-renderer-cpp/doc/src/deferred-renderer-cpp.qdoc @@ -27,6 +27,6 @@ /*! \example deferred-renderer-cpp - \title Qt3D: Deferred Renderer C++ Example + \title Qt 3D: Deferred Renderer C++ Example \ingroup qt3d-examples-cpp */ diff --git a/examples/qt3d/deferred-renderer-qml/doc/src/deferred-renderer-qml.qdoc b/examples/qt3d/deferred-renderer-qml/doc/src/deferred-renderer-qml.qdoc index dba530e5b..24003ccb1 100644 --- a/examples/qt3d/deferred-renderer-qml/doc/src/deferred-renderer-qml.qdoc +++ b/examples/qt3d/deferred-renderer-qml/doc/src/deferred-renderer-qml.qdoc @@ -27,6 +27,6 @@ /*! \example deferred-renderer-qml - \title Qt3D: Deferred Renderer QML Example + \title Qt 3D: Deferred Renderer QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/dynamicscene-cpp/doc/src/dynamicscene-cpp.qdoc b/examples/qt3d/dynamicscene-cpp/doc/src/dynamicscene-cpp.qdoc index c5ab20cf4..e9057c2d1 100644 --- a/examples/qt3d/dynamicscene-cpp/doc/src/dynamicscene-cpp.qdoc +++ b/examples/qt3d/dynamicscene-cpp/doc/src/dynamicscene-cpp.qdoc @@ -27,6 +27,6 @@ /*! \example dynamicscene-cpp - \title Qt3D: Dynamic Scene C++ Example + \title Qt 3D: Dynamic Scene C++ Example \ingroup qt3d-examples-cpp */ diff --git a/examples/qt3d/enabled-qml/doc/src/enabled-qml.qdoc b/examples/qt3d/enabled-qml/doc/src/enabled-qml.qdoc index 9f6c49341..02141aef0 100644 --- a/examples/qt3d/enabled-qml/doc/src/enabled-qml.qdoc +++ b/examples/qt3d/enabled-qml/doc/src/enabled-qml.qdoc @@ -27,6 +27,6 @@ /*! \example enabled-qml - \title Qt3D: Enabled QML Example + \title Qt 3D: Enabled QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/gltf/doc/src/gltf.qdoc b/examples/qt3d/gltf/doc/src/gltf.qdoc index 22757633d..f03d453f5 100644 --- a/examples/qt3d/gltf/doc/src/gltf.qdoc +++ b/examples/qt3d/gltf/doc/src/gltf.qdoc @@ -27,6 +27,6 @@ /*! \example gltf - \title Qt3D: glTF Assets Example + \title Qt 3D: glTF Assets Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/keyboardinput-qml/doc/src/keyboardinput-qml.qdoc b/examples/qt3d/keyboardinput-qml/doc/src/keyboardinput-qml.qdoc index 8fd5e75f4..130e06698 100644 --- a/examples/qt3d/keyboardinput-qml/doc/src/keyboardinput-qml.qdoc +++ b/examples/qt3d/keyboardinput-qml/doc/src/keyboardinput-qml.qdoc @@ -27,6 +27,6 @@ /*! \example keyboardinput-qml - \title Qt3D: Keyboard Input QML Example + \title Qt 3D: Keyboard Input QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/loader-qml/doc/src/loader-qml.qdoc b/examples/qt3d/loader-qml/doc/src/loader-qml.qdoc index c22c6159b..8dc320fac 100644 --- a/examples/qt3d/loader-qml/doc/src/loader-qml.qdoc +++ b/examples/qt3d/loader-qml/doc/src/loader-qml.qdoc @@ -27,6 +27,6 @@ /*! \example loader-qml - \title Qt3D: Loader QML Example + \title Qt 3D: Loader QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/materials-cpp/doc/src/materials-cpp.qdoc b/examples/qt3d/materials-cpp/doc/src/materials-cpp.qdoc index 65f92c0a0..e94b7f4ff 100644 --- a/examples/qt3d/materials-cpp/doc/src/materials-cpp.qdoc +++ b/examples/qt3d/materials-cpp/doc/src/materials-cpp.qdoc @@ -27,6 +27,6 @@ /*! \example materials-cpp - \title Qt3D: Materials C++ Example + \title Qt 3D: Materials C++ Example \ingroup qt3d-examples-cpp */ diff --git a/examples/qt3d/materials/doc/src/materials.qdoc b/examples/qt3d/materials/doc/src/materials.qdoc index 22093941b..e4e2b01c1 100644 --- a/examples/qt3d/materials/doc/src/materials.qdoc +++ b/examples/qt3d/materials/doc/src/materials.qdoc @@ -27,6 +27,6 @@ /*! \example materials - \title Qt3D: Materials QML Example + \title Qt 3D: Materials QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/multiviewport/doc/src/multiviewport.qdoc b/examples/qt3d/multiviewport/doc/src/multiviewport.qdoc index 27cc1a4a3..2316c1c70 100644 --- a/examples/qt3d/multiviewport/doc/src/multiviewport.qdoc +++ b/examples/qt3d/multiviewport/doc/src/multiviewport.qdoc @@ -27,6 +27,6 @@ /*! \example multiviewport - \title Qt3D: Multi Viewport QML Example + \title Qt 3D: Multi Viewport QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/planets-qml/doc/src/planets-qml.qdoc b/examples/qt3d/planets-qml/doc/src/planets-qml.qdoc index f50a84fec..9b65226e9 100644 --- a/examples/qt3d/planets-qml/doc/src/planets-qml.qdoc +++ b/examples/qt3d/planets-qml/doc/src/planets-qml.qdoc @@ -36,7 +36,7 @@ /*! \example planets-qml - \title Qt3D: Planets QML Example + \title Qt 3D: Planets QML Example \ingroup qt3d-examples-qml \brief Demonstrates combining Qt 3D rendering and Qt Quick 2 elements. diff --git a/examples/qt3d/playground-qml/doc/src/playground-qml.qdoc b/examples/qt3d/playground-qml/doc/src/playground-qml.qdoc index dce4eea27..e10a8ea2a 100644 --- a/examples/qt3d/playground-qml/doc/src/playground-qml.qdoc +++ b/examples/qt3d/playground-qml/doc/src/playground-qml.qdoc @@ -27,6 +27,6 @@ /*! \example playground-qml - \title Qt3D: Playground QML Example + \title Qt 3D: Playground QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/scene3d/doc/src/scene3d.qdoc b/examples/qt3d/scene3d/doc/src/scene3d.qdoc index 8ef077dd8..3b905f10a 100644 --- a/examples/qt3d/scene3d/doc/src/scene3d.qdoc +++ b/examples/qt3d/scene3d/doc/src/scene3d.qdoc @@ -27,6 +27,6 @@ /*! \example scene3d - \title Qt3D: Scene3D QML Example + \title Qt 3D: Scene3D QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/shadow-map-qml/doc/src/shadow-map-qml.qdoc b/examples/qt3d/shadow-map-qml/doc/src/shadow-map-qml.qdoc index fd3377a8b..7fd8d11d7 100644 --- a/examples/qt3d/shadow-map-qml/doc/src/shadow-map-qml.qdoc +++ b/examples/qt3d/shadow-map-qml/doc/src/shadow-map-qml.qdoc @@ -27,15 +27,15 @@ /*! \example shadow-map-qml - \title Qt3D: Shadow Map QML Example + \title Qt 3D: Shadow Map QML Example \ingroup qt3d-examples-qml - \brief A Qt3D QML application that illustrates how to render a scene in Qt3D + \brief A Qt 3D QML application that illustrates how to render a scene in Qt 3D with shadows. \image shadowmapping-qt3d.png - \e {Qt3D Shadow Map} illustrates how to configure the renderer in order to + \e {Qt 3D Shadow Map} illustrates how to configure the renderer in order to accommodate custom rendering techniques. The example application displays a self-shadowed plane and trefoil knot. @@ -59,7 +59,7 @@ \quotefromfile shadow-map-qml/main.qml \skipto import Qt3D - \printuntil Renderer + \printuntil Render The first entities we create are a \l Camera, which represents the camera used for the final rendering, and a \l Configuration, which allows us to diff --git a/examples/qt3d/simple-cpp/doc/src/simple-cpp.qdoc b/examples/qt3d/simple-cpp/doc/src/simple-cpp.qdoc index ee0b55fff..4c76445e5 100644 --- a/examples/qt3d/simple-cpp/doc/src/simple-cpp.qdoc +++ b/examples/qt3d/simple-cpp/doc/src/simple-cpp.qdoc @@ -27,6 +27,6 @@ /*! \example simple-cpp - \title Qt3D: Simple C++ Example + \title Qt 3D: Simple C++ Example \ingroup qt3d-examples-cpp */ diff --git a/examples/qt3d/simple-qml/doc/src/simple-qml.qdoc b/examples/qt3d/simple-qml/doc/src/simple-qml.qdoc index 8e2be44bd..1173cbefe 100644 --- a/examples/qt3d/simple-qml/doc/src/simple-qml.qdoc +++ b/examples/qt3d/simple-qml/doc/src/simple-qml.qdoc @@ -27,6 +27,6 @@ /*! \example simple-qml - \title Qt3D: Simple QML Example + \title Qt 3D: Simple QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/skybox/doc/src/skybox.qdoc b/examples/qt3d/skybox/doc/src/skybox.qdoc index b84893416..e8ebf9b7f 100644 --- a/examples/qt3d/skybox/doc/src/skybox.qdoc +++ b/examples/qt3d/skybox/doc/src/skybox.qdoc @@ -27,6 +27,6 @@ /*! \example skybox - \title Qt3D: Skybox QML Example + \title Qt 3D: Skybox QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/tessellation-modes/doc/src/tessellation-modes.qdoc b/examples/qt3d/tessellation-modes/doc/src/tessellation-modes.qdoc index 10ab1b722..eb731d4b1 100644 --- a/examples/qt3d/tessellation-modes/doc/src/tessellation-modes.qdoc +++ b/examples/qt3d/tessellation-modes/doc/src/tessellation-modes.qdoc @@ -27,6 +27,6 @@ /*! \example tessellation-modes - \title Qt3D: Tessellation Modes QML Example + \title Qt 3D: Tessellation Modes QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/torus-qml/doc/src/torus-qml.qdoc b/examples/qt3d/torus-qml/doc/src/torus-qml.qdoc index 37cf26594..0004f7878 100644 --- a/examples/qt3d/torus-qml/doc/src/torus-qml.qdoc +++ b/examples/qt3d/torus-qml/doc/src/torus-qml.qdoc @@ -27,6 +27,6 @@ /*! \example torus-qml - \title Qt3D: Torus QML Example + \title Qt 3D: Torus QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/wave/doc/src/wave.qdoc b/examples/qt3d/wave/doc/src/wave.qdoc index e967b14df..e0502f6b7 100644 --- a/examples/qt3d/wave/doc/src/wave.qdoc +++ b/examples/qt3d/wave/doc/src/wave.qdoc @@ -27,6 +27,6 @@ /*! \example wave - \title Qt3D: Wave QML Example + \title Qt 3D: Wave QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/wireframe/doc/src/wireframe.qdoc b/examples/qt3d/wireframe/doc/src/wireframe.qdoc index 2b0cdda62..dcb86c398 100644 --- a/examples/qt3d/wireframe/doc/src/wireframe.qdoc +++ b/examples/qt3d/wireframe/doc/src/wireframe.qdoc @@ -27,7 +27,7 @@ /*! \example wireframe - \title Qt3D: Wireframe QML Example + \title Qt 3D: Wireframe QML Example \ingroup qt3d-examples-qml \brief A Qt3D QML application that implements a single-pass wireframe @@ -56,7 +56,7 @@ \quotefromfile wireframe/TrefoilKnot.qml \skipto import Qt3D - \printuntil Renderer + \printuntil Render To use components from other aspects, we would need to import the corresponding QML module, too. -- cgit v1.2.3