From 220ab35bfd864cb390e9051b9563587319f58bd4 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Thu, 19 Sep 2019 14:30:34 +0200 Subject: Doc: Remove non-existing arguments from docs ...for QSensorGesture::detected() and QSensorGestureRecognizer::detected() Also, the Q_QDOC defines are not needed any more. Change-Id: I3fe2fb779caceeb41187815d272aca053af695b3 Reviewed-by: Paul Wicking --- src/sensors/gestures/qsensorgesture.cpp | 8 +++----- src/sensors/gestures/qsensorgesture.h | 4 +--- src/sensors/gestures/qsensorgesturerecognizer.cpp | 10 +++++++--- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/src/sensors/gestures/qsensorgesture.cpp b/src/sensors/gestures/qsensorgesture.cpp index b643998e..8d5e2ddf 100644 --- a/src/sensors/gestures/qsensorgesture.cpp +++ b/src/sensors/gestures/qsensorgesture.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the QtSensors module of the Qt Toolkit. @@ -71,12 +71,10 @@ \sa QSensorGestureManager */ -#ifdef Q_QDOC /*! - \fn QSensorGesture::detected(QString gestureId) - Signals when the \a gestureId gesture has been recognized. + \fn void QSensorGesture::detected(QString) + Signals when the gesture has been recognized. */ -#endif /*! Constructs the sensor gesture, and initializes the \a ids list of recognizers, diff --git a/src/sensors/gestures/qsensorgesture.h b/src/sensors/gestures/qsensorgesture.h index de727954..53de7630 100644 --- a/src/sensors/gestures/qsensorgesture.h +++ b/src/sensors/gestures/qsensorgesture.h @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the QtSensors module of the Qt Toolkit. @@ -80,12 +80,10 @@ private: const QMetaObject *metaObject() const override; int qt_metacall(QMetaObject::Call, int, void **) override; -#ifdef Q_QDOC Q_SIGNALS: // these signals are created at runtime, along with // gesture recognizer specific signals. void detected(QString); -#endif }; QT_END_NAMESPACE diff --git a/src/sensors/gestures/qsensorgesturerecognizer.cpp b/src/sensors/gestures/qsensorgesturerecognizer.cpp index 9254da28..c992ac01 100644 --- a/src/sensors/gestures/qsensorgesturerecognizer.cpp +++ b/src/sensors/gestures/qsensorgesturerecognizer.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the QtSensors module of the Qt Toolkit. @@ -104,8 +104,12 @@ QT_BEGIN_NAMESPACE */ /*! - \fn QSensorGestureRecognizer::detected(const QString &gestureId) - Signals when the gesture with id \a &gestureId been recognized. + \fn QSensorGestureRecognizer::detected(const QString &) + Signals when a gesture is recognized. Implementors can use this signal to send + recognizer-specific gestures, such as \c detected("shake_left") or implement + custom signals such as \c shakeLeft(). + + The custom signals are available in the QSensorGesture object at runtime. */ class QSensorGestureRecognizerPrivate -- cgit v1.2.3