diff options
| author | Tomi Korpipää <tomi.korpipaa@theqtcompany.com> | 2016-05-25 07:00:50 +0300 |
|---|---|---|
| committer | Sean Harmer <sean.harmer@kdab.com> | 2016-05-25 19:52:23 +0000 |
| commit | e7171fea8981c695274746449d98f1243e1f6a0b (patch) | |
| tree | a4ffb6997aafef10e3665570f91a18241221d5fa /src/input/frontend/qinputaspect.cpp | |
| parent | 78ce47be07d077f26a1542c8cd84b8f788834e1a (diff) | |
Add doc skeleton for Qt3DInput
Conflicts:
src/input/frontend/qanalogaxisinput.cpp
src/input/frontend/qaxis.cpp
src/input/frontend/qaxissetting.cpp
src/input/frontend/qbuttonaxisinput.cpp
src/input/frontend/qinputsettings.cpp
src/input/frontend/qmousedevice.cpp
Change-Id: Ic3e06179f745520d9c49af8d8242af360cbd20d8
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
Diffstat (limited to 'src/input/frontend/qinputaspect.cpp')
| -rw-r--r-- | src/input/frontend/qinputaspect.cpp | 24 |
1 files changed, 23 insertions, 1 deletions
diff --git a/src/input/frontend/qinputaspect.cpp b/src/input/frontend/qinputaspect.cpp index 0a364e27b..fbd7674d8 100644 --- a/src/input/frontend/qinputaspect.cpp +++ b/src/input/frontend/qinputaspect.cpp @@ -104,10 +104,15 @@ QInputAspectPrivate::QInputAspectPrivate() /*! \class Qt3DInput::QInputAspect + \inherits Qt3DCore::QAbstractAspect \inmodule Qt3DInput + \brief A QInputAspect class. \since 5.5 */ +/*! + * Constructs a new QInputAspect with \a parent. + */ QInputAspect::QInputAspect(QObject *parent) : QInputAspect(*new QInputAspectPrivate, parent) { @@ -167,7 +172,12 @@ void QInputAspectPrivate::loadInputDevicePlugins() } } -// Note: caller is responsible for ownership + +/*! + Creates a physical device with \a name. + + \note The caller is responsible for ownership. + */ QAbstractPhysicalDevice *QInputAspect::createPhysicalDevice(const QString &name) { Q_D(QInputAspect); @@ -179,6 +189,9 @@ QAbstractPhysicalDevice *QInputAspect::createPhysicalDevice(const QString &name) return nullptr; } +/*! + \return a list of all available physical devices. + */ QStringList QInputAspect::availablePhysicalDevices() const { Q_D(const QInputAspect); @@ -189,6 +202,9 @@ QStringList QInputAspect::availablePhysicalDevices() const return deviceNamesList; } +/*! + \internal + */ QVector<QAspectJobPtr> QInputAspect::jobsToExecute(qint64 time) { Q_UNUSED(time); @@ -220,6 +236,9 @@ QVector<QAspectJobPtr> QInputAspect::jobsToExecute(qint64 time) return jobs; } +/*! + \internal + */ void QInputAspect::onRegistered() { Q_D(QInputAspect); @@ -230,6 +249,9 @@ void QInputAspect::onRegistered() d->m_inputHandler->eventSourceHelper()->setEventFilterService(eventService); } +/*! + \internal + */ void QInputAspect::onUnregistered() { Q_D(QInputAspect); |