From c72dc564e144315032f1d0d1c132aafdb2392c8c Mon Sep 17 00:00:00 2001 From: Dorian Zedler Date: Mon, 26 Oct 2020 22:56:42 +0100 Subject: [PATCH] some more doc updates --- qbluetoothleuartclient.h | 6 ++++-- qbluetoothleuartdevicemodel.h | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/qbluetoothleuartclient.h b/qbluetoothleuartclient.h index 298106d..01d2bf2 100644 --- a/qbluetoothleuartclient.h +++ b/qbluetoothleuartclient.h @@ -46,7 +46,7 @@ * \endcode * somewhere before app.exec(); in your main.cpp. * - * \section Getting started + * \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. @@ -59,7 +59,7 @@ * * C++ example: * \code{.cpp} - * #include + * #include * class MyBluetoothLeClass : QObject { * public: * MyBluetoothLeClass(QObject* parent = nullptr) : QObject(parent) { @@ -122,6 +122,8 @@ * } * } * \endcode + * + * To get all available devices in a model, use the QBluetoothLeUartDeviceModel. */ class QBluetoothLeUartClient : public QObject { diff --git a/qbluetoothleuartdevicemodel.h b/qbluetoothleuartdevicemodel.h index 0bccb0b..1409692 100644 --- a/qbluetoothleuartdevicemodel.h +++ b/qbluetoothleuartdevicemodel.h @@ -12,7 +12,7 @@ * \code{.qml} * import de.itsblue.bluetoothleuart 1.0 * - * QBluetoothLeUart { + * QBluetoothLeUartClient { * id: ble * Component.onCompleted: { * ble.startScanningForDevices()