itsblue-development/QBluetoothLeUart
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

some more doc updates

Browse source
This commit is contained in:
Dorian Zedler 2020-10-26 22:56:42 +01:00
parent 196fef2866
commit c72dc564e1
Signed by: dorian
GPG key ID: D3B255CB8BC7CD37
2 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
qbluetoothleuartclient.h
View file

@ -46,7 +46,7 @@
* \endcode * \endcode
* somewhere before app.exec(); in your main.cpp. * somewhere before app.exec(); in your main.cpp.
* *
* \section Getting started * \section Getting_started
* This library currently supports: BluetoothLE UART client * This library currently supports: BluetoothLE UART client
* \subsection BluetoothLE UART client * \subsection BluetoothLE UART client
* To get started with the BLE client, see the docs of QBluetoothLeUartClient. * To get started with the BLE client, see the docs of QBluetoothLeUartClient.
@ -59,7 +59,7 @@
* *
* C++ example: * C++ example:
* \code{.cpp} * \code{.cpp}
* #include <qbluetoothleuartClient.h> * #include <qbluetoothleuartclient.h>
* class MyBluetoothLeClass : QObject { * class MyBluetoothLeClass : QObject {
* public: * public:
* MyBluetoothLeClass(QObject* parent = nullptr) : QObject(parent) { * MyBluetoothLeClass(QObject* parent = nullptr) : QObject(parent) {
@ -122,6 +122,8 @@
* } * }
* } * }
* \endcode * \endcode
*
* To get all available devices in a model, use the QBluetoothLeUartDeviceModel.
*/ */
class QBluetoothLeUartClient : public QObject class QBluetoothLeUartClient : public QObject
{ {

2
qbluetoothleuartdevicemodel.h
View file

@ -12,7 +12,7 @@
* \code{.qml} * \code{.qml}
* import de.itsblue.bluetoothleuart 1.0 * import de.itsblue.bluetoothleuart 1.0
* *
* QBluetoothLeUart { * QBluetoothLeUartClient {
* id: ble * id: ble
* Component.onCompleted: { * Component.onCompleted: {
* ble.startScanningForDevices() * ble.startScanningForDevices()