summaryrefslogtreecommitdiffstats
path: root/src/localdevice
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/localdevice
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/localdevice')
-rw-r--r--src/localdevice/qlocaldevice.cpp17
1 files changed, 17 insertions, 0 deletions
diff --git a/src/localdevice/qlocaldevice.cpp b/src/localdevice/qlocaldevice.cpp
index f6b2c2b..131539a 100644
--- a/src/localdevice/qlocaldevice.cpp
+++ b/src/localdevice/qlocaldevice.cpp
@@ -32,11 +32,28 @@
QT_BEGIN_NAMESPACE
+/*!
+ \class QLocalDevice
+ \inmodule QtDeviceUtilities
+
+ \brief The QLocalDevice class provides utility functions for controlling an
+ embedded device.
+
+ The methods in this class enable shutting down and rebooting an embedded
+ device.
+*/
+
+/*!
+ Creates a new local device with the parent \a parent.
+*/
QLocalDevice::QLocalDevice(QObject *parent)
: QObject(parent)
{
}
+/*!
+ Deletes the local device.
+*/
QLocalDevice::~QLocalDevice()
{
}