Enable animations doc generation

Change-Id: Ia7e725b34b7a180dfbc920e7a65db70dac9ddd66
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>

4 files changed, 113 insertions, 5 deletions

diff --git a/src/doc/qt3d.qdocconf b/src/doc/qt3d.qdocconf
index 623a2c5d5..941c9e3f6 100644
--- a/src/doc/qt3d.qdocconf
+++ b/src/doc/qt3d.qdocconf
@@ -47,7 +47,8 @@ headerdirs += . \
               ../plugins \
               ../quick3d/quick3d \
               ../input \
-              ../extras
+              ../extras \
+              ../animation
 
 # Exclude private header files from the documentation build
 excludefiles += "*_p.h"
@@ -59,7 +60,8 @@ sourcedirs += . \
               ../plugins \
               ../quick3d/quick3d \
               ../input \
-              ../extras
+              ../extras \
+              ../animation
 
 exampledirs += ../../examples/qt3d \
                snippets
@@ -83,7 +85,8 @@ Cpp.ignoretokens     += QT3DINPUTSHARED_EXPORT \
                         QT3DRENDERSHARED_EXPORT \
                         QT3DRENDERSHARED_PRIVATE_EXPORT \
                         QT3DQUICKSHARED_PRIVATE_EXPORT \
-                        QT3DEXTRASSHARED_EXPORT
+                        QT3DEXTRASSHARED_EXPORT \
+                        QT3DANIMATIONSHARED_EXPORT
 
 Cpp.ignoredirectives += Q_DECLARE_LOGGING_CATEGORY
 
diff --git a/src/doc/src/qt3d-index.qdoc b/src/doc/src/qt3d-index.qdoc
index f14909cec..2031fcfdc 100644
--- a/src/doc/src/qt3d-index.qdoc
+++ b/src/doc/src/qt3d-index.qdoc
@@ -61,7 +61,7 @@
     \l qmake \c .pro file:
 
     \badcode
-    QT += 3dcore 3drender 3dinput 3dlogic 3dextras
+    QT += 3dcore 3drender 3dinput 3dlogic 3dextras 3danimation
     \endcode
 
     To include the definitions of the modules' classes, use the following
@@ -73,12 +73,13 @@
     #include <Qt3DInput>
     #include <Qt3DLogic>
     #include <Qt3DExtras>
+    #include <Qt3DAnimation>
     \endcode
 
     A Qt Quick application requires also additional dependencies:
 
     \badcode
-    QT += 3dcore 3drender 3dinput 3dlogic 3dextras qml quick 3dquick
+    QT += 3dcore 3drender 3dinput 3dlogic 3dextras qml quick 3dquick 3danimation
     \endcode
 
     \section1 Overview
diff --git a/src/doc/src/qt3d-module.qdoc b/src/doc/src/qt3d-module.qdoc
index c82c528f1..0c3d14b56 100644
--- a/src/doc/src/qt3d-module.qdoc
+++ b/src/doc/src/qt3d-module.qdoc
@@ -77,6 +77,9 @@
 
     \section2 Qt 3D Extras Module
     \generatelist {classesbymodule Qt3DExtras}
+
+    \section2 Qt 3D Animation Module
+    \generatelist {classesbymodule Qt3DAnimation}
 */
 
 /*!
@@ -111,6 +114,7 @@
    import Qt3D.Input 2.0
    import Qt3D.Logic 2.0
    import Qt3D.Extras 2.0
+   import Qt3D.Animation 2.0
    \endcode
 
    \section1 QML Types
@@ -131,4 +135,8 @@
    \section2 Qt 3D Extras Module
    \generatelist {qmltypesbymodule Qt3D.Extras}
    \noautolist
+
+   \section2 Qt 3D Animation Module
+   \generatelist {qmltypesbymodule Qt3D.Animation}
+   \noautolist
 */
diff --git a/src/doc/src/qt3danimation-module.qdoc b/src/doc/src/qt3danimation-module.qdoc
new file mode 100644
index 000000000..294edb0e7
--- /dev/null
+++ b/src/doc/src/qt3danimation-module.qdoc
@@ -0,0 +1,96 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 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$
+**
+****************************************************************************/
+
+/*!
+    \module Qt3DAnimation
+    \title Qt 3D Animation C++ Classes
+
+    \brief The Qt 3D Animation modules provides a set of prebuilt elements to help
+    you get started with Qt 3D.
+
+    This module is still in tech preview. This means it is unstable, likely to
+    change and provided as a convenience only.
+
+    \ingroup modules
+    \ingroup qt3d-modules
+    \qtvariable 3danimation
+
+    \code
+       #include <Qt3DAnimation>
+    \endcode
+
+    To link against the corresponding C++ library, add the following to your qmake project file:
+
+    \badcode
+       QT += 3danimation
+    \endcode
+
+    Classes, types, and functions are declared under the \l [Qt3DAnimation]{Qt3DAnimation} namespace.
+
+    \section1 Overview
+
+    \section2 Animations
+
+    \list
+    \li Qt3DAnimation::QKeyframeAnimation
+    \endlist
+
+    \section2 Clip animations
+
+    \list
+    \li Qt3DAnimation::QAnimationClip
+    \endlist
+
+    \section1 Reference
+    \list
+    \li \l {Qt 3D Animation C++ Classes}
+    \li \l {Qt 3D Examples}
+    \endlist
+ */
+
+/*!
+    \namespace Qt3DAnimation
+    \inmodule Qt3DAnimation
+    \ingroup qt3d-namespaces
+
+    \brief Contains classes from the Qt3DAnimation module.
+*/
+
+/*!
+   \qmlmodule Qt3D.Animation 2.0
+   \title Qt 3D Qt3DAnimation QML Types
+   \ingroup qmlmodules
+   \ingroup qt3d-qmlmodules
+
+   \brief Provides Qt 3D QML types for the animation module.
+
+   To import and use the module's QML types, use the following statement:
+
+   \badcode
+   import Qt3D.Animation 2.0
+   \endcode
+*/