summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBernd Weimer <bernd.weimer@qt.io>2022-03-02 14:51:20 +0100
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2022-03-14 06:19:03 +0000
commit71512be8758c75b4b6b0130d6b623f564c6bf227 (patch)
tree8cf4d8f31fb54522b3d2bd85d36458ff2662aacc
parente5ef8b05129a572ac21f51da2f01f1c531445fd4 (diff)
Add and improve documentationv6.2.46.2.4
Extended documentation for QtRO simulation server and clarified some other topics. Change-Id: I64b31ff8ffdc4dbda46e6bbf55665027fa7791d5 Reviewed-by: Dominik Holland <dominik.holland@qt.io> (cherry picked from commit 765c3b4f9fb8a9d76ffcb96f3ab72bddbf717fa7) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/interfaceframework/doc/src/ifcodegen/generator-usage.qdoc10
-rw-r--r--src/interfaceframework/doc/src/ifcodegen/ipc-integration.qdoc10
-rw-r--r--src/interfaceframework/qifabstractfeature.cpp6
3 files changed, 16 insertions, 10 deletions
diff --git a/src/interfaceframework/doc/src/ifcodegen/generator-usage.qdoc b/src/interfaceframework/doc/src/ifcodegen/generator-usage.qdoc
index c57e29a2..cfe7c411 100644
--- a/src/interfaceframework/doc/src/ifcodegen/generator-usage.qdoc
+++ b/src/interfaceframework/doc/src/ifcodegen/generator-usage.qdoc
@@ -80,6 +80,7 @@
\li \c backend_simulator
\li \c backend_qtro
\li \c server_qtro
+ \li \c server_qtro_simulator
\endlist
\row
\target annotations-option
@@ -138,6 +139,11 @@
\li Generates a QtRemoteObjects based backend server stub for the API first generated
by the \c frontend option.
\row
+ \li \l {QtRemoteObjects Simulation Server} {server_qtro_simulator}
+ \target server-qtro-simulator-template
+ \li Generates a QtRemoteObjects based simulation server for the API first generated by
+ the \c frontend option.
+ \row
\li folder path
\li Uses templates inside the folder. A YAML file with the same name as the folder
should provide a list of template files in the folder. This is useful if you want
@@ -594,8 +600,8 @@
\section2 QtRemoteObjects Simulation Server
The server_qtro_simulator template is only available if qmake finds the QtRemoteObjects module.
- The code produced contains a fully-implemented server that uses the same implementation as the
- backend_simulator template, which uses the QIfSimulationEngine to implement the simulation
+ The code produced contains a fully-implemented server that may use the same implementation as
+ the backend_simulator template, which uses the QIfSimulationEngine to implement the simulation
behavior in QML.
\table 100%
diff --git a/src/interfaceframework/doc/src/ifcodegen/ipc-integration.qdoc b/src/interfaceframework/doc/src/ifcodegen/ipc-integration.qdoc
index c3838728..ae267c2a 100644
--- a/src/interfaceframework/doc/src/ifcodegen/ipc-integration.qdoc
+++ b/src/interfaceframework/doc/src/ifcodegen/ipc-integration.qdoc
@@ -51,13 +51,13 @@ and transparency for the UI code.
\section1 Qt Remote Objects
The Qt Interface Framework Generator makes it possible to generate Middleware Backends that utilize the
-QtRemoteObjects module. The client-side code is generated as a QtInterfaceFramework backend plugin and and as a
+QtRemoteObjects module. The client-side code is generated as a QtInterfaceFramework backend plugin and as
a Middleware Service, either a server stub or a full simulation server. The client is generated
using the \l{backend-qtro-template} {backend_qtro} template; the server using the
-\l{server-qtro-template} {server_qtro} template. Both the plugin and the server contain generated
-C++ code and an intermediate \c{.rep} file that is further processed by Qt’s
-\l [QtRemoteObjects] {Qt Remote Objects Compiler} {replica compiler} to produce the actual source
-and replica classes.
+\l{server-qtro-template} {server_qtro} template or \l{server-qtro-simulator-template}
+{server_qtro_simulator}. Both the plugin and the server contain generated C++ code and an
+intermediate \c{.rep} file that is further processed by Qt’s \l {Qt Remote Objects Compiler}
+{replica compiler} to produce the actual source and replica classes.
The generated plugin is loaded and used in the same way as other QtInterfaceFramework plugins and is
interchangeable with any other backend implementation with the same API. Since all method calls
diff --git a/src/interfaceframework/qifabstractfeature.cpp b/src/interfaceframework/qifabstractfeature.cpp
index 03dbec0c..1d2fe6fe 100644
--- a/src/interfaceframework/qifabstractfeature.cpp
+++ b/src/interfaceframework/qifabstractfeature.cpp
@@ -739,9 +739,9 @@ void QIfAbstractFeature::disconnectFromServiceObject(QIfServiceObject *serviceOb
\property QIfAbstractFeature::isValid
\brief Indicates whether the feature is ready to use.
- The property is \c true if the feature is ready to be used, otherwise \c false. Not being
- ready usually indicates that no suitable service object could be found, or that automatic
- discovery has not been triggered.
+ The property is \c true if the feature has an associated service object, otherwise \c false.
+ Not being valid usually indicates that no suitable service object could be found, or that
+ automatic discovery has not been triggered.
The backend still might not have sent all properties yet and is not fully initialized.
Use isInitialized instead to know when the feature holds all correct values.