summaryrefslogtreecommitdiffstats
path: root/src/interfaceframework
diff options
context:
space:
mode:
authorShveta Mittal <shveta.mittal@qt.io>2024-11-26 14:11:33 +0200
committerShveta Mittal <shveta.mittal@qt.io>2024-12-04 10:35:09 +0200
commit473fe4cd37dfca526146614d20ea60286fc0c1aa (patch)
treeed968ab49b4114ad1240062890ada91b51e41327 /src/interfaceframework
parent6f81e3808a87d5faee60b68e2adc59073d9862e1 (diff)
Enhance defaultServerMode with Android option and update annotation
Added 'android' as a valid option for defaultServerMode, expanding beyond the previous 'gui' and 'headless' options. Moved defaultServerMode under the 'config' annotation for better organization, previously under 'config_simulator'. Task-number: QTBUG-130660 Change-Id: Ib7b730badbe47721c0a826c65ef4fb5832fc5ea0 Reviewed-by: Dominik Holland <dominik.holland@qt.io> Reviewed-by: Zoltan Gera <zoltan.gera@qt.io>
Diffstat (limited to 'src/interfaceframework')
-rw-r--r--src/interfaceframework/doc/src/ifcodegen/generator-usage.qdoc26
1 files changed, 13 insertions, 13 deletions
diff --git a/src/interfaceframework/doc/src/ifcodegen/generator-usage.qdoc b/src/interfaceframework/doc/src/ifcodegen/generator-usage.qdoc
index 5edd9d8a..6bf93e63 100644
--- a/src/interfaceframework/doc/src/ifcodegen/generator-usage.qdoc
+++ b/src/interfaceframework/doc/src/ifcodegen/generator-usage.qdoc
@@ -345,6 +345,18 @@
interfaces inside that module, but it can be overridden per interface by defining it
there as well.
Defaults to \c module.name
+ \row
+ \li
+ \target config_defaultServerMode
+ \code
+ @config: { defaultServerMode : "gui" }
+ \endcode
+ \li Main IDL file
+ \li Module
+ \li Defines the default mode used by the server generated from the
+ \l{QtRemoteObjects Simulation Server}{server_qtro_simulator}
+ and {QtRemoteObjects Server} {server_qtro}
+ templates. Valid options are "gui", "headless" (default) or "android" (for the Android target platform).
\endtable
Annotations that are not logically part of the interface description, but rather the ones used
@@ -396,18 +408,6 @@
embed.
\row
\li
- \target config_simulator_defaultServerMode
- \code
- config_simulator:
- defaultServerMode: "gui"
- \endcode
- \li Accompanying YAML file
- \li Module
- \li Defines the default mode used by the server generated from the
- \l{QtRemoteObjects Simulation Server}{server_qtro_simulator}
- template. Valid options are "gui" or "headless" (default).
- \row
- \li
\code
config_simulator:
zones: [ Left,
@@ -767,7 +767,7 @@
By default a QCoreApplication is used in the generated server and enables the server to be
run headless. To also allow instantiating UI controls inside the simulation QML code, the
server can be started in GUI mode (--gui option). The default mode can be changed using the
- \l{config_simulator_defaultServerMode} annotation.
+ \l{config_defaultServerMode} annotation.
\table 100%
\header