diff options
| author | Nico Vertriest <nico.vertriest@qt.io> | 2018-01-26 16:17:37 +0100 |
|---|---|---|
| committer | Nico Vertriest <nico.vertriest@qt.io> | 2018-02-06 14:07:15 +0000 |
| commit | dc6388e0d7fba2e05346e8e91c9f683742420f98 (patch) | |
| tree | 4e285f2694a7c8208adb767ba18a032467b4a879 /src/animation | |
| parent | 037ef30a55fd6fb730954ec3f7224121c52de95d (diff) | |
Doc: add doc to undocumented methods and properties qt3d
Change-Id: Ia498dd96a6d35997a3f493f26b376fb8fa146196
Reviewed-by: Svenn-Arne Dragly <svenn-arne.dragly@qt.io>
Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
Diffstat (limited to 'src/animation')
| -rw-r--r-- | src/animation/frontend/qanimationcliploader.cpp | 20 | ||||
| -rw-r--r-- | src/animation/frontend/qclipblendvalue.cpp | 5 | ||||
| -rw-r--r-- | src/animation/frontend/qclock.cpp | 5 |
3 files changed, 28 insertions, 2 deletions
diff --git a/src/animation/frontend/qanimationcliploader.cpp b/src/animation/frontend/qanimationcliploader.cpp index 8c59a4e10..f71ca40f7 100644 --- a/src/animation/frontend/qanimationcliploader.cpp +++ b/src/animation/frontend/qanimationcliploader.cpp @@ -61,7 +61,7 @@ void QAnimationClipLoaderPrivate::setStatus(QAnimationClipLoader::Status status) } /*! - \enum QAnimationClipLoader::Status + \enum Qt3DAnimation::QAnimationClipLoader::Status This enum identifies the status of animation clip. @@ -70,7 +70,17 @@ void QAnimationClipLoaderPrivate::setStatus(QAnimationClipLoader::Status status) \value Error An error occurred while loading the clip */ /*! - \class QAnimationClipLoader + \property Qt3DAnimation::QAnimationClipLoader::status + + This property contains the status of the animation clip. +*/ +/*! + \property Qt3DAnimation::QAnimationClipLoader::source + + Holds the source URL from which to load the animation clip. +*/ +/*! + \class Qt3DAnimation::QAnimationClipLoader \inherits QAbstractAnimationClip \inmodule Qt3DAnimation \brief Enables loading key frame animation data from a file @@ -103,6 +113,9 @@ QUrl QAnimationClipLoader::source() const return d->m_source; } +/*! + Returns the status of the animation clip. +*/ QAnimationClipLoader::Status QAnimationClipLoader::status() const { Q_D(const QAnimationClipLoader); @@ -119,6 +132,9 @@ void QAnimationClipLoader::setSource(const QUrl &source) emit sourceChanged(source); } +/*! + \internal +*/ void QAnimationClipLoader::sceneChangeEvent(const Qt3DCore::QSceneChangePtr &change) { Q_D(QAnimationClipLoader); diff --git a/src/animation/frontend/qclipblendvalue.cpp b/src/animation/frontend/qclipblendvalue.cpp index a17c63a69..c20609050 100644 --- a/src/animation/frontend/qclipblendvalue.cpp +++ b/src/animation/frontend/qclipblendvalue.cpp @@ -58,6 +58,11 @@ QClipBlendValuePrivate::QClipBlendValuePrivate() \inmodule Qt3DAnimation \brief Class used for including a clip in a blend tree. */ +/*! + \property Qt3DAnimation::QClipBlendValue::clip + + The animation clip that needs to be included in the blend tree. +*/ QClipBlendValue::QClipBlendValue(Qt3DCore::QNode *parent) : QAbstractClipBlendNode(*new QClipBlendValuePrivate(), parent) { diff --git a/src/animation/frontend/qclock.cpp b/src/animation/frontend/qclock.cpp index 6dd851b88..717982902 100644 --- a/src/animation/frontend/qclock.cpp +++ b/src/animation/frontend/qclock.cpp @@ -61,6 +61,11 @@ QClock::QClock(QClockPrivate &dd, Qt3DCore::QNode *parent) QClock::~QClock() { } +/*! + \property Qt3DAnimation::QClock::playbackRate + + The playback speed of the animation. +*/ double QClock::playbackRate() const { |