diff options
author | Topi Reinio <topi.reinio@qt.io> | 2019-11-13 09:19:05 +0100 |
---|---|---|
committer | Topi Reinio <topi.reinio@qt.io> | 2019-11-13 11:29:48 +0100 |
commit | 0b5d01eeec9913a0bb0d545b48d13cec8dde5354 (patch) | |
tree | 987a7b04d65b4e27f86687b8eee5e8c16f0ad6e2 /examples/qt3d | |
parent | 8de836c63eb0a0e484ae4c9e02f0a5f23ef49b65 (diff) |
Doc: Fix documentation warnings
- Add (basic) documentation for Qt3DAnimation::QAnimationCallback.
- Add missing namespace qualifiers for \class, \fn, \instantiates,
\sa, and \property commands.
- Remove linking to example file pages, as QDoc no longe treats them
as linkable targets.
- Fix function/QML method parameter documentation
- Fix missing \qmlproperty types
- Fix linking to QKeyEvent in QtGui.
- Move Qt3DRender::Quick namespace documentation to where QDoc can
see it.
- Add enum documentation for
Qt3DRender::QBlitFramebuffer::InterpolationMethod and
Qt3DRender::QMesh::Status.
- Other minor fixes
This brings the current warning count to zero.
Fixes: QTBUG-79822
Change-Id: I1154a7f9c34917a3f240e99da0e7a300be7d65a0
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'examples/qt3d')
4 files changed, 15 insertions, 15 deletions
diff --git a/examples/qt3d/advancedcustommaterial/doc/src/advancedcustommaterial.qdoc b/examples/qt3d/advancedcustommaterial/doc/src/advancedcustommaterial.qdoc index 377bb952c..d845fa8da 100644 --- a/examples/qt3d/advancedcustommaterial/doc/src/advancedcustommaterial.qdoc +++ b/examples/qt3d/advancedcustommaterial/doc/src/advancedcustommaterial.qdoc @@ -42,7 +42,7 @@ Advanced custom material example shows more complex shaders, and demonstrates controlling your shader properties with QtQuick user interface and Animation. Water is a 3D mesh, that is modeled and uv mapped inside Blender, and then brought into Scene 3D as an \c {.obj} file. - Shader properties that user can control, are defined in \l {advancedcustommaterial/WaterMaterial.qml}{WaterMaterial}. + Shader properties that user can control, are defined in \c {advancedcustommaterial/WaterMaterial.qml}. \section1 Controls \section2 Texture scale slider @@ -53,7 +53,7 @@ \section2 Texture speed slider Offsets values for texture coordinates which are animated in - \l {advancedcustommaterial/Water.qml}{Water.qml} and then passed to vertex shader. + \c {advancedcustommaterial/Water.qml} and then passed to vertex shader. Creates the effect of textures scrolling over the surface. \section2 Specularity @@ -80,5 +80,5 @@ \section2 Mesh rotation - Rotates the water mesh in \l {advancedcustommaterial/Water.qml}{Water.qml}. + Rotates the water mesh in \c {advancedcustommaterial/Water.qml}. */ diff --git a/examples/qt3d/audio-visualizer-qml/doc/src/audio-visualizer-qml.qdoc b/examples/qt3d/audio-visualizer-qml/doc/src/audio-visualizer-qml.qdoc index 5a204757e..6c0b40301 100644 --- a/examples/qt3d/audio-visualizer-qml/doc/src/audio-visualizer-qml.qdoc +++ b/examples/qt3d/audio-visualizer-qml/doc/src/audio-visualizer-qml.qdoc @@ -41,7 +41,7 @@ \section1 Qt Quick 2D Implementation - The Qt Quick Implementation \l{audio-visualizer-qml/main.qml}{main.qml} of the example uses + The Qt Quick Implementation in \c {audio-visualizer-qml/main.qml} of the example uses \c{MediaPlayer} to play audio content. \snippet audio-visualizer-qml/main.qml 0 @@ -57,8 +57,8 @@ \section1 Qt 3D Implementation - The 3D elements of the example are created in the - \l{audio-visualizer-qml/Visualizer.qml}{Visualizer.qml}. The camera is set to a fixed position + The 3D elements of the example are created in + \c {audio-visualizer-qml/Visualizer.qml}. The camera is set to a fixed position to show the visualized bars from a correct angle. \snippet audio-visualizer-qml/Visualizer.qml 0 @@ -73,7 +73,7 @@ \snippet audio-visualizer-qml/Visualizer.qml 2 - In \l{audio-visualizer-qml/BarEntity.qml}{BarEntity.qml} there are animations for rotating the + In \c {audio-visualizer-qml/BarEntity.qml} there are animations for rotating the bars and changing the bar color. The bars are rotated on a level following a ring form. At the same time the color of the bars is animated. diff --git a/examples/qt3d/planets-qml/doc/src/planets-qml.qdoc b/examples/qt3d/planets-qml/doc/src/planets-qml.qdoc index 2dae457a0..a8c89fbe2 100644 --- a/examples/qt3d/planets-qml/doc/src/planets-qml.qdoc +++ b/examples/qt3d/planets-qml/doc/src/planets-qml.qdoc @@ -50,14 +50,14 @@ \section1 Qt Quick 2D Implementation - The Qt Quick Implementation \l{planets-qml/PlanetsMain.qml}{PlanetsMain.qml} of the + The Qt Quick Implementation in \c {planets-qml/PlanetsMain.qml} of the example renders the 3D content using the \c Scene3D type. \snippet planets-qml/PlanetsMain.qml 0 The planet related information is stored into a \c{ListModel}. The selection buttons for the planets and the information sheet are created based on the model. The 2D elements, selection - buttons and sliders, are implemented in the \l{planets-qml/PlanetsMain.qml}{PlanetsMain.qml}. + buttons and sliders, are implemented in \c {planets-qml/PlanetsMain.qml}. The selection buttons change the \c{focusedPlanet} property of the \c{mainview}. As the property changes, the planet information is updated, and the camera is animated to the new position. @@ -65,14 +65,14 @@ \snippet planets-qml/PlanetsMain.qml 1 The camera position and the camera look at point are updated based on values that are animated - in the \l{planets-qml/SolarSystem.qml}{SolarSystem.qml}, triggered from the + in \c {planets-qml/SolarSystem.qml}, triggered from the \c{changePlanetFocus()} function. \snippet planets-qml/SolarSystem.qml 0 The sliders are used to adjust the rotation speed, the planet size, and the viewing distance. - When a slider value changes, a JavaScript function in \l{planets-qml/SolarSystem.qml} - {SolarSystem.qml} is called to adjust the given property. For example, changing the value of + When a slider value changes, a JavaScript function in \c {planets-qml/SolarSystem.qml} + is called to adjust the given property. For example, changing the value of the \e{Viewing Distance} slider calls the \c{changeCameraDistance()} method. \snippet planets-qml/PlanetsMain.qml 2 @@ -80,7 +80,7 @@ \section1 Qt 3D Implementation The main part of the implementation, including the movement and rotation maths for the planets, - is done in the \l{planets-qml/SolarSystem.qml}{SolarSystem.qml}. + is done in \c {planets-qml/SolarSystem.qml}. First, a \c Camera, a \c{Light}, and a \c Configuration are added, followed by \c{Effect}s for the planet \c{Material}s, and finally the planets themselves. For example, Earth is constructed @@ -89,7 +89,7 @@ \snippet planets-qml/SolarSystem.qml 1 Planet data, which is needed for the movement and rotation calculations, among other things, is - constructed with JavaScript in \l{planets-qml/planets.js}{planets.js} by calling + constructed with JavaScript in \c {planets-qml/planets.js} by calling \c{loadPlanetData()} as the component completes. Other initializations, such as inserting the planets into an array for easier handling, calculating the ring radii for Saturn and Uranus rings, and setting the default scale, speed, and camera offset, are done as well: diff --git a/examples/qt3d/simplecustommaterial/doc/src/simplecustommaterial.qdoc b/examples/qt3d/simplecustommaterial/doc/src/simplecustommaterial.qdoc index d10927d39..7ec7c7abb 100644 --- a/examples/qt3d/simplecustommaterial/doc/src/simplecustommaterial.qdoc +++ b/examples/qt3d/simplecustommaterial/doc/src/simplecustommaterial.qdoc @@ -48,7 +48,7 @@ \section1 Specifying the Material - The material is specified in \l{simplecustommaterial/SimpleMaterial.qml}{SimpleMaterial.qml} + The material is specified in \c {simplecustommaterial/SimpleMaterial.qml} using \l Material type. First the material specifies parameters, which are mapped to the corresponding uniforms in the shaders so that they can be changed from the qml. |