summaryrefslogtreecommitdiffstats
path: root/examples
diff options
context:
space:
mode:
authorRym Bouabid <rym.bouabid@qt.io>2023-12-12 11:35:47 +0100
committerRym Bouabid <rym.bouabid@qt.io>2023-12-13 21:55:00 +0100
commitad32ef935d0a7053f6848b33685303a94e9df1ca (patch)
treeacd4cba917129cc1cf90ad6713c40e47062181cd /examples
parentfc8ec01acee293c408d3533246025debfcc65544 (diff)
Review Qt Quick Waterpump Example: Revisit the documentation
Remove "Example" from the title and change "Waterpump" with "Water Pump" Add quick and qtopcua as tags. Update the example screenshot. Task-number: QTBUG-119784 Pick-to: 6.7 6.6 6.5 Change-Id: Ib02110fcba3685a2ed3011f1c2e09e3760fce41d Reviewed-by: Ievgenii Meshcheriakov <ievgenii.meshcheriakov@qt.io>
Diffstat (limited to 'examples')
-rw-r--r--examples/opcua/waterpump/waterpump-qml/doc/images/tankexample.jpgbin15364 -> 0 bytes
-rw-r--r--examples/opcua/waterpump/waterpump-qml/doc/images/tankexample.pngbin0 -> 45961 bytes
-rw-r--r--examples/opcua/waterpump/waterpump-qml/doc/waterpump-qml.qdoc22
3 files changed, 15 insertions, 7 deletions
diff --git a/examples/opcua/waterpump/waterpump-qml/doc/images/tankexample.jpg b/examples/opcua/waterpump/waterpump-qml/doc/images/tankexample.jpg
deleted file mode 100644
index 4c6a429..0000000
--- a/examples/opcua/waterpump/waterpump-qml/doc/images/tankexample.jpg
+++ /dev/null
Binary files differ
diff --git a/examples/opcua/waterpump/waterpump-qml/doc/images/tankexample.png b/examples/opcua/waterpump/waterpump-qml/doc/images/tankexample.png
new file mode 100644
index 0000000..411a067
--- /dev/null
+++ b/examples/opcua/waterpump/waterpump-qml/doc/images/tankexample.png
Binary files differ
diff --git a/examples/opcua/waterpump/waterpump-qml/doc/waterpump-qml.qdoc b/examples/opcua/waterpump/waterpump-qml/doc/waterpump-qml.qdoc
index e1cb21a..1ce311d 100644
--- a/examples/opcua/waterpump/waterpump-qml/doc/waterpump-qml.qdoc
+++ b/examples/opcua/waterpump/waterpump-qml/doc/waterpump-qml.qdoc
@@ -3,18 +3,23 @@
/*!
\example waterpump/waterpump-qml
+ \meta tag {qtopcua,quick}
\ingroup qtopcua-examples
- \title Qt Quick Waterpump Example
+ \title Qt Quick Water Pump
\examplecategory {Data Processing & I/O}
\brief Interacting with an OPC UA server to build a QML-based HMI for a
- simple machine.
+ simple water pump machine.
- \e{Qt Quick Waterpump} shows how to use Qt OPC UA QML API to interact with
- an OPC UA server to build a QML based HMI for a simple machine.
+ \e{Qt Quick Water Pump} example shows how to use Qt OPC UA QML API to interact
+ with an OPC UA server to build a QML based HMI for a simple machine.
+
+ \image tankexample.png
\section1 Building the Server
- Before you can use the waterpump examples, you need to build the simulation server.
- The simulator server project resides next to the waterpump examples.
+ Before you can use the Water Pump examples, you need to build the \l
+ {https://code.qt.io/cgit/qt/qtopcua.git/tree/examples/opcua/waterpump/simulationserver}
+ {simulation server}.
+ The simulation server project resides next to the Water Pump examples.
You can open and build it in QtCreator or from the terminal as usual.
\section1 The Simulation
@@ -60,6 +65,9 @@
\row
\li ns=2;s=Machine.FlushTank2
\li Call this method to flush tank 2
+ \row
+ \li ns=2;s=Machine.Reset
+ \li Call this method to reset the simulation
\endtable
\section1 Implementation
@@ -105,5 +113,5 @@
If there is no water left, click \uicontrol {Reset simulation} to refill the first tank.
- \image tankexample.jpg
+ \sa {Waterpump Example}
*/