summaryrefslogtreecommitdiffstats
path: root/src/doc/src
diff options
context:
space:
mode:
Diffstat (limited to 'src/doc/src')
-rw-r--r--src/doc/src/qtdeviceutilities-examples.qdoc45
-rw-r--r--src/doc/src/qtdeviceutilities-index.qdoc73
-rw-r--r--src/doc/src/qtdeviceutilities-module-qml.qdoc (renamed from src/doc/src/qtdeviceutilities.qdoc)45
-rw-r--r--src/doc/src/qtdeviceutitilies-module-cpp.qdoc48
-rw-r--r--src/doc/src/wifiexample.qdoc2
5 files changed, 192 insertions, 21 deletions
diff --git a/src/doc/src/qtdeviceutilities-examples.qdoc b/src/doc/src/qtdeviceutilities-examples.qdoc
new file mode 100644
index 0000000..e912b94
--- /dev/null
+++ b/src/doc/src/qtdeviceutilities-examples.qdoc
@@ -0,0 +1,45 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+/*!
+
+ \group qtdeviceutilities-examples
+ \title Qt Device Utilities Examples
+ \brief Examples on using Qt Device Utilities.
+ \ingroup-all-examples
+
+ \l{Qt Device Utilities WiFi Tutorial} demonstrates how you can use
+ the \l{QtDeviceUtilities.NetworkSettings}{NetworkSettings} module for
+ connecting to WiFi.
+
+ The source code of Qt Device Utilities is availabe via a public Git repository.
+ For more information, see \l{Device Utilities Git Repository}.
+
+ You find the Qt Device Utilities module sources under
+ \l{http://code.qt.io/cgit/qt/qtdeviceutilities.git/tree/src}. Especially,
+ the sources of \l{Settings UI} provide examples of how to use Qt Device Utilities.
+*/
diff --git a/src/doc/src/qtdeviceutilities-index.qdoc b/src/doc/src/qtdeviceutilities-index.qdoc
new file mode 100644
index 0000000..af4d26e
--- /dev/null
+++ b/src/doc/src/qtdeviceutilities-index.qdoc
@@ -0,0 +1,73 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the documentation 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$
+**
+****************************************************************************/
+
+/*!
+ \page qtdeviceutilities-index.html
+ \title Qt Device Utilities
+ \brief Provides functionality that is useful for embedded applications.
+
+ \section1 Getting Started
+
+ To include the definitions of the module's classes, use the following
+ directive:
+
+ \code
+ #include <QDeviceUtilities>
+ \endcode
+
+ To import the QML types into your application, use the following import
+ statements in your .qml file:
+
+ \code
+ 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:
+
+ \code
+ QT += deviceutilities
+ \endcode
+
+ \section1 Examples
+
+ \list
+ \li \l {Qt Device Utilities Examples}
+ \endlist
+
+ \section1 Reference
+
+ \list
+ \li \l {Qt Device Utilities C++ Classes} {C++ Classes and Namespaces}
+ \li \l {Qt Device Utilities QML Types} {QML Types}
+ \endlist
+*/
diff --git a/src/doc/src/qtdeviceutilities.qdoc b/src/doc/src/qtdeviceutilities-module-qml.qdoc
index 9c7c5d5..44fc688 100644
--- a/src/doc/src/qtdeviceutilities.qdoc
+++ b/src/doc/src/qtdeviceutilities-module-qml.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2017 The Qt Company Ltd.
+** 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.
@@ -25,11 +25,30 @@
**
****************************************************************************/
/*!
- \page qtee-module-reference.html
- \maintitle
-
- The \B2Q stack in \SDK includes a number of additional modules that are
- useful for embedded applications.
+ \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
@@ -57,19 +76,5 @@
\section2 Settings UI
\generatelist qmltypesbymodule QtDeviceUtilities.SettingsUI
-
- \section1 Tutorial and Example Code
-
- \l{Qt Device Utilities WiFi Tutorial} demonstrates how you can use
- the \l{QtDeviceUtilities.NetworkSettings}{NetworkSettings} module for
- connecting to WiFi.
-
- The source code of Qt Device Utilities is availabe via a public Git repository.
- For more information, see \l{Device Utilities Git Repository}.
-
- You find the Qt Device Utilities module sources under
- \l{http://code.qt.io/cgit/qt/qtdeviceutilities.git/tree/src}. Especially,
- the sources of \l{Settings UI} provide examples of how to use Qt Device Utilities.
-
*/
diff --git a/src/doc/src/qtdeviceutitilies-module-cpp.qdoc b/src/doc/src/qtdeviceutitilies-module-cpp.qdoc
new file mode 100644
index 0000000..caa9346
--- /dev/null
+++ b/src/doc/src/qtdeviceutitilies-module-cpp.qdoc
@@ -0,0 +1,48 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the documentation 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$
+**
+****************************************************************************/
+
+/*!
+ \module QtDeviceUtilities
+ \title Qt Device Utilities C++ Classes
+ \brief Provides classes that are useful for embedded applications.
+ \ingroup modules
+
+ \qtvariable deviceutilities
+
+ To include the definitions of the module's classes, use the following
+ directive:
+
+ \badcode
+ #include <QtDeviceUtilities>
+ \endcode
+
+ To link against the module, add this line to your qmake .pro file:
+
+ \badcode
+ QT += qtdeviceutilities
+ \endcode
+*/
diff --git a/src/doc/src/wifiexample.qdoc b/src/doc/src/wifiexample.qdoc
index ce5d43c..2de002b 100644
--- a/src/doc/src/wifiexample.qdoc
+++ b/src/doc/src/wifiexample.qdoc
@@ -27,7 +27,7 @@
/*!
\page qtdeviceutilities-wifitutorial.html
\title Qt Device Utilities WiFi Tutorial
- \previouspage qtee-module-reference.html
+ \previouspage Qt Device Utilities Examples
\section1 Importing NetworkSettings