summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJaishree Vyas <Jaishree.Vyas@qt.io>2023-07-20 16:09:43 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2023-07-24 10:32:58 +0000
commit6495fed18df633bf78488c09b3fb86d92f2458bf (patch)
tree95121854c484a1c4e5e2cee18cde6a6bd4d58cc1
parent94a14868c8ac3341f12624876a438f6451b8f8ff (diff)
Doc: List of all Qt overviews which are now termed as explanation
The autogenerated list of overviews was adding the \group command which included all the groups instead of overviews. The idea here is to categorize the overviews later on once we have the list of all overviews. Task-number: QTBUG-114762 Change-Id: Iab8b6c00f38f0741e200756a178b901f1d195c4f Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> (cherry picked from commit 8c63976cf03cfd150df1e9b8506346f1f8bacd7f) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/scxml/doc/qtscxml-overview.qdoc1
-rw-r--r--src/statemachine/doc/qstatemachine-qml-guide.qdoc1
-rw-r--r--src/statemachine/doc/qtstatemachine-cpp-guide.qdoc1
-rw-r--r--src/statemachine/doc/qtstatemachine-overview.qdoc1
4 files changed, 4 insertions, 0 deletions
diff --git a/src/scxml/doc/qtscxml-overview.qdoc b/src/scxml/doc/qtscxml-overview.qdoc
index 90903e6..8b7f793 100644
--- a/src/scxml/doc/qtscxml-overview.qdoc
+++ b/src/scxml/doc/qtscxml-overview.qdoc
@@ -5,6 +5,7 @@
\page qtscxml-overview.html
\title Qt SCXML Overview
\brief Describes the Qt SCXML module.
+ \ingroup explanation
The Qt SCXML module provides classes for embedding state machines created
from State Chart XML (SCXML) files in Qt applications. The SCXML files
diff --git a/src/statemachine/doc/qstatemachine-qml-guide.qdoc b/src/statemachine/doc/qstatemachine-qml-guide.qdoc
index c05db22..deb9d94 100644
--- a/src/statemachine/doc/qstatemachine-qml-guide.qdoc
+++ b/src/statemachine/doc/qstatemachine-qml-guide.qdoc
@@ -6,6 +6,7 @@
\title Qt State Machine QML Guide
\brief Overview of the Qt State Machine QML for constructing and executing state graphs.
\ingroup technology-apis
+ \ingroup explanation
\tableofcontents
diff --git a/src/statemachine/doc/qtstatemachine-cpp-guide.qdoc b/src/statemachine/doc/qtstatemachine-cpp-guide.qdoc
index 52d2074..a898ba4 100644
--- a/src/statemachine/doc/qtstatemachine-cpp-guide.qdoc
+++ b/src/statemachine/doc/qtstatemachine-cpp-guide.qdoc
@@ -7,6 +7,7 @@
\brief An overview of the State Machine framework for constructing and
executing state graphs with the C++ API.
\ingroup technology-apis
+ \ingroup explanation
\tableofcontents
diff --git a/src/statemachine/doc/qtstatemachine-overview.qdoc b/src/statemachine/doc/qtstatemachine-overview.qdoc
index 63252e8..3438d86 100644
--- a/src/statemachine/doc/qtstatemachine-overview.qdoc
+++ b/src/statemachine/doc/qtstatemachine-overview.qdoc
@@ -6,6 +6,7 @@
\title Qt State Machine Overview
\brief An overview of the State Machine framework for constructing and executing state graphs.
\ingroup technology-apis
+ \ingroup explanation
\tableofcontents