diff options
author | Topi Reinio <topi.reinio@digia.com> | 2015-11-04 12:47:51 +0100 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@theqtcompany.com> | 2015-11-23 14:15:40 +0000 |
commit | 85ffad3142cd4c3baa0bb77b0674a17287b01534 (patch) | |
tree | d0ab865a944d837b965546248b19e1ab69e99a82 /src/core/services | |
parent | ed9628c87fac466ee6106d12996373ddf56f2c73 (diff) |
Doc: Fix QDoc warnings and do further cleanup
Fix the documentation issues that still remained broken after
renaming the namespaces/QML modules. Do further cleanup and
minor doc editing.
Change-Id: Iff38c8c1b99e7f712dc3f9ad07ecd37a747b3a26
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Diffstat (limited to 'src/core/services')
-rw-r--r-- | src/core/services/qabstractframeadvanceservice.cpp | 4 | ||||
-rw-r--r-- | src/core/services/qeventfilterservice.cpp | 17 | ||||
-rw-r--r-- | src/core/services/qsysteminformationservice.cpp | 4 | ||||
-rw-r--r-- | src/core/services/qtickclockservice.cpp | 8 |
4 files changed, 13 insertions, 20 deletions
diff --git a/src/core/services/qabstractframeadvanceservice.cpp b/src/core/services/qabstractframeadvanceservice.cpp index c163cdf7f..a396a718a 100644 --- a/src/core/services/qabstractframeadvanceservice.cpp +++ b/src/core/services/qabstractframeadvanceservice.cpp @@ -49,7 +49,7 @@ namespace Qt3DCore { /*! \class Qt3DCore::QAbstractFrameAdvanceService \inmodule Qt3DCore - \brief Interface for a Qt3D frame advance service + \brief Interface for a Qt3D frame advance service. This is an interface class that should be subclassed by providers of the frame advance service. When used with the Renderer aspect, the aspect needs to @@ -72,7 +72,7 @@ QAbstractFrameAdvanceService::QAbstractFrameAdvanceService(QAbstractFrameAdvance } /*! - \fn qint64 Qt3DCore::QAbstractFrameAdvanceService::waitForNextTick() + \fn qint64 Qt3DCore::QAbstractFrameAdvanceService::waitForNextFrame() Returns the current time, the call may be blocking if waiting for a tick. */ diff --git a/src/core/services/qeventfilterservice.cpp b/src/core/services/qeventfilterservice.cpp index 1b0a262fb..36a39116f 100644 --- a/src/core/services/qeventfilterservice.cpp +++ b/src/core/services/qeventfilterservice.cpp @@ -57,9 +57,6 @@ bool operator <(const FilterPriorityPair &a, const FilterPriorityPair &b) return a.priority < b.priority; } -/*! - \internal - */ class InternalEventListener : public QObject { Q_OBJECT @@ -111,9 +108,6 @@ private: } // anonymous -/*! - \internal - */ class QEventFilterServicePrivate : public QAbstractServiceProviderPrivate { public: @@ -125,13 +119,16 @@ public: }; - /*! \class Qt3DCore::QEventFilterService + \inmodule Qt3DCore + + \brief Allows to register event filters with a priority. - \brief Allows to register event filters with a priority. Events are dispatched - to the event filter with the highest priority first, and then propagates to - lower priority event filters if the event wasn't accepted. + The QEventFilterService class allows registering prioritized event filters. + Events are dispatched to the event filter with the highest priority first, + and then propagates to lower priority event filters if the event wasn't + accepted. */ QEventFilterService::QEventFilterService() diff --git a/src/core/services/qsysteminformationservice.cpp b/src/core/services/qsysteminformationservice.cpp index c5a7269d1..73148932b 100644 --- a/src/core/services/qsysteminformationservice.cpp +++ b/src/core/services/qsysteminformationservice.cpp @@ -79,14 +79,14 @@ QSystemInformationService::QSystemInformationService(QSystemInformationServicePr } /*! - \fn QStringList Qt3DCore::QSystemInformationService::aspectNames() + \fn QStringList Qt3DCore::QSystemInformationService::aspectNames() const Subclasses should override this function and return a string list containing the names of all registered aspects. */ /*! - \fn int threadPoolThreadCount() const + \fn int Qt3DCore::QSystemInformationService::threadPoolThreadCount() const Subclasses should override this function and return the number of threads in the Qt3D task manager's threadpool. diff --git a/src/core/services/qtickclockservice.cpp b/src/core/services/qtickclockservice.cpp index aebea9745..f13dbfdc5 100644 --- a/src/core/services/qtickclockservice.cpp +++ b/src/core/services/qtickclockservice.cpp @@ -41,10 +41,6 @@ QT_BEGIN_NAMESPACE namespace Qt3DCore { -/*! - \class Qt3DCore::QTickClockServicePrivate - \internal -*/ class QTickClockServicePrivate : public QAbstractFrameAdvanceServicePrivate { @@ -62,9 +58,9 @@ public: /*! \class Qt3DCore::QTickClockService \inmodule Qt3DCore - \brief Default Qt3DCore::QAbstractFrameAdvanceService implementation. + \brief Default QAbstractFrameAdvanceService implementation. - This default Qt3DCore::QAbstractFrameAdvanceService implementation has a frequency of 60 Hz. + This default QAbstractFrameAdvanceService implementation has a frequency of 60 Hz. */ QTickClockService::QTickClockService() : QAbstractFrameAdvanceService(*new QTickClockServicePrivate()) |