diff options
author | Topi Reinio <topi.reinio@qt.io> | 2019-11-13 09:19:05 +0100 |
---|---|---|
committer | Topi Reinio <topi.reinio@qt.io> | 2019-11-13 11:29:48 +0100 |
commit | 0b5d01eeec9913a0bb0d545b48d13cec8dde5354 (patch) | |
tree | 987a7b04d65b4e27f86687b8eee5e8c16f0ad6e2 /src/animation | |
parent | 8de836c63eb0a0e484ae4c9e02f0a5f23ef49b65 (diff) |
Doc: Fix documentation warnings
- Add (basic) documentation for Qt3DAnimation::QAnimationCallback.
- Add missing namespace qualifiers for \class, \fn, \instantiates,
\sa, and \property commands.
- Remove linking to example file pages, as QDoc no longe treats them
as linkable targets.
- Fix function/QML method parameter documentation
- Fix missing \qmlproperty types
- Fix linking to QKeyEvent in QtGui.
- Move Qt3DRender::Quick namespace documentation to where QDoc can
see it.
- Add enum documentation for
Qt3DRender::QBlitFramebuffer::InterpolationMethod and
Qt3DRender::QMesh::Status.
- Other minor fixes
This brings the current warning count to zero.
Fixes: QTBUG-79822
Change-Id: I1154a7f9c34917a3f240e99da0e7a300be7d65a0
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'src/animation')
-rw-r--r-- | src/animation/frontend/qabstractanimationclip.cpp | 2 | ||||
-rw-r--r-- | src/animation/frontend/qanimationcallback.qdoc | 51 | ||||
-rw-r--r-- | src/animation/frontend/qanimationclip.cpp | 4 | ||||
-rw-r--r-- | src/animation/frontend/qanimationclipdata.cpp | 2 | ||||
-rw-r--r-- | src/animation/frontend/qcallbackmapping.cpp | 2 | ||||
-rw-r--r-- | src/animation/frontend/qchannel.cpp | 2 | ||||
-rw-r--r-- | src/animation/frontend/qchannelmapper.cpp | 2 | ||||
-rw-r--r-- | src/animation/frontend/qchannelmapping.cpp | 2 | ||||
-rw-r--r-- | src/animation/frontend/qclipanimator.cpp | 3 | ||||
-rw-r--r-- | src/animation/frontend/qclipblendvalue.cpp | 4 | ||||
-rw-r--r-- | src/animation/frontend/qmorphtarget.cpp | 4 |
11 files changed, 65 insertions, 13 deletions
diff --git a/src/animation/frontend/qabstractanimationclip.cpp b/src/animation/frontend/qabstractanimationclip.cpp index 53ae46809..08133072c 100644 --- a/src/animation/frontend/qabstractanimationclip.cpp +++ b/src/animation/frontend/qabstractanimationclip.cpp @@ -121,7 +121,7 @@ void QAbstractAnimationClipPrivate::setDuration(float duration) animator->setRunning(true); \endcode - \sa QAnimationClip, QAnimationClipLoader + \sa Qt3DAnimation::QAnimationClip, Qt3DAnimation::QAnimationClipLoader */ /*! diff --git a/src/animation/frontend/qanimationcallback.qdoc b/src/animation/frontend/qanimationcallback.qdoc new file mode 100644 index 000000000..5c6e8e212 --- /dev/null +++ b/src/animation/frontend/qanimationcallback.qdoc @@ -0,0 +1,51 @@ +/**************************************************************************** +** +** Copyright (C) 2019 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \class Qt3DAnimation::QAnimationCallback + \inmodule Qt3DAnimation + \brief Represents an animation callback object. +*/ + +/*! + \enum Qt3DAnimation::QAnimationCallback::Flag + + Flags to indicate how the valueChanged() function is called. + + \value OnOwningThread + Callback function is called on the owning (GUI or main) thread. + \value OnThreadPool + Callback function is called on the thread pool's worker thread. +*/ + +/*! + \fn Qt3DAnimation::QAnimationCallback::valueChanged(const QVariant &value) + + Callback function that is triggered for changes in the animated \a value. + + \sa QCallbackMapping::setCallback() +*/ diff --git a/src/animation/frontend/qanimationclip.cpp b/src/animation/frontend/qanimationclip.cpp index d624a246a..74a9b8371 100644 --- a/src/animation/frontend/qanimationclip.cpp +++ b/src/animation/frontend/qanimationclip.cpp @@ -51,8 +51,8 @@ QAnimationClipPrivate::QAnimationClipPrivate() } /*! - \class QAnimationClip - \inherits QAbstractAnimationClip + \class Qt3DAnimation::QAnimationClip + \inherits Qt3dAnimation::QAbstractAnimationClip \inmodule Qt3DAnimation \brief Specifies key frame animation data. */ diff --git a/src/animation/frontend/qanimationclipdata.cpp b/src/animation/frontend/qanimationclipdata.cpp index 49de71e79..e105b7b43 100644 --- a/src/animation/frontend/qanimationclipdata.cpp +++ b/src/animation/frontend/qanimationclipdata.cpp @@ -53,7 +53,7 @@ public: }; /*! - \class QAnimationClipData + \class Qt3DAnimation::QAnimationClipData \inmodule Qt3DAnimation \brief Class containing the animation data. */ diff --git a/src/animation/frontend/qcallbackmapping.cpp b/src/animation/frontend/qcallbackmapping.cpp index 53f7a5e33..24b5d2e6e 100644 --- a/src/animation/frontend/qcallbackmapping.cpp +++ b/src/animation/frontend/qcallbackmapping.cpp @@ -57,7 +57,7 @@ QCallbackMappingPrivate::QCallbackMappingPrivate() } /*! - \class QCallbackMapping + \class Qt3DAnimation::QCallbackMapping \inherits Qt3DCore::QAbstractChannelMapping \inmodule Qt3DAnimation \brief Allows to map the channels within the clip onto an invocation diff --git a/src/animation/frontend/qchannel.cpp b/src/animation/frontend/qchannel.cpp index eab7f0df4..1e0da3c3f 100644 --- a/src/animation/frontend/qchannel.cpp +++ b/src/animation/frontend/qchannel.cpp @@ -54,7 +54,7 @@ public: }; /*! - \class QChannel + \class Qt3DAnimation::QChannel \inmodule Qt3DAnimation \brief Defines a channel for a QAnimationClipData. The animation system interpolates each channel component independently diff --git a/src/animation/frontend/qchannelmapper.cpp b/src/animation/frontend/qchannelmapper.cpp index ab98039b4..c5909adbc 100644 --- a/src/animation/frontend/qchannelmapper.cpp +++ b/src/animation/frontend/qchannelmapper.cpp @@ -49,7 +49,7 @@ QChannelMapperPrivate::QChannelMapperPrivate() } /*! - \class QChannelMapper + \class Qt3DAnimation::QChannelMapper \inmodule Qt3DAnimation \brief Allows to map the channels within the clip onto properties of objects in the application. diff --git a/src/animation/frontend/qchannelmapping.cpp b/src/animation/frontend/qchannelmapping.cpp index 59620ab49..16651afe6 100644 --- a/src/animation/frontend/qchannelmapping.cpp +++ b/src/animation/frontend/qchannelmapping.cpp @@ -161,7 +161,7 @@ void QChannelMappingPrivate::updatePropertyNameTypeAndComponentCount() } /*! - \class QChannelMapping + \class Qt3DAnimation::QChannelMapping \inherits Qt3DCore::QNode \inmodule Qt3DAnimation \brief Allows to map the channels within the clip onto properties of diff --git a/src/animation/frontend/qclipanimator.cpp b/src/animation/frontend/qclipanimator.cpp index 03510aa93..ffad588c1 100644 --- a/src/animation/frontend/qclipanimator.cpp +++ b/src/animation/frontend/qclipanimator.cpp @@ -107,7 +107,8 @@ bool QClipAnimatorPrivate::canPlay() const The properties for controlling the animator are provided by the QAbstractClipAnimator base class. - \sa QAbstractClipAnimator, QAbstractAnimationClip, QChannelMapper, QBlendedClipAnimator + \sa Qt3DAnimation::QAbstractClipAnimator, Qt3DAnimation::QAbstractAnimationClip, + Qt3DAnimation::QChannelMapper, Qt3DAnimation::QBlendedClipAnimator */ QClipAnimator::QClipAnimator(Qt3DCore::QNode *parent) diff --git a/src/animation/frontend/qclipblendvalue.cpp b/src/animation/frontend/qclipblendvalue.cpp index 72a7dd796..053453e33 100644 --- a/src/animation/frontend/qclipblendvalue.cpp +++ b/src/animation/frontend/qclipblendvalue.cpp @@ -53,14 +53,14 @@ QClipBlendValuePrivate::QClipBlendValuePrivate() } /*! - \class QClipBlendValue + \class Qt3DAnimation::QClipBlendValue \inherits Qt3DAnimation::QAbstractClipBlendNode \inmodule Qt3DAnimation \brief Class used for including a clip in a blend tree. */ /*! \qmltype ClipBlendValue - \instantiates QClipBlendValue + \instantiates Qt3DAnimation::QClipBlendValue \inqmlmodule Qt3D.Animation \brief Type used for including a clip in a blend tree. */ diff --git a/src/animation/frontend/qmorphtarget.cpp b/src/animation/frontend/qmorphtarget.cpp index 76b1a598e..da068d477 100644 --- a/src/animation/frontend/qmorphtarget.cpp +++ b/src/animation/frontend/qmorphtarget.cpp @@ -86,8 +86,8 @@ namespace Qt3DAnimation { */ /*! \qmlmethod MorphTarget Qt3D.Animation::MorphTarget::fromGeometry(geometry, stringList) - Returns a morph target based on the attributes defined by the given stringList from - the given geometry. + Returns a morph target based on the attributes defined by the given \a stringList from + the given \a geometry. */ QMorphTargetPrivate::QMorphTargetPrivate() |