summaryrefslogtreecommitdiffstats
path: root/src/doc
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@theqtcompany.com>2016-08-23 15:12:03 +0200
committerTopi Reiniƶ <topi.reinio@theqtcompany.com>2016-09-06 07:22:31 +0000
commit57b15814c8865e517c43fe173c0ffcadf8557ade (patch)
tree35c238f57be475e69abd3e34baa32a136739dfd5 /src/doc
parent1812b8e95b8b27b0879c97e66fcda739b502f7aa (diff)
Doc: Document QtDeviceUtilities
Added documentation for the following QML modules: QtDeviceUtilities.BluetoothSettings QtDeviceUtilities.DisplaySettings QtDeviceUtilities.LocalDeviceSettings QtDeviceUtilities.LocaleSettings QtDeviceUtilities.NetworkSettings QtDeviceUtilities.TimeDateSettings QtDeviceUtilities.SettingsUI And changed the name of this documentation module to 'Qt Device Utilities'. Task-number: QTBUG-55320 Change-Id: Iee0d8467dccddc0ee75d7a395ae91f68b12ab9f2 Reviewed-by: Kimmo Ollila <kimmo.ollila@theqtcompany.com>
Diffstat (limited to 'src/doc')
-rw-r--r--src/doc/config/qtdeviceutilities-project.qdocconf23
-rw-r--r--src/doc/src/qtdeviceutilities.qdoc29
2 files changed, 35 insertions, 17 deletions
diff --git a/src/doc/config/qtdeviceutilities-project.qdocconf b/src/doc/config/qtdeviceutilities-project.qdocconf
index 9aecc29..3b8b06c 100644
--- a/src/doc/config/qtdeviceutilities-project.qdocconf
+++ b/src/doc/config/qtdeviceutilities-project.qdocconf
@@ -3,11 +3,17 @@ description = Qt Device Utilities
version = 5.7.1
sourcedirs += ../src \
- ../../imports/wifi \
- ../../imports/utils \
- ../../wifi
-
-headerdirs += ../../wifi
+ ../../imports/localesettings \
+ ../../imports/bluetoothsettings \
+ ../../imports/displaysettings \
+ ../../imports/localdevice \
+ ../../imports/localesettings \
+ ../../imports/timedatesettings \
+ ../../imports/networksettings \
+ ../../settingsui/settingsuiplugin \
+ ../../networksettings
+
+headerdirs += ../../networksettings
exampledirs += ../../../examples
@@ -25,12 +31,12 @@ qhp.projects = QtDeviceUtilities
qhp.QtDeviceUtilities.file = qtdeviceutilities.qhp
qhp.QtDeviceUtilities.namespace = io.qt.qtdeviceutilities.571
qhp.QtDeviceUtilities.virtualFolder = qtdeviceutilities
-qhp.QtDeviceUtilities.indexTitle = Qt for Device Creation: Add-On Modules
+qhp.QtDeviceUtilities.indexTitle = Qt Device Utilities
qhp.QtDeviceUtilities.indexRoot =
qhp.QtDeviceUtilities.subprojects = modules
qhp.QtDeviceUtilities.subprojects.modules.title = Modules
-qhp.QtDeviceUtilities.subprojects.modules.indexTitle = Qt for Device Creation: Add-On Modules
+qhp.QtDeviceUtilities.subprojects.modules.indexTitle = Qt Device Utilities
qhp.QtDeviceUtilities.subprojects.modules.selectors = qmlmodule module
qhp.QtDeviceUtilities.subprojects.modules.sortPages = true
@@ -42,6 +48,7 @@ macro.B2QL = "\\e {Boot to Qt for embedded Linux}"
# Keep Device Creation as the landing page
navigation.landingpage = "Qt for Device Creation"
-navigation.qmltypespage = "Qt for Device Creation: Add-On Modules"
+navigation.qmltypespage = "Qt Device Utilities"
Cpp.ignoredirectives += Q_DECLARE_LOGGING_CATEGORY
+Cpp.ignoretokens += Q_DEL_EXPORT
diff --git a/src/doc/src/qtdeviceutilities.qdoc b/src/doc/src/qtdeviceutilities.qdoc
index a569540..0f2cb7c 100644
--- a/src/doc/src/qtdeviceutilities.qdoc
+++ b/src/doc/src/qtdeviceutilities.qdoc
@@ -17,25 +17,36 @@
****************************************************************************/
/*!
\page qtee-module-reference.html
- \title Qt for Device Creation: Add-On Modules
+ \title Qt Device Utilities
The \B2Q stack in \SDK includes a number of additional modules that are
useful for embedded applications.
- \annotatedlist qtee-modules
+ \section1 Modules
- \section1 B2Qt Utils Module
+ \annotatedlist qtee-qmlmodules
- \annotatedlist utils-qmltypes
+ \section1 QML Types
- \section1 B2Qt Wifi Module
+ \section2 Bluetooth Settings
+ \generatelist qmltypesbymodule QtDeviceUtilities.BluetoothSettings
- \section2 QML Types
+ \section2 Display Settings
+ \generatelist qmltypesbymodule QtDeviceUtilities.DisplaySettings
- \annotatedlist wifi-qmltypes
+ \section2 Local Device Settings
+ \generatelist qmltypesbymodule QtDeviceUtilities.LocalDeviceSettings
- \section2 C++ Classes
+ \section2 Locale Settings
+ \generatelist qmltypesbymodule QtDeviceUtilities.LocaleSettings
- \annotatedlist wifi-cppclasses
+ \section2 Network Settings
+ \generatelist qmltypesbymodule QtDeviceUtilities.NetworkSettings
+
+ \section2 Time and Date Settings
+ \generatelist qmltypesbymodule QtDeviceUtilities.TimeDateSettings
+
+ \section2 Settings UI
+ \generatelist qmltypesbymodule QtDeviceUtilities.SettingsUI
*/