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/audio-visualizer-qml | |
| 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/audio-visualizer-qml')
| -rw-r--r-- | examples/qt3d/audio-visualizer-qml/doc/src/audio-visualizer-qml.qdoc | 8 |
1 files changed, 4 insertions, 4 deletions
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. |