From 86ad00899b62553129574dcb8895f6ae19231f85 Mon Sep 17 00:00:00 2001
From: Dorian Zedler <dorian@itsblue.dev>
Date: Mon, 26 Oct 2020 22:48:15 +0100
Subject: [PATCH] update docs

---
 qbluetoothleuartclient.h | 22 ++++++++++++++--------
 1 file changed, 14 insertions(+), 8 deletions(-)

diff --git a/qbluetoothleuartclient.h b/qbluetoothleuartclient.h
index 1707d44..298106d 100644
--- a/qbluetoothleuartclient.h
+++ b/qbluetoothleuartclient.h
@@ -45,29 +45,35 @@
  *  QBluetoothLeUart::init();
  * \endcode
  * somewhere before app.exec(); in your main.cpp.
+ *
+ * \section Getting started
+ * This library currently supports: BluetoothLE UART client
+ * \subsection BluetoothLE UART client
+ * To get started with the BLE client, see the docs of QBluetoothLeUartClient.
+ *
  */
 
 /*!
- * \brief The QBluetoothLeUart class can be used to talk to BluetoothLE devices via UART effordlessly.
+ * \brief The QBluetoothLeUartClient class can be used to talk to BluetoothLE devices via UART effordlessly.
  * It can be used via C++ and QML.
  *
  * C++ example:
  * \code{.cpp}
- * #include <qbluetoothleuart.h>
+ * #include <qbluetoothleuartClient.h>
  * class MyBluetoothLeClass : QObject {
  * public:
  *     MyBluetoothLeClass(QObject* parent = nullptr) : QObject(parent) {
- *         this->ble = new QBluetoothLeUart();
+ *         this->ble = new QBluetoothLeUartClient();
  *
- *         connect(this->ble, &QBluetoothLeUart::foundNewDevice, this, &MyBluetoothLeClass::handleFoundNewDevice);
- *         connect(this->ble, &QBluetoothLeUart::connectedToDevice, this, &MyBluetoothLeClass::handleBluetoothDeviceConected);
- *         connect(this->ble, &QBluetoothLeUart::dataReceived, this, &MyBluetoothLeClass::handleDataReceived);
+ *         connect(this->ble, &QBluetoothLeUartClient::foundNewDevice, this, &MyBluetoothLeClass::handleFoundNewDevice);
+ *         connect(this->ble, &QBluetoothLeUartClient::connectedToDevice, this, &MyBluetoothLeClass::handleBluetoothDeviceConected);
+ *         connect(this->ble, &QBluetoothLeUartClient::dataReceived, this, &MyBluetoothLeClass::handleDataReceived);
  *
  *         this->ble->startScanningForDevices();
  *     }
  *
  * private:
- *     QBluetoothLeUart *ble;
+ *     QBluetoothLeUartClient *ble;
  *
  * private slots:
  *     void handleFoundNewDevice(QBluetoothLeUartDevice* device) {
@@ -93,7 +99,7 @@
  * \code{.qml}
  * import de.itsblue.bluetoothleuart 1.0
  *
- * QBluetoothLeUart {
+ * QBluetoothLeUartClient {
  *     id: ble
  *     Component.onCompleted: {
  *         ble.startScanningForDevices()