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/advancedcustommaterial/doc | |
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/advancedcustommaterial/doc')
-rw-r--r-- | examples/qt3d/advancedcustommaterial/doc/src/advancedcustommaterial.qdoc | 6 |
1 files changed, 3 insertions, 3 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}. */ |