From 57b15814c8865e517c43fe173c0ffcadf8557ade Mon Sep 17 00:00:00 2001
From: Topi Reinio <topi.reinio@theqtcompany.com>
Date: Tue, 23 Aug 2016 15:12:03 +0200
Subject: 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>
---
 src/imports/bluetoothsettings/plugin.cpp | 72 ++++++++++++++++++++++++++++++++
 1 file changed, 72 insertions(+)

(limited to 'src/imports/bluetoothsettings')

diff --git a/src/imports/bluetoothsettings/plugin.cpp b/src/imports/bluetoothsettings/plugin.cpp
index abd6ec3..cd2cfcf 100644
--- a/src/imports/bluetoothsettings/plugin.cpp
+++ b/src/imports/bluetoothsettings/plugin.cpp
@@ -35,6 +35,78 @@
 #include "bluetoothdevice.h"
 #include "discoverymodel.h"
 
+/*!
+    \qmlmodule QtDeviceUtilities.BluetoothSettings 1.0
+    \title Qt Device Utilities: Bluetooth Settings
+    \ingroup qtee-qmlmodules
+    \brief Provides a singleton QML type for controlling bluetooth settings.
+
+    Provides a singleton QML type for controlling bluetooth settings in an
+    embedded device.
+
+    Import the module as follows:
+
+    \badcode
+    import QtDeviceUtilities.BluetoothSettings 1.0
+    \endcode
+
+    This will give you access to the singleton QML type BtDevice.
+
+    \note Some functions may not be available on all of the platforms.
+
+    \section1 QML Types
+*/
+
+/*!
+    \qmltype BtDevice
+    \inqmlmodule QtDeviceUtilities.BluetoothSettings
+    \brief A singleton QML type for controlling bluetooth settings.
+
+    There is no need to create an instance of this object. To use it,
+    simply import the \c {QtDeviceUtilities.BluetoothSettings} module.
+*/
+
+/*!
+    \qmlproperty bool BtDevice::scanning
+
+    Controls whether the Bluetooth device is scanning for remote devices.
+*/
+
+/*!
+    \qmlproperty bool BtDevice::powered
+
+    Powers the Bluetooth device on or off.
+*/
+
+/*!
+    \qmlproperty object BtDevice::deviceModel
+    \readonly
+
+    Holds the device model.
+*/
+
+/*!
+    \qmlmethod void BtDevice::requestPairing(string address)
+
+    Starts the process of pairing to a remove device specified by \a address,
+    and connects to it if the pairing was successful.
+*/
+
+/*!
+    \qmlmethod void BtDevice::requestConnect(string address)
+
+    Connects to a remove device specified by \a address.
+
+    \sa requestDisconnect()
+*/
+
+/*!
+    \qmlmethod void BtDevice::requestDisconnect(string address)
+
+    Disconnects from the remove device specified by \a address.
+
+    \sa requestConnect()
+*/
 template <typename T>
 QObject *instance(QQmlEngine *engine, QJSEngine *) {
     T *t = new T(engine);
-- 
cgit v1.2.3