summaryrefslogtreecommitdiffstats
path: root/src/doc/src/qtdeviceutilities-module-qml.qdoc
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2018-09-28 15:23:47 +0200
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2018-10-15 06:41:34 +0000
commit261e4c619214af5e5cf95ec08a7d46d702ae0a93 (patch)
treeb670a6f347a8a8053bee850162c6ed542fcb5524 /src/doc/src/qtdeviceutilities-module-qml.qdoc
parent0ecd391912f6338d5aef6105600fc8c321c83bd8 (diff)
Doc: Add documentation for C++ classes
Currently, only QML types are documented. Task-number: QTBUG-69686 Change-Id: Idc13bff25a154e88c6c769c0af37204573ec1118 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Teemu Holappa <teemu.holappa@qt.io>
Diffstat (limited to 'src/doc/src/qtdeviceutilities-module-qml.qdoc')
-rw-r--r--src/doc/src/qtdeviceutilities-module-qml.qdoc80
1 files changed, 80 insertions, 0 deletions
diff --git a/src/doc/src/qtdeviceutilities-module-qml.qdoc b/src/doc/src/qtdeviceutilities-module-qml.qdoc
new file mode 100644
index 0000000..44fc688
--- /dev/null
+++ b/src/doc/src/qtdeviceutilities-module-qml.qdoc
@@ -0,0 +1,80 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the Device Utilities module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+/*!
+ \qmlmodule QtDeviceutilities 1.0
+ \title Qt Device Utilities QML Types
+ \brief Provides additional modules that are useful for embedded
+ applications.
+ \ingroup qmlmodules
+
+ The QML types in the modules can be imported into your application using the
+ following import statements in your .qml file:
+
+ \badcode
+ import QtDeviceUtilities.BluetoothSettings 1.0
+ import QtDeviceUtilities.DisplaySettings 1.0
+ import QtDeviceUtilities.LocalDeviceSettings 1.0
+ import QtDeviceUtilities.LocaleSettings 1.0
+ import QtDeviceUtilities.NetworkSettings 1.0
+ import QtDeviceUtilities.SettingsUI 1.0
+ import QtDeviceUtilities.TimeDateSettings 1.0
+ \endcode
+
+ To link against the module, add this line to your qmake .pro file:
+
+ \badcode
+ QT += deviceutilities
+ \endcode
+
+ \section1 Modules
+
+ \annotatedlist qtee-qmlmodules
+
+ \section1 QML Types
+
+ \section2 Bluetooth Settings
+ \generatelist qmltypesbymodule QtDeviceUtilities.BluetoothSettings
+
+ \section2 Display Settings
+ \generatelist qmltypesbymodule QtDeviceUtilities.DisplaySettings
+
+ \section2 Local Device Settings
+ \generatelist qmltypesbymodule QtDeviceUtilities.LocalDeviceSettings
+
+ \section2 Locale Settings
+ \generatelist qmltypesbymodule QtDeviceUtilities.LocaleSettings
+
+ \section2 Network Settings
+ \generatelist qmltypesbymodule QtDeviceUtilities.NetworkSettings
+
+ \section2 Time and Date Settings
+ \generatelist qmltypesbymodule QtDeviceUtilities.TimeDateSettings
+
+ \section2 Settings UI
+ \generatelist qmltypesbymodule QtDeviceUtilities.SettingsUI
+*/
+