summaryrefslogtreecommitdiffstats
path: root/src/doc
diff options
context:
space:
mode:
Diffstat (limited to 'src/doc')
-rw-r--r--src/doc/CMakeLists.txt9
-rw-r--r--src/doc/config/style/qt5-sidebar.html16
-rw-r--r--src/doc/online/qtdeviceutilities.qdocconf9
-rw-r--r--src/doc/online/style/qt5-sidebar.html11
-rw-r--r--src/doc/qtdeviceutilities-project.qdocconf8
-rw-r--r--src/doc/qtdeviceutilities.qdocconf1
-rw-r--r--src/doc/src/external-resources.qdoc4
-rw-r--r--src/doc/src/qtdeviceutilities-index.qdoc11
-rw-r--r--src/doc/src/qtdeviceutilities-module-qml.qdoc4
9 files changed, 33 insertions, 40 deletions
diff --git a/src/doc/CMakeLists.txt b/src/doc/CMakeLists.txt
index 20feded..e4a4b7f 100644
--- a/src/doc/CMakeLists.txt
+++ b/src/doc/CMakeLists.txt
@@ -1,5 +1,12 @@
add_library(DeviceUtilities INTERFACE)
target_link_libraries(DeviceUtilities INTERFACE Qt::Core)
+
+if(QT_BUILD_ONLINE_DOCS)
+ set(DOC_CONF "online/qtdeviceutilities.qdocconf")
+else()
+ set(DOC_CONF "qtdeviceutilities.qdocconf")
+endif()
+
qt_internal_add_docs(DeviceUtilities
- qtdeviceutilities.qdocconf
+ ${DOC_CONF}
)
diff --git a/src/doc/config/style/qt5-sidebar.html b/src/doc/config/style/qt5-sidebar.html
deleted file mode 100644
index 3879827..0000000
--- a/src/doc/config/style/qt5-sidebar.html
+++ /dev/null
@@ -1,16 +0,0 @@
-<div class="sectionlist normallist">
- <div class="heading">
- <h2>Qt Device Utilities</h2>
- </div>
- <ul>
- <li><a href="qtee-module-reference.html">Home</a></li>
- </ul>
-</div>
-<div class="sectionlist normallist">
- <div class="heading">
- <h2>See Also</h2>
- </div>
- <ul>
- <li><a href="https://doc.qt.io/QtForDeviceCreation">Qt for Device Creation</a></li>
- </ul>
-</div>
diff --git a/src/doc/online/qtdeviceutilities.qdocconf b/src/doc/online/qtdeviceutilities.qdocconf
new file mode 100644
index 0000000..c8e4c21
--- /dev/null
+++ b/src/doc/online/qtdeviceutilities.qdocconf
@@ -0,0 +1,9 @@
+include($QT_INSTALL_DOCS/global/qt-module-defaults-online.qdocconf)
+include(../qtdeviceutilities-project.qdocconf)
+
+# Sidebar used for online template
+HTML.stylesheets += style/qt5-sidebar.html
+
+# Turn off single-directory output mode
+HTML.nosubdirs = "false"
+HTML.outputsubdir = qtdeviceutilities
diff --git a/src/doc/online/style/qt5-sidebar.html b/src/doc/online/style/qt5-sidebar.html
new file mode 100644
index 0000000..d402ad0
--- /dev/null
+++ b/src/doc/online/style/qt5-sidebar.html
@@ -0,0 +1,11 @@
+<div class="sectionlist normallist">
+ <div class="heading">
+ <h2>Qt Device Utilities</h2>
+ </div>
+ <ul>
+ <li><a href="index.html">Home</a></li>
+ <li><a href="qtdeviceutilities-cpp-classes.html">C++ Classes</a></li>
+ <li><a href="qtdeviceutilities-qml-types.html">QML Types</a></li>
+ <li><a href="qtdeviceutilities-examples.html">Examples</a></li>
+ </ul>
+</div>
diff --git a/src/doc/qtdeviceutilities-project.qdocconf b/src/doc/qtdeviceutilities-project.qdocconf
index cfd5d5a..2868e1e 100644
--- a/src/doc/qtdeviceutilities-project.qdocconf
+++ b/src/doc/qtdeviceutilities-project.qdocconf
@@ -1,5 +1,3 @@
-include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
-
project = QtDeviceUtilities
description = Qt Device Utilities $QT_VERSION
version = $QT_VERSION
@@ -12,7 +10,7 @@ includepaths += -I . \
moduleheader = QtDeviceUtilitiesDoc
sourcedirs += src \
- ../networksettings/networksettingsqml \
+ ../networksettingsqml \
../networksettings
headerdirs += ../networksettings
@@ -55,8 +53,8 @@ macro.B2QA = "\\e {Boot to Qt for embedded Android}"
macro.B2QL = "\\e {Boot to Qt for embedded Linux}"
macro.QtDU = "Qt Device Utilities"
-# Keep Device Creation as the landing page
-navigation.landingpage = "Qt for Device Creation"
+# Qt Device Utilities as the landing page
+navigation.landingpage = "Qt Device Utilities"
navigation.qmltypespage = "Qt Device Utilities QML Types"
navigation.cppclassespage = "Qt Device Utilities C++ Classes"
diff --git a/src/doc/qtdeviceutilities.qdocconf b/src/doc/qtdeviceutilities.qdocconf
index 5b56cf1..bd38e0f 100644
--- a/src/doc/qtdeviceutilities.qdocconf
+++ b/src/doc/qtdeviceutilities.qdocconf
@@ -1,3 +1,4 @@
+include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
include(qtdeviceutilities-project.qdocconf)
# Turn off single-directory output mode
diff --git a/src/doc/src/external-resources.qdoc b/src/doc/src/external-resources.qdoc
index 38e9654..9b6feb0 100644
--- a/src/doc/src/external-resources.qdoc
+++ b/src/doc/src/external-resources.qdoc
@@ -24,10 +24,6 @@
** $QT_END_LICENSE$
**
****************************************************************************/
-/*!
- \externalpage https://doc.qt.io/QtForDeviceCreation
- \title Qt for Device Creation
-*/
/*!
\externalpage http://code.qt.io/cgit/qt/qtdeviceutilities.git/
diff --git a/src/doc/src/qtdeviceutilities-index.qdoc b/src/doc/src/qtdeviceutilities-index.qdoc
index 3e4467e..c7e0d96 100644
--- a/src/doc/src/qtdeviceutilities-index.qdoc
+++ b/src/doc/src/qtdeviceutilities-index.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2019 The Qt Company Ltd.
+** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
@@ -57,20 +57,11 @@
target_link_libraries(mytarget Qt6::NetworkSettings)
\endcode
- \section2 Building with qmake
-
- If you're using qmake to build your application, add this line to your qmake .pro file:
-
- \badcode
- QT += networksettings
- \endcode
-
To import the QML types into your application, use the following import
statements in your .qml file:
\code
import QtDeviceUtilities.NetworkSettings
- import QtDeviceUtilities.SettingsUI
\endcode
\section1 Examples
diff --git a/src/doc/src/qtdeviceutilities-module-qml.qdoc b/src/doc/src/qtdeviceutilities-module-qml.qdoc
index 2c8fef5..510fc01 100644
--- a/src/doc/src/qtdeviceutilities-module-qml.qdoc
+++ b/src/doc/src/qtdeviceutilities-module-qml.qdoc
@@ -35,15 +35,11 @@
\badcode
import QtDeviceUtilities.NetworkSettings
- import QtDeviceUtilities.SettingsUI
\endcode
\section1 QML Types
\section2 Qt Network Settings Module
\generatelist qmltypesbymodule QtDeviceUtilities.NetworkSettings
-
- \section2 Qt Settings UI Module
- \generatelist qmltypesbymodule QtDeviceUtilities.SettingsUI
*/