summaryrefslogtreecommitdiffstats
path: root/src/logic
diff options
context:
space:
mode:
authorColin Ogilvie <colin.ogilvie@kdab.com>2016-05-23 13:07:58 +0100
committerSean Harmer <sean.harmer@kdab.com>2016-05-28 16:01:22 +0000
commitb97129b6a893761e7dd636d7114befc40679b772 (patch)
treebbed8d6be612ed41319314cb6aea43f4df64649b /src/logic
parentc55e51e17dcaecac7cb2f7f53c656636f1fdf1bf (diff)
added skeleton doc to logic module
Task-number: QTBUG-46037 Change-Id: Id38721e9f0c4dd57aa1135253e30069ec9823bc9 Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
Diffstat (limited to 'src/logic')
-rw-r--r--src/logic/qlogicaspect.cpp14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/logic/qlogicaspect.cpp b/src/logic/qlogicaspect.cpp
index 560282e95..816cbf442 100644
--- a/src/logic/qlogicaspect.cpp
+++ b/src/logic/qlogicaspect.cpp
@@ -58,6 +58,14 @@ using namespace Qt3DCore;
namespace Qt3DLogic {
+/*!
+ \class Qt3DLogic::QLogicAspect
+ \inherits Qt3DCore::QAbstractAspect
+ \inmodule Qt3DLogic
+ \brief Responsible for handling frame synchronization jobs.
+ \since 5.7
+*/
+
QLogicAspectPrivate::QLogicAspectPrivate()
: QAbstractAspectPrivate()
, m_time(0)
@@ -83,6 +91,9 @@ void QLogicAspectPrivate::registerBackendTypes()
q->registerBackendType<QFrameAction>(QBackendNodeMapperPtr(new Logic::HandlerFunctor(m_manager.data())));
}
+/*!
+ Constructs a new Qt3DLogic::QLogicAspect instance with /a parent.
+*/
QLogicAspect::QLogicAspect(QObject *parent)
: QLogicAspect(*new QLogicAspectPrivate(), parent) {}
@@ -101,6 +112,7 @@ QLogicAspect::~QLogicAspect()
{
}
+/*! \internal */
QVector<QAspectJobPtr> QLogicAspect::jobsToExecute(qint64 time)
{
Q_D(QLogicAspect);
@@ -115,10 +127,12 @@ QVector<QAspectJobPtr> QLogicAspect::jobsToExecute(qint64 time)
return jobs;
}
+/*! \internal */
void QLogicAspect::onRegistered()
{
}
+/*! \internal */
void QLogicAspect::onEngineStartup()
{
Q_D(QLogicAspect);