summaryrefslogtreecommitdiffstats
path: root/src/extras/defaults
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2018-04-20 10:26:56 +0200
committerTopi Reiniƶ <topi.reinio@qt.io>2018-04-20 10:17:18 +0000
commitdcda92d3094f35c50c3665059df1b237bf4904b8 (patch)
tree67d674255dc29cc237f49f6b0d1940679e71d077 /src/extras/defaults
parentbb09fa7b64b288a68edc61c52ea8467f96eb3924 (diff)
Doc: Fix documentation warnings related to Clang QDoc parser
Since Qt 5.11, QDoc uses Clang to parse C++ documentation. Clang requires a module header, as well as proper include paths, to build a precompiled header and process the sources. To do this, add a custom module header that pulls in all Qt 3D modules - this way, we can continue using a single documentation project to covers all of Qt 3D. Fix all documentation warnings are caused by missing namespaces, QML module/type names and typos, as well as a number of linking problems and other minor issues. After this change, the remaining documentation issues consist of 'No documentation for ...' warnings. Task-number: QTBUG-67790 Change-Id: I38b91163c475a00cc1893e793240470c5409eb57 Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'src/extras/defaults')
-rw-r--r--src/extras/defaults/qabstractcameracontroller.cpp16
1 files changed, 8 insertions, 8 deletions
diff --git a/src/extras/defaults/qabstractcameracontroller.cpp b/src/extras/defaults/qabstractcameracontroller.cpp
index aaef1d2d7..527ee7e8d 100644
--- a/src/extras/defaults/qabstractcameracontroller.cpp
+++ b/src/extras/defaults/qabstractcameracontroller.cpp
@@ -257,7 +257,7 @@ void QAbstractCameraControllerPrivate::applyInputAccelerations()
*/
/*!
- \fn void QAbstractCameraController::moveCamera(const InputState &state, float dt) = 0
+ \fn void Qt3DExtras::QAbstractCameraController::moveCamera(const InputState &state, float dt) = 0
This method is called whenever a frame action is triggered. Derived
classes must override this method to implement the camera movement
@@ -305,7 +305,7 @@ QAbstractCameraController::~QAbstractCameraController()
}
/*!
- \property QAbstractCameraController::camera
+ \property Qt3DExtras::QAbstractCameraController::camera
Holds the currently controlled camera.
*/
@@ -316,12 +316,12 @@ Qt3DRender::QCamera *QAbstractCameraController::camera() const
}
/*!
- \property QAbstractCameraController::linearSpeed
+ \property Qt3DExtras::QAbstractCameraController::linearSpeed
Holds the current linear speed of the camera controller. Linear speed determines the
movement speed of the camera.
- The default is 10.0.
+ The default is \c {10.0}.
*/
float QAbstractCameraController::linearSpeed() const
{
@@ -330,12 +330,12 @@ float QAbstractCameraController::linearSpeed() const
}
/*!
- \property QAbstractCameraController::lookSpeed
+ \property Qt3DExtras::QAbstractCameraController::lookSpeed
Holds the current look speed of the camera controller. The look speed determines the turn rate
of the camera pan and tilt.
- The default is 180.0.
+ The default is \c {180.0}.
*/
float QAbstractCameraController::lookSpeed() const
{
@@ -344,7 +344,7 @@ float QAbstractCameraController::lookSpeed() const
}
/*!
- \property QAbstractCameraController::acceleration
+ \property Qt3DExtras::QAbstractCameraController::acceleration
Holds the current acceleration of the camera controller.
*/
@@ -355,7 +355,7 @@ float QAbstractCameraController::acceleration() const
}
/*!
- \property QAbstractCameraController::deceleration
+ \property Qt3DExtras::QAbstractCameraController::deceleration
Holds the current deceleration of the camera controller.
*/