From 261e4c619214af5e5cf95ec08a7d46d702ae0a93 Mon Sep 17 00:00:00 2001
From: Leena Miettinen <riitta-leena.miettinen@qt.io>
Date: Fri, 28 Sep 2018 15:23:47 +0200
Subject: 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>
---
 src/localdevice/qlocaldevice.cpp | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

(limited to 'src/localdevice/qlocaldevice.cpp')

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()
 {
 }
-- 
cgit v1.2.3