summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJuha Vuolle <juha.vuolle@qt.io>2023-02-21 15:05:36 +0200
committerJuha Vuolle <juha.vuolle@qt.io>2023-02-24 11:27:58 +0200
commitb3157afc0fe264c1c9538ecb92064b3131012a6d (patch)
tree34f9e934a11951c6f02659f8f3e9639d2031812e
parent7b2ec8d900d7e2553e00d3edc8d64c6177d8c8c1 (diff)
Adjust the example names
According to current example conventions in https://wiki.qt.io/Qt6/Example-Guideline#Naming_the_example Task-number: QTBUG-111323 Change-Id: Ib7f13bd1a147168c6df13b126daac4bf1daf405d Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> (cherry picked from commit 2d6788cc68fd1cfafa5850da50c6eab80e26eb31) Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
-rw-r--r--examples/scxml/calculator/doc/src/calculator.qdoc4
-rw-r--r--examples/scxml/ftpclient/doc/src/ftpclient.qdoc2
-rw-r--r--examples/scxml/invoke/doc/src/invoke.qdoc4
-rw-r--r--examples/scxml/mediaplayer/doc/src/mediaplayer.qdoc4
-rw-r--r--examples/scxml/sudoku/doc/src/sudoku.qdoc2
-rw-r--r--examples/scxml/trafficlight-qml-dynamic/doc/src/trafficlight-qml-dynamic.qdoc4
-rw-r--r--examples/scxml/trafficlight-qml-simple/doc/src/trafficlight-qml-simple.qdoc4
-rw-r--r--examples/scxml/trafficlight-qml-static/doc/src/trafficlight-qml-static.qdoc4
-rw-r--r--examples/scxml/trafficlight-widgets-dynamic/doc/src/trafficlight-widgets-dynamic.qdoc4
-rw-r--r--examples/scxml/trafficlight-widgets-static/doc/src/trafficlight-widgets-static.qdoc2
-rw-r--r--src/scxml/qscxmlcppdatamodel.cpp2
11 files changed, 18 insertions, 18 deletions
diff --git a/examples/scxml/calculator/doc/src/calculator.qdoc b/examples/scxml/calculator/doc/src/calculator.qdoc
index 6a784ee..5399eb9 100644
--- a/examples/scxml/calculator/doc/src/calculator.qdoc
+++ b/examples/scxml/calculator/doc/src/calculator.qdoc
@@ -3,12 +3,12 @@
/*!
\example calculator
- \title Qt SCXML Calculator Example
+ \title SCXML Calculator
\ingroup examples-qtscxml
\image calculator.png
- \brief A Qt Quick application that implements the Calculator example
+ \brief An application that implements the Calculator example
presented in the SCXML Specification.
\e {Calculator} uses Qt SCXML to implement the
diff --git a/examples/scxml/ftpclient/doc/src/ftpclient.qdoc b/examples/scxml/ftpclient/doc/src/ftpclient.qdoc
index ac7270e..7248c27 100644
--- a/examples/scxml/ftpclient/doc/src/ftpclient.qdoc
+++ b/examples/scxml/ftpclient/doc/src/ftpclient.qdoc
@@ -3,7 +3,7 @@
/*!
\example ftpclient
- \title Qt SCXML FTP Client Example
+ \title SCXML FTP Client
\ingroup examples-qtscxml
\brief Implements a simple FTP client using a state machine.
diff --git a/examples/scxml/invoke/doc/src/invoke.qdoc b/examples/scxml/invoke/doc/src/invoke.qdoc
index 8c1ff95..b771c3d 100644
--- a/examples/scxml/invoke/doc/src/invoke.qdoc
+++ b/examples/scxml/invoke/doc/src/invoke.qdoc
@@ -3,14 +3,14 @@
/*!
\example invoke
- \title Qt SCXML Invoke Example
+ \title SCXML Invoke
\ingroup examples-qtscxml
\brief Invokes a compiled nested state machine.
\image invoke.png
- \e{Invoke Example} demonstrates how to use the \c <invoke> element
+ \e{Invoke} demonstrates how to use the \c <invoke> element
with generated nested state-machines, where the SCXML file is compiled to
a C++ class. The \c <invoke> element is used to create an instance of an
external service.
diff --git a/examples/scxml/mediaplayer/doc/src/mediaplayer.qdoc b/examples/scxml/mediaplayer/doc/src/mediaplayer.qdoc
index 87e7ffd..77f2c33 100644
--- a/examples/scxml/mediaplayer/doc/src/mediaplayer.qdoc
+++ b/examples/scxml/mediaplayer/doc/src/mediaplayer.qdoc
@@ -3,14 +3,14 @@
/*!
\example mediaplayer
- \title Qt SCXML Media Player Example
+ \title SCXML Media Player
\ingroup examples-qtscxml
\image mediaplayer.png
\brief Sends data to and receives it from a C++ data model.
- \e {Media Player Example} demonstrates how to access
+ \e {Media Player} demonstrates how to access
data from a C++ data model. The data model enables writing C++ code for
\e expr attributes and \c <script> elements. The \e {data part} of the data
model is backed by a subclass of QScxmlCppDataModel, for which the Qt SCXML
diff --git a/examples/scxml/sudoku/doc/src/sudoku.qdoc b/examples/scxml/sudoku/doc/src/sudoku.qdoc
index 7fa781d..3b896ca 100644
--- a/examples/scxml/sudoku/doc/src/sudoku.qdoc
+++ b/examples/scxml/sudoku/doc/src/sudoku.qdoc
@@ -3,7 +3,7 @@
/*!
\example sudoku
- \title Qt SCXML Sudoku Example
+ \title SCXML Sudoku
\ingroup examples-qtscxml
\brief Demonstrates the use of separate javascript file with SCXML.
diff --git a/examples/scxml/trafficlight-qml-dynamic/doc/src/trafficlight-qml-dynamic.qdoc b/examples/scxml/trafficlight-qml-dynamic/doc/src/trafficlight-qml-dynamic.qdoc
index 0182dd7..a8b007e 100644
--- a/examples/scxml/trafficlight-qml-dynamic/doc/src/trafficlight-qml-dynamic.qdoc
+++ b/examples/scxml/trafficlight-qml-dynamic/doc/src/trafficlight-qml-dynamic.qdoc
@@ -3,7 +3,7 @@
/*!
\example trafficlight-qml-dynamic
- \title Qt SCXML Traffic Light QML Example (Dynamic)
+ \title SCXML Traffic Light (Dynamic, QML)
\ingroup examples-qtscxml
\brief A Qt Quick application that uses a dynamically loaded state machine
@@ -11,7 +11,7 @@
\image trafficlight.png
- \e{Traffic Light QML Example (Dynamic)} demonstrates how to connect to the
+ \e{Traffic Light} demonstrates how to connect to the
active properties of a state in a dynamically loaded state machine.
The UI is created using Qt Quick.
diff --git a/examples/scxml/trafficlight-qml-simple/doc/src/trafficlight-qml-simple.qdoc b/examples/scxml/trafficlight-qml-simple/doc/src/trafficlight-qml-simple.qdoc
index 2dedc96..a3bb591 100644
--- a/examples/scxml/trafficlight-qml-simple/doc/src/trafficlight-qml-simple.qdoc
+++ b/examples/scxml/trafficlight-qml-simple/doc/src/trafficlight-qml-simple.qdoc
@@ -3,7 +3,7 @@
/*!
\example trafficlight-qml-simple
- \title Qt SCXML Traffic Light QML Example (Simple)
+ \title SCXML Traffic Light (Simple, QML)
\ingroup examples-qtscxml
\brief A Qt Quick application that uses a compiled state machine to
@@ -11,7 +11,7 @@
\image trafficlight.png
- \e{Traffic Light QML Example (Simple)} demonstrates how to connect to the
+ \e{Traffic Light} demonstrates how to connect to the
active properties of a state in a state machine that is compiled to a class.
The UI is created using Qt Quick.
diff --git a/examples/scxml/trafficlight-qml-static/doc/src/trafficlight-qml-static.qdoc b/examples/scxml/trafficlight-qml-static/doc/src/trafficlight-qml-static.qdoc
index 1799154..5005607 100644
--- a/examples/scxml/trafficlight-qml-static/doc/src/trafficlight-qml-static.qdoc
+++ b/examples/scxml/trafficlight-qml-static/doc/src/trafficlight-qml-static.qdoc
@@ -3,7 +3,7 @@
/*!
\example trafficlight-qml-static
- \title Qt SCXML Traffic Light QML Example (Static)
+ \title SCXML Traffic Light (Static, QML)
\ingroup examples-qtscxml
\brief A Qt Quick application that uses a compiled state machine to
@@ -11,7 +11,7 @@
\image trafficlight.png
- \e{Traffic Light QML Example (Static)} demonstrates how to connect to the
+ \e{Traffic Light} demonstrates how to connect to the
active properties of a state in a state machine that is compiled to a class.
The UI is created using Qt Quick.
diff --git a/examples/scxml/trafficlight-widgets-dynamic/doc/src/trafficlight-widgets-dynamic.qdoc b/examples/scxml/trafficlight-widgets-dynamic/doc/src/trafficlight-widgets-dynamic.qdoc
index 16424e6..a3a6f03 100644
--- a/examples/scxml/trafficlight-widgets-dynamic/doc/src/trafficlight-widgets-dynamic.qdoc
+++ b/examples/scxml/trafficlight-widgets-dynamic/doc/src/trafficlight-widgets-dynamic.qdoc
@@ -3,7 +3,7 @@
/*!
\example trafficlight-widgets-dynamic
- \title Qt SCXML Traffic Light Example (Dynamic)
+ \title SCXML Traffic Light Example (Dynamic, Widgets)
\ingroup examples-qtscxml
\brief A widget-based application that uses a dynamically loaded state
@@ -11,7 +11,7 @@
\image trafficlight.png
- \e{Traffic Light Example (Dynamic)} demonstrates how to connect to the
+ \e{Traffic Light} demonstrates how to connect to the
active properties of a state in a dynamically loaded state machine.
The UI is created using Qt Widgets.
diff --git a/examples/scxml/trafficlight-widgets-static/doc/src/trafficlight-widgets-static.qdoc b/examples/scxml/trafficlight-widgets-static/doc/src/trafficlight-widgets-static.qdoc
index 36b6e87..216b3ef 100644
--- a/examples/scxml/trafficlight-widgets-static/doc/src/trafficlight-widgets-static.qdoc
+++ b/examples/scxml/trafficlight-widgets-static/doc/src/trafficlight-widgets-static.qdoc
@@ -3,7 +3,7 @@
/*!
\example trafficlight-widgets-static
- \title Qt SCXML Traffic Light Example (Static)
+ \title SCXML Traffic Light (Static, Widgets)
\ingroup examples-qtscxml
\brief A widget-based application that uses a compiled state machine to
diff --git a/src/scxml/qscxmlcppdatamodel.cpp b/src/scxml/qscxmlcppdatamodel.cpp
index 48a2af2..f357eae 100644
--- a/src/scxml/qscxmlcppdatamodel.cpp
+++ b/src/scxml/qscxmlcppdatamodel.cpp
@@ -87,7 +87,7 @@ void TheDataModel::evaluateToVoid(QScxmlExecutableContent::EvaluatorId id, bool
statements, and in \e cond or \e expr attributes you can use any C++ expression that can be
converted to the respective bool or QVariant. And, as the \c this pointer is also captured, you
can call or access the data model (the \e media attribute in the example above). For the full
- example, see \l {Qt SCXML: Media Player Example}.
+ example, see \l {SCXML Media Player}.
*/
/*!