aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2023-12-11 17:47:39 +0000
committerTopi Reinio <topi.reinio@qt.io>2023-12-13 08:54:19 +0000
commitfbb7bb705266da7ee965d7ce545f7073c0396e87 (patch)
treef25c4af96c030bb5ccc4c77fe7b766bcebdebd07 /src
parent2d40318f677692178319cb5e371977ac1b42ad90 (diff)
Doc: Merge BlendTrees sub-module docs with the main Timeline project
There is no real need to maintain a separate documentation project for QtQuick.Timeline.BlendTrees QML module; create a \qmlmodule page for it, and list its types also in the main landing page of 'Qt Quick Timeline QML Types'. Add \since information for the new module. Pick-to: 6.7 Change-Id: I71a24762d74d65f9d6aa6ee441f32b1341547043 Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
Diffstat (limited to 'src')
-rw-r--r--src/timeline/blendtrees/CMakeLists.txt4
-rw-r--r--src/timeline/blendtrees/doc/qtquicktimelineblendtrees.qdocconf43
-rw-r--r--src/timeline/blendtrees/doc/src/qtquicktimelineblendtrees-module-qml.qdoc20
-rw-r--r--src/timeline/doc/src/qtquicktimeline-module-qml.qdoc16
4 files changed, 36 insertions, 47 deletions
diff --git a/src/timeline/blendtrees/CMakeLists.txt b/src/timeline/blendtrees/CMakeLists.txt
index c034b5e..193b54f 100644
--- a/src/timeline/blendtrees/CMakeLists.txt
+++ b/src/timeline/blendtrees/CMakeLists.txt
@@ -27,7 +27,3 @@ qt_internal_add_qml_module(QuickTimelineBlendTrees
GENERATE_CPP_EXPORTS
GENERATE_PRIVATE_CPP_EXPORTS
)
-
-qt_internal_add_docs(QuickTimelineBlendTrees
- doc/qtquicktimelineblendtrees.qdocconf
-)
diff --git a/src/timeline/blendtrees/doc/qtquicktimelineblendtrees.qdocconf b/src/timeline/blendtrees/doc/qtquicktimelineblendtrees.qdocconf
deleted file mode 100644
index 4848ed4..0000000
--- a/src/timeline/blendtrees/doc/qtquicktimelineblendtrees.qdocconf
+++ /dev/null
@@ -1,43 +0,0 @@
-include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
-
-project = QtQuickTimelineBlendTrees
-description = Qt Quick Timeline Blend Trees Reference Documentation
-version = $QT_VERSION
-buildversion = Qt Quick Timeline Blend Trees | Commercial or GPLv3
-
-examplesinstallpath = qtquicktimelineblendtrees
-
-qhp.projects = QtQuickTimelineBlendTrees
-
-qhp.QtQuickTimelineBlendTrees.file = qtquicktimelineblendtrees.qhp
-qhp.QtQuickTimelineBlendTrees.namespace = org.qt-project.qtquicktimelineblendtrees.$QT_VERSION_TAG
-qhp.QtQuickTimelineBlendTrees.virtualFolder = qtquicktimelineblendtrees
-qhp.QtQuickTimelineBlendTrees.indexTitle = Qt Quick Timeline Blend Trees
-qhp.QtQuickTimelineBlendTrees.indexRoot =
-
-qhp.QtQuickTimelineBlendTrees.subprojects = qmltypes
-
-qhp.QtQuickTimelineBlendTrees.subprojects.qmltypes.title = QML Types
-qhp.QtQuickTimelineBlendTrees.subprojects.qmltypes.indexTitle = Qt Quick Timeline Blend Trees QML Types
-qhp.QtQuickTimelineBlendTrees.subprojects.qmltypes.selectors = qmlclass
-qhp.QtQuickTimelineBlendTrees.subprojects.qmltypes.sortPages = true
-
-#qhp.QtQuickTimelineBlendTrees.subprojects.examples.title = Examples
-#qhp.QtQuickTimelineBlendTrees.subprojects.examples.indexTitle = Qt Qt Quick Timeline Blend Trees Examples
-#qhp.QtQuickTimelineBlendTrees.subprojects.examples.selectors = fake:example
-#qhp.QtQuickTimelineBlendTrees.subprojects.examples.sortPages = true
-
-headerdirs += ..
-sourcedirs += ..
-#exampledirs =
-imagedirs += images \
-
-depends += qtcore qtdoc qtqml qtquick qtquicktimeline
-
-tagfile = qtquicktimelineblendtrees.tags
-
-#add generic thumbnail images for example documentation that does not have an image.
-#manifestmeta.thumbnail.names +=
-
-navigation.landingpage = "Qt Quick Timeline Blend Trees"
-navigation.qmltypespage = "Qt Quick Timeline Blend Trees QML Types"
diff --git a/src/timeline/blendtrees/doc/src/qtquicktimelineblendtrees-module-qml.qdoc b/src/timeline/blendtrees/doc/src/qtquicktimelineblendtrees-module-qml.qdoc
new file mode 100644
index 0000000..503c382
--- /dev/null
+++ b/src/timeline/blendtrees/doc/src/qtquicktimelineblendtrees-module-qml.qdoc
@@ -0,0 +1,20 @@
+// Copyright (C) 2023 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+
+/*!
+ \qmlmodule QtQuick.Timeline.BlendTrees
+ \title Qt Quick Timeline Blend Trees QML Types
+ \since 6.7
+
+ \brief Provides QML types for blending multiple \l {TimelineAnimation}s
+ together, creating new dynamic animations.
+
+//! [usage]
+ To import the QML types into your application, use the following import
+ statement in your .qml file:
+
+ \qml
+ import QtQuick.Timeline.BlendTrees
+ \endqml
+//! [usage]
+*/
diff --git a/src/timeline/doc/src/qtquicktimeline-module-qml.qdoc b/src/timeline/doc/src/qtquicktimeline-module-qml.qdoc
index 4c1354d..e264b5b 100644
--- a/src/timeline/doc/src/qtquicktimeline-module-qml.qdoc
+++ b/src/timeline/doc/src/qtquicktimeline-module-qml.qdoc
@@ -8,10 +8,26 @@
\brief Provides QML types to use timelines and keyframes to animate Qt Quick
user interfaces.
+ \section1 QtQuick.Timeline import
+
To import the QML types into your application, use the following import
statement in your .qml file:
\qml
import QtQuick.Timeline
\endqml
+
+ \generatelist qmltypesbymodule QtQuick.Timeline
+
+
+ \section1 QtQuick.Timeline.BlendTrees import
+
+ The \BlendTrees submodule provides QML types for blending multiple
+ \l {TimelineAnimation}s together, creating new dynamic animations.
+
+ \include qtquicktimelineblendtrees-module-qml.qdoc usage
+
+ \generatelist qmltypesbymodule QtQuick.Timeline.BlendTrees
+
+ \noautolist
*/