summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDominik Holland <dominik.holland@qt.io>2023-09-26 11:01:43 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2023-09-29 09:15:33 +0000
commite843979769f6298cc11c1293c759c03f66e38d2e (patch)
tree01d94f3f6850372833e627a37d31265fefcc1508
parenteb550104757c6e1f30af908f6efba2b73ab27c84 (diff)
doc: Rework the buildsystem integration page
Also fixed some typos and linking errors Pick-to: 6.6.0 6.5 Change-Id: I200bc0c6e1578a84eea8f9d901e1e5f1fc50d2e3 Reviewed-by: Robert Griebl <robert.griebl@qt.io> (cherry picked from commit 9c4b8e84c05deda94c1334e8d98e88632c884d6d) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--examples/interfaceframework/qface-tutorial/doc/src/qface-tutorial.qdoc6
-rw-r--r--src/interfaceframework/doc/src/external-resources.qdoc5
-rw-r--r--src/interfaceframework/doc/src/ifcodegen/buildsystem-integration.qdoc78
-rw-r--r--src/interfaceframework/doc/src/whatsnew.qdoc4
-rw-r--r--src/interfaceframework/qifconfiguration.cpp2
5 files changed, 37 insertions, 58 deletions
diff --git a/examples/interfaceframework/qface-tutorial/doc/src/qface-tutorial.qdoc b/examples/interfaceframework/qface-tutorial/doc/src/qface-tutorial.qdoc
index f22e5e08..169721cd 100644
--- a/examples/interfaceframework/qface-tutorial/doc/src/qface-tutorial.qdoc
+++ b/examples/interfaceframework/qface-tutorial/doc/src/qface-tutorial.qdoc
@@ -54,7 +54,7 @@
\image qface-tutorial-final.gif
\target chapter1
- \section1 Chapter 1: Basic Middlware API with the Interface Framework Generator
+ \section1 Chapter 1: Basic Middleware API with the Interface Framework Generator
In this chapter we integrate a Middleware API into the existing Instrument Cluster QML code.
Instead of manually writing all of these parts ourselves, which is done in most basic
@@ -831,7 +831,7 @@
\printto
In \c interfaces() we use the IID which is defined in \c{instrumentclusterbackendinterface.h}
- from our auto-generated library. In \c insterfaceInstance() we check for the correct string and
+ from our auto-generated library. In \c interfaceInstance() we check for the correct string and
return an instance of the instrument cluster back-end we implemented.
This back end is defined in \c instrumentclusterbackend.h and derives from
@@ -1051,7 +1051,7 @@
\section2 Add new Annotations
- If you did the excercise to port all the files by yourself, you might have noticed that not
+ If you did the exercise to port all the files by yourself, you might have noticed that not
everything in the backend code can be derived from the QFace module or interface names.
As we still want to use the DBus interface generated by \l qdbusxml2cpp, the class name and dbus
diff --git a/src/interfaceframework/doc/src/external-resources.qdoc b/src/interfaceframework/doc/src/external-resources.qdoc
index 0af391c1..0f417db8 100644
--- a/src/interfaceframework/doc/src/external-resources.qdoc
+++ b/src/interfaceframework/doc/src/external-resources.qdoc
@@ -10,3 +10,8 @@
\externalpage https://qface.readthedocs.io/en/latest/extending.html#rule-base-generation
\title QFace - Rule Base Generation
*/
+
+/*!
+ \externalpage https://doc.qt.io/QtIVI/index.html
+ \title QtIVI
+*/
diff --git a/src/interfaceframework/doc/src/ifcodegen/buildsystem-integration.qdoc b/src/interfaceframework/doc/src/ifcodegen/buildsystem-integration.qdoc
index 078b0198..944b047d 100644
--- a/src/interfaceframework/doc/src/ifcodegen/buildsystem-integration.qdoc
+++ b/src/interfaceframework/doc/src/ifcodegen/buildsystem-integration.qdoc
@@ -86,43 +86,18 @@ In CMake the following functions and variables are provided by the QtInterfaceFr
\section1 QtModule Support
-\section2 QMake
-
-The integration also supports generating code that you can subsequently compile into a Qt
-module. Since this module needs to work more closely with Qt's module building system, it shouldn't
-be loaded using the \c CONFIG variable, but using the \c load() function instead. The
-\c ifcodegen_qt_module feature replaces the \c load(qt_module) call.
-
-The following shows how you can integrate the QtIfVehicleFunctions module:
-
-\badcode
-TARGET = QtIfVehicleFunctions
-QT = core core-private interfaceframework
-CONFIG += c++11 ifcodegen
-
-QT_FOR_CONFIG += interfaceframework
-!qtConfig(ifcodegen): error("No ifcodegen available")
-
-...
-
-IFCODEGEN_MODULE_NAME = QtIfVehicleFunctions
-IFCODEGEN_SOURCES += ifvehiclefunctions.qface
-
-load(ifcodegen_qt_module)
-\endcode
-
\section2 CMake
-The following shows how you can use CMake to build the QtIfVehicleFunctions module:
+The integration also supports generating code that you can subsequently compile into a Qt
+module. The following shows how you can use CMake to build a module named MyModule:
\badcode
qt_ifcodegen_generate(
- IDL_FILES ifvehiclefunctions.qface
+ IDL_FILES mymodule.qface
TEMPLATE frontend
- MODULE_NAME QtIfVehicleFunctions
+ MODULE_NAME QtMyModule
)
-
-qt_internal_add_module(IfVehicleFunctions
+qt_internal_add_module(MyModule
LIBRARIES
Qt::CorePrivate
Qt::InterfaceFrameworkPrivate
@@ -133,10 +108,9 @@ qt_internal_add_module(IfVehicleFunctions
Qt::CorePrivate
Qt::InterfaceFrameworkPrivate
)
-
-qt_ifcodegen_extend_target(IfVehicleFunctions
+qt_ifcodegen_extend_target(MyModule
NO_GENERATE
- IDL_FILES ifvehiclefunctions.qface
+ IDL_FILES mymodule.qface
)
\endcode
@@ -153,7 +127,7 @@ Usually, the \c sync.profile is setup to search for these headers in the source
\badcode
...
%modules = ( # path to module name map
- "QtIfVehicleFunctions" => "$basedir/src/ifvehiclefunctions;$out_basedir/src/ifvehiclefunctions"
+ "QtMyModule" => "$basedir/src/mymodule;$out_basedir/src/mymodule"
);
...
\endcode
@@ -171,24 +145,24 @@ using the new registration macros and provides all the necessary information for
the rest:
\badcode
-qt_ifcodegen_extend_target(IfVehicleFunctions
+qt_ifcodegen_extend_target(MyModule
NO_GENERATE
- PREFIX VEHICLEFUNCTIONS
- IDL_FILES ifvehiclefunctions.qface
+ PREFIX MYMODULE
+ IDL_FILES mymodule.qface
)
-qt_add_qml_module(IfVehicleFunctions
- URI ${VEHICLEFUNCTIONS_URI}
- VERSION ${VEHICLEFUNCTIONS_VERSION}
+qt_add_qml_module(MyModule
+ URI ${MYMODULE_URI}
+ VERSION ${MYMODULE_VERSION}
RESOURCE_PREFIX "/"
- CLASS_NAME QtIfVehicleFunctionsPlugin
- PLUGIN_TARGET qtifvehiclefunctionsplugin
+ CLASS_NAME QtMyModulePlugin
+ PLUGIN_TARGET qtmymoduleplugin
IMPORTS QtInterfaceFramework
)
\endcode
By using the \c PREFIX argument in the \l qt_ifcodegen_extend_target call, additional variables get
-exposed to using \c VEHICLEFUNCTIONS as their prefix.
+exposed to using \c MYMODULE as their prefix.
Those variables can be used in the following call to \l qt_add_qml_module, which handles the QML
type registration for all types and also generates a QML plugin.
@@ -198,26 +172,26 @@ Instead of using the new QML Type registration, ifcodegen can be used to generat
which registers all types when loaded:
\badcode
-qt_ifcodegen_import_variables(VEHICLEFUNCTIONS
- IDL_FILES ifvehiclefunctions.qface
+qt_ifcodegen_import_variables(MYMODULE
+ IDL_FILES mymodule.qface
TEMPLATE qmlplugin
- MODULE_NAME QtIfVehicleFunctions
+ MODULE_NAME QtMyModule
)
-qt_add_qml_module(qtifvehiclefunctionsplugin
- URI ${VEHICLEFUNCTIONS_URI}
- VERSION ${VEHICLEFUNCTIONS_VERSION}
+qt_add_qml_module(qtmymoduleplugin
+ URI ${MYMODULE_URI}
+ VERSION ${MYMODULE_VERSION}
RESOURCE_PREFIX "/"
- PLUGIN_TARGET qtifvehiclefunctionsplugin
+ PLUGIN_TARGET qtmymoduleplugin
NO_PLUGIN_OPTIONAL
NO_GENERATE_PLUGIN_SOURCE
NO_GENERATE_QMLTYPES
NO_GENERATE_QMLDIR
SOURCES
- ${VEHICLEFUNCTIONS_SOURCES}
+ ${MYMODULE_SOURCES}
PUBLIC_LIBRARIES
Qt::InterfaceFramework
- Qt::IfVehicleFunctions
+ Qt::MyModule
)
\endcode
diff --git a/src/interfaceframework/doc/src/whatsnew.qdoc b/src/interfaceframework/doc/src/whatsnew.qdoc
index 0f250909..642e47ad 100644
--- a/src/interfaceframework/doc/src/whatsnew.qdoc
+++ b/src/interfaceframework/doc/src/whatsnew.qdoc
@@ -4,7 +4,7 @@
\page whatsnew.html
\title What's New in the Qt Interface Framework
-The following page descibes new features by Qt Version:
+The following page describes new features by Qt Version:
\section1 6.6
@@ -42,7 +42,7 @@ The following page descibes new features by Qt Version:
\list
\li Added \l{CMake Commands in Qt6 InterfaceFramework}{CMake support}
\li Added support to define a \l {template-search-path-option}{template search path} for ifcodegen
- \li Rename from \l {QtIvi} to Qt Interface Framework
+ \li Rename from \l {QtIVI} to Qt Interface Framework
\endlist
*/
diff --git a/src/interfaceframework/qifconfiguration.cpp b/src/interfaceframework/qifconfiguration.cpp
index 4078ad63..19ddf989 100644
--- a/src/interfaceframework/qifconfiguration.cpp
+++ b/src/interfaceframework/qifconfiguration.cpp
@@ -653,7 +653,7 @@ QString QIfConfiguration::name() const
See \l{Settings Overview} for how to provide initial values and overrides.
- \sa ServiceObject::serviceSettings
+ \sa QIfServiceObject::serviceSettings
*/
/*!
\property QIfConfiguration::serviceSettings