diff options
author | Nico Vertriest <nico.vertriest@qt.io> | 2017-05-22 14:53:27 +0200 |
---|---|---|
committer | Nico Vertriest <nico.vertriest@qt.io> | 2017-06-09 08:11:10 +0000 |
commit | b2ae5770b5fe26672881a38fbb77c0765d360c22 (patch) | |
tree | a7fae13aa0bd460fb4c4d12a7161b6bc17ecaf96 /src/animation/frontend | |
parent | 842b8fa5ef41135cc58a98e15d56497482dc5619 (diff) |
Doc: add basic doc to undocumented classes
Change-Id: Ib67712bd961a3e0b113ddd25feaa819695e792b9
Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
Diffstat (limited to 'src/animation/frontend')
-rw-r--r-- | src/animation/frontend/qanimationclipdata.cpp | 5 | ||||
-rw-r--r-- | src/animation/frontend/qchannelmapper.cpp | 7 | ||||
-rw-r--r-- | src/animation/frontend/qkeyframe.cpp | 5 |
3 files changed, 17 insertions, 0 deletions
diff --git a/src/animation/frontend/qanimationclipdata.cpp b/src/animation/frontend/qanimationclipdata.cpp index ef3b59012..fe5e7c1e0 100644 --- a/src/animation/frontend/qanimationclipdata.cpp +++ b/src/animation/frontend/qanimationclipdata.cpp @@ -52,6 +52,11 @@ public: QString m_name; }; +/*! + \class QAnimationClipData + \inmodule Qt3DAnimation + \brief Class containing the animation data +*/ QAnimationClipData::QAnimationClipData() : d(new QAnimationClipDataPrivate) { diff --git a/src/animation/frontend/qchannelmapper.cpp b/src/animation/frontend/qchannelmapper.cpp index ee2e54267..ef7353e9b 100644 --- a/src/animation/frontend/qchannelmapper.cpp +++ b/src/animation/frontend/qchannelmapper.cpp @@ -49,6 +49,13 @@ QChannelMapperPrivate::QChannelMapperPrivate() { } +/*! + \class QChannelMapper + \inmodule Qt3DAnimation + \brief Allows to map the channels within the clip onto properties of + objects in the application + +*/ QChannelMapper::QChannelMapper(Qt3DCore::QNode *parent) : Qt3DCore::QNode(*new QChannelMapperPrivate, parent) { diff --git a/src/animation/frontend/qkeyframe.cpp b/src/animation/frontend/qkeyframe.cpp index b3d339bf4..1d63af3ab 100644 --- a/src/animation/frontend/qkeyframe.cpp +++ b/src/animation/frontend/qkeyframe.cpp @@ -43,6 +43,11 @@ QT_BEGIN_NAMESPACE namespace Qt3DAnimation { +/*! + \class QKeyframe + \inmodule Qt3DAnimation + \brief A base class for handling keyframes +*/ } // namespace Qt3DAnimation |