summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDominik Holland <dominik.holland@qt.io>2024-01-10 17:01:10 +0100
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2024-01-19 17:17:33 +0000
commit9464a9be756883c145e9dd939f1700870ff9f573 (patch)
tree7e8c750360e8624a5b736050cc2723f469ccaf05
parentb7658c1b2b4a7c50c6c8e8ab20a4f1d9b014ed99 (diff)
doc: Fix the QtIfRemoteObjectsHelper module page and make it visible
Change-Id: I2b2a42e026ec8926dbcba66817548293bfafe02c Reviewed-by: Robert Griebl <robert.griebl@qt.io> (cherry picked from commit c99ba9bbdbb9492866e2c4301c7ecb768b7064fc) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/helper/remoteobjects/qifremoteobjectshelper.cpp22
-rw-r--r--src/interfaceframework/doc/online/style/qt-sidebar.html1
-rw-r--r--src/interfaceframework/doc/src/modules.qdoc15
-rw-r--r--src/interfaceframework/doc/src/qtif.qdoc1
-rw-r--r--src/interfaceframework/doc/src/qtremoteobjectshelper.qdoc35
5 files changed, 52 insertions, 22 deletions
diff --git a/src/helper/remoteobjects/qifremoteobjectshelper.cpp b/src/helper/remoteobjects/qifremoteobjectshelper.cpp
index e923b451..99bc212c 100644
--- a/src/helper/remoteobjects/qifremoteobjectshelper.cpp
+++ b/src/helper/remoteobjects/qifremoteobjectshelper.cpp
@@ -8,28 +8,6 @@ QT_BEGIN_NAMESPACE
using namespace Qt::Literals::StringLiterals;
/*!
- \module QtIfRemoteObjectsHelper
- \title Qt Interface Framework Remote Object Helper Classes
- \ingroup modules
- \ingroup qtif_helper_modules
- \qtvariable interfaceframework
-
- \brief Qt Interface Framework Remote Object Helper Classes.
-
- To include the definitions of the module's classes, use the following directive:
-
- \code
- #include <QtIfRemoteObjectsHelper>
- \endcode
-
- To link against the module, add this line to your qmake .pro file:
-
- \code
- QT += ifremoteobjects_helper
- \endcode
-*/
-
-/*!
\namespace QIfRemoteObjectsHelper
\inmodule QtIfRemoteObjectsHelper
diff --git a/src/interfaceframework/doc/online/style/qt-sidebar.html b/src/interfaceframework/doc/online/style/qt-sidebar.html
index 2fa673ea..d474b6f7 100644
--- a/src/interfaceframework/doc/online/style/qt-sidebar.html
+++ b/src/interfaceframework/doc/online/style/qt-sidebar.html
@@ -41,6 +41,7 @@
<h2>Reference</h2>
</div>
<ul>
+ <li><a href="modules.html">Modules</a></li>
<li><a href="qtinterfaceframework-module.html">C++ Classes</a></li>
<li><a href="qtinterfaceframework-qmlmodule.html">QML Types</a></li>
<li><a href="qtinterfaceframework-examples.html">Examples</a></li>
diff --git a/src/interfaceframework/doc/src/modules.qdoc b/src/interfaceframework/doc/src/modules.qdoc
new file mode 100644
index 00000000..b4982dc0
--- /dev/null
+++ b/src/interfaceframework/doc/src/modules.qdoc
@@ -0,0 +1,15 @@
+// Copyright (C) 2024 The Qt Company Ltd.
+// Copyright (C) 2019 Luxoft Sweden AB
+// Copyright (C) 2018 Pelagicore AG
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+/*!
+ \page modules.html
+ \title Qt Interface Framework Modules
+
+ \brief All Qt Interface Framework Modules.
+
+ In addition to the \l {Qt Interface Framework C++ Classes}{Qt Interface Framework Module}
+ the following helper modules provide protocol specific functions:
+
+ \annotatedlist qtif_helper_modules
+*/
diff --git a/src/interfaceframework/doc/src/qtif.qdoc b/src/interfaceframework/doc/src/qtif.qdoc
index 29a7e07e..555d7e8e 100644
--- a/src/interfaceframework/doc/src/qtif.qdoc
+++ b/src/interfaceframework/doc/src/qtif.qdoc
@@ -78,6 +78,7 @@
\section1 Reference
\list
+ \li \l {Qt Interface Framework Modules}
\li \l {Qt Interface Framework C++ Classes}
\li \l {Qt Interface Framework QML Types}
\li \l {Qt Interface Framework Examples}
diff --git a/src/interfaceframework/doc/src/qtremoteobjectshelper.qdoc b/src/interfaceframework/doc/src/qtremoteobjectshelper.qdoc
new file mode 100644
index 00000000..80ffe939
--- /dev/null
+++ b/src/interfaceframework/doc/src/qtremoteobjectshelper.qdoc
@@ -0,0 +1,35 @@
+// Copyright (C) 2024 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+
+/*!
+ \module QtIfRemoteObjectsHelper
+ \title Qt Interface Framework Remote Objects Helper Classes
+ \ingroup modules
+ \ingroup qtif_helper_modules
+ \qtvariable interfaceframework
+
+ \brief Qt Interface Framework Remote Objects Helper Classes.
+
+ To link against the Qt Interface Framework Remote Objects Helper Module,
+ use the following directive:
+
+ Using CMake:
+
+ \code
+ find_package(Qt6 COMPONENTS IfRemoteObjectsHelper REQUIRED)
+ target_link_libraries(mytarget PRIVATE Qt6::IfRemoteObjectsHelper)
+ \endcode
+
+ Using qmake:
+
+ \code
+ QT += ifremoteobjects_helper
+ \endcode
+
+ To use Qt Interface Framework Remote Objects Helper C++ classes in your
+ application, use the following include statement:
+
+ \code
+ #include <QtIfRemoteObjectsHelper>
+ \endcode
+*/