From 16a7842ddbd88f87db0b1486d5c2f418860e3e98 Mon Sep 17 00:00:00 2001
From: Topi Reinio <topi.reinio@digia.com>
Date: Tue, 8 Apr 2014 13:22:20 +0200
Subject: Doc: Document B2Qt.Utils module

Task-number: QTEE-474
Change-Id: I95064ac5908a067751d8182f6a0d883f07f7e756
Reviewed-by: Eirik Aavitsland <eirik.aavitsland@digia.com>
---
 src/imports/utils/plugin.cpp | 103 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 103 insertions(+)

(limited to 'src/imports')

diff --git a/src/imports/utils/plugin.cpp b/src/imports/utils/plugin.cpp
index 46aa4d2..3adf633 100644
--- a/src/imports/utils/plugin.cpp
+++ b/src/imports/utils/plugin.cpp
@@ -19,6 +19,109 @@
 #include <b2qtdevice.h>
 #include <QtQml>
 
+/*!
+    \qmlmodule B2Qt.Utils 1.0
+    \title B2Qt Utils Module
+    \ingroup qtee-qmlmodules
+    \brief A collection of utility functions, accessible from QML.
+
+    Provides various utility functions for controlling an embedded
+    device, such as display brightness, IP address and hostname, and
+    device shutdown/reboot.
+
+    Import the module as follows:
+
+    \badcode
+    import B2Qt.Utils 1.0
+    \endcode
+
+    This will give you access to the singleton QML type B2QtDevice.
+
+    \note Some functions are currently only implemented for one of
+          the platforms.
+
+    \section1 QML Types
+*/
+
+/*!
+    \qmltype B2QtDevice
+    \inqmlmodule B2Qt.Utils
+    \ingroup utils-qmltypes
+    \brief Singleton QML type providing access to utility functions.
+
+    B2QtDevice QML type is the interface to various utility
+    functions.
+
+    There is no need to create an instance of this object. To use it,
+    simply import the \c {B2Qt.Utils} module:
+
+    \qml
+    import B2Qt.Utils 1.0
+
+    Text {
+        text: qsTr("IP Address:") + B2QtDevice.ipAddress
+    }
+    \endqml
+
+    \note Some functions are currently only implemented for one of
+          the platforms.
+*/
+
+/*!
+    \qmlmethod B2Qt.Utils::B2QtDevice::reboot()
+
+    Reboots the system. Does not return.
+
+    \sa powerOff()
+*/
+
+/*!
+    \qmlmethod B2Qt.Utils::B2QtDevice::powerOff()
+
+    Shuts down the system. Does not return.
+
+    \sa reboot()
+*/
+
+/*!
+    \qmlproperty int B2Qt.Utils::B2QtDevice::masterVolume
+
+    This property holds the master volume of the device.
+    The volume can range from \c 0 to \c 100 and is linear.
+    Changing the master volume will affect all audio streams.
+
+    \note Currently implemented only for \B2QA.
+*/
+
+/*!
+    \qmlproperty int B2Qt.Utils::B2QtDevice::displayBrightness
+    This property holds the display brightness (the intensity of the backlight).
+    The value is in the range from \c 0 to \c 255, where 255 is the maximum
+    brightness, and 0 is the minimum (typically, the backlight is turned off).
+
+    \note Currently implemented only for \B2QA.
+*/
+
+/*!
+    \qmlproperty string B2Qt.Utils::B2QtDevice::ipAddress
+    \readonly
+
+    This property holds the current IP address(es) of the device
+    for all active network interfaces. If multiple IP addresses are defined,
+    this property holds a comma-separated list. The localhost (loopback)
+    IP addresses are omitted.
+
+   \sa hostname
+*/
+
+/*!
+    \qmlproperty string B2Qt.Utils::B2QtDevice::hostname
+
+    This property holds the current hostname of the device.
+
+   \sa ipAddress
+*/
+
 static QObject *module_api_factory(QQmlEngine *engine, QJSEngine *scriptEngine)
 {
    Q_UNUSED(engine)
-- 
cgit v1.2.3