From 858ce104340ca6727786c51d42035cb1ee195fbc Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Tue, 28 Feb 2017 13:42:44 +0100 Subject: Doc: Fix \brief and \return commands (QAbstract3dInputHandler) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I68118110654675af9e4c514a48a78f501597e54a Reviewed-by: Tomi Korpipää --- .../input/qabstract3dinputhandler.cpp | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) (limited to 'src/datavisualization/input/qabstract3dinputhandler.cpp') diff --git a/src/datavisualization/input/qabstract3dinputhandler.cpp b/src/datavisualization/input/qabstract3dinputhandler.cpp index 2f4629ae..d0ab00a1 100644 --- a/src/datavisualization/input/qabstract3dinputhandler.cpp +++ b/src/datavisualization/input/qabstract3dinputhandler.cpp @@ -148,8 +148,14 @@ void QAbstract3DInputHandler::wheelEvent(QWheelEvent *event) /*! * \property QAbstract3DInputHandler::inputView * - * Current enumerated input view based on the view of the processed input events. - * When the view changes \c inputViewChanged signal is emitted. + * \brief The current enumerated input view based on the view of the processed + * input events. + * + * One of the InputView enum values. + * + * When the view changes, the \c inputViewChanged signal is emitted. + * + * \sa InputView */ QAbstract3DInputHandler::InputView QAbstract3DInputHandler::inputView() const { @@ -167,7 +173,7 @@ void QAbstract3DInputHandler::setInputView(InputView inputView) /*! * \property QAbstract3DInputHandler::inputPosition * - * Last input position based on the processed input events. + * \brief The last input position based on the processed input events. */ QPoint QAbstract3DInputHandler::inputPosition() const { @@ -183,7 +189,7 @@ void QAbstract3DInputHandler::setInputPosition(const QPoint &position) } /*! - * \return the manhattan length between last two input positions. + * Returns the manhattan length between last two input positions. */ int QAbstract3DInputHandler::prevDistance() const { @@ -201,9 +207,10 @@ void QAbstract3DInputHandler::setPrevDistance(int distance) /*! * \property QAbstract3DInputHandler::scene * - * The 3D scene this abstract input handler is controlling. Only one scene can - * be controlled by one input handler. Setting a \a scene to an input handler doesn't - * transfer the ownership of the \a scene. + * \brief The 3D scene this abstract input handler is controlling. + * + * One input handler can control one scene. Setting a scene to an input handler + * does not transfer the ownership of the scene. */ Q3DScene *QAbstract3DInputHandler::scene() const { @@ -228,7 +235,6 @@ void QAbstract3DInputHandler::setPreviousInputPos(const QPoint &position) /*! * Returns the previous input position. - * \return Previous input position. */ QPoint QAbstract3DInputHandler::previousInputPos() const { -- cgit v1.2.3