From 0b5d01eeec9913a0bb0d545b48d13cec8dde5354 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Wed, 13 Nov 2019 09:19:05 +0100 Subject: Doc: Fix documentation warnings MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 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ö --- examples/qt3d/planets-qml/doc/src/planets-qml.qdoc | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'examples/qt3d/planets-qml') 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: -- cgit v1.2.3