summaryrefslogtreecommitdiffstats
path: root/src/bluetooth/doc
Commit message (Collapse)AuthorAgeFilesLines
* Correct license for examples filesLucie Gérard2024-04-041-1/+1
| | | | | | | | | | | | | According to QUIP-18 [1], all examples and snippets files should be LicenseRef-Qt-Commercial OR BSD-3-Clause [1]: https://contribute.qt-project.org/quips/18 Pick-to: 6.7 Task-number: QTBUG-121787 Change-Id: I9a8fdb5308396e63785486291c4dc41cd59c1fe4 Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* Doc: Use proper Qt Bluetooth linkKai Köhne2024-01-091-1/+1
| | | | | | Pick-to: 6.7 Change-Id: I5805c3b8acd59826b5b3e8dc304d1b57f1b72df6 Reviewed-by: Ivan Solovev <ivan.solovev@qt.io>
* Doc: Extend list of highlighted Connectivity examplesKai Köhne2023-09-261-1/+4
| | | | | | | Pick-to: 6.5 6.6 6.6.0 Task-number: QTBUG-117221 Change-Id: Idc1d7793c02bc1009f5cc43d30e3208b923ab0ee Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* Doc: Fix parameter type in QBluetoothAddress::qHash()Topi Reinio2023-09-051-0/+3
| | | | | | | | | | | | Fixes documentation warning: clang couldn't find function when parsing \fn QBluetoothAddress::qHash(QBluetoothAddress key, size_t seed) Mark qtconnectivity documentation modules free of warnings. Pick-to: 6.6 Change-Id: Ia7966803bafd0eaac434462a18c704a944e8f527 Reviewed-by: Alex Blasche <alexander.blasche@qt.io> Reviewed-by: Ivan Solovev <ivan.solovev@qt.io>
* Make BlueZ DBus peripheral the default backend on LinuxJuha Vuolle2023-08-231-10/+12
| | | | | | | | | | | | | | | | | The DBus backend was introduced in Qt 6.5, and is intended as the eventual successor of the kernel backend. Users can opt-out and use the older kernel backend by setting the QT_BLUETOOTH_USE_KERNEL_PERIPHERAL environment variable. [ChangeLog][QtBluetooth] The default Linux peripheral implementation was changed from the kernel interface to the BlueZ DBus interface. The old implementation remains available by defining QT_BLUETOOTH_USE_KERNEL_PERIPHERAL as environment variable. Fixes: QTBUG-115925 Change-Id: I27d60e410c02d0435c7dce81e5c06448a89bcc65 Reviewed-by: Ivan Solovev <ivan.solovev@qt.io> Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* Doc: Remove \ingroup all-examples command from the docsJaishree Vyas2023-07-121-1/+0
| | | | | | | Task-number: QTBUG-115044 Pick-to: 6.5 6.6 Change-Id: I83314f3b7955e1ef9c857bcc96c07f6f90b2f875 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Remove warninglimit .qdocconf variableTopi Reinio2023-06-271-3/+0
| | | | | | | | | | | | | | | | The most common limit for the maximum number of allowed documentation warnings is zero. As all Qt module docs include() a common configuration from qtbase, it's better to control the base warninglimit from a central location in qtbase/doc/global. This allows for a temporary increase of the limit across all modules as needed - for example, when updating the QDoc binary that the CI provisions to a version that introduces new types of documentation warnings. Task-number: QTBUG-113326 Change-Id: I7174e53e00714bac68c7b3a4c0b2bd18615f6219 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* QtBluetooth: do not request permissions on AndroidIvan Solovev2023-04-051-0/+10
| | | | | | | | | | Expect it to be done on the application side. The library only checks for the needed permissions. Task-number: QTBUG-109964 Change-Id: Ibb6b756ddea13c14a4c096d200418923e9ccd69c Reviewed-by: Juha Vuolle <juha.vuolle@qt.io> Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io>
* HeartRate Game example: do not show duplicated devicesIvan Solovev2023-03-291-1/+4
| | | | | | | | | | | | The deviceDiscovered() signal can be emitted more than once for the same device, so implement a check before adding a device. This commit amends a1f43b9dcd722527d52ceb0c7a138bd2994c1a7b Task-number: QTBUG-111972 Pick-to: 6.5 Change-Id: Iff0a2b301d6d05090745ef97cedf5fab4532da7e Reviewed-by: Juha Vuolle <juha.vuolle@qt.io>
* HeartRate Server: revamp the exampleIvan Solovev2023-03-281-1/+1
| | | | | | | | | | | | | | | | | Some code clean-ups: * Use qt_standard_project_setup() and PRIVATE linking in CMake * Port away from QScopedPointer and use std::unique_ptr instead Documentation updates: * Add Connectivity category * Mention the new BlueZ D-Bus backend in the documentation * Small wording improvements * Provide more links to Qt classes and enums Task-number: QTBUG-111972 Pick-to: 6.5 6.5.0 Change-Id: Id2a0ef48d3ce82f1784dd4b51f94236731730432 Reviewed-by: Juha Vuolle <juha.vuolle@qt.io>
* Remove PingPong exampleIvan Solovev2023-03-222-4/+0
| | | | | | | | | | | | The example contains a lot of rather complicated code, which is not directly related to the demonstrated Bluetooth features. Remove it in favor of BtChat example, which demonstrates the same Bluetooth features in a much more compact and understandable way. Task-number: QTBUG-111972 Pick-to: 6.5 6.5.0 Change-Id: Iccb2598fa6e88816697286b2252858f35a635ee5 Reviewed-by: Juha Vuolle <juha.vuolle@qt.io>
* BtScanner example: move to manual testsIvan Solovev2023-03-212-4/+0
| | | | | | | | | | | | | | | | | | | | | | | The example mostly shows the usage of QBluetooth{Device,Service}DiscoveryAgent classes, which is also illustrated by other examples. Move it, because it's not fully functional on mobile platforms (because it's widget based). Do not remove it completely, because it might still be useful for doing Classic device scan. Also implement some improvements while on it: * fix CMakeLists.txt by using qt_standard_project_setup() and PRIVATE linking * fix memory leak in DeviceDiscoveryDialog * rework the code to use Qt parent-child model instead of manually deleting objects where possible * fix includes * fix forward declarations Task-number: QTBUG-111972 Pick-to: 6.5 6.5.0 Change-Id: Ie4bc9e25ccdda6d5f5de2f57528df349c71cdc12 Reviewed-by: Juha Vuolle <juha.vuolle@qt.io>
* Purge mentioning of Technical Preview from the Bt LE overviewAlex Blasche2023-01-111-5/+3
| | | | | | | | | | The various versions do not matter anymore as current Qt Version are long past the mentioned versions. Pick-to: 6.5 6.4 6.2 Change-Id: I285785eb64a82cacdd853380312e4810ec907c1c Reviewed-by: Ivan Solovev <ivan.solovev@qt.io> Reviewed-by: Juha Vuolle <juha.vuolle@qt.io>
* Add Bluez DBus peripheral role supportJuha Vuolle2022-12-071-0/+17
| | | | | | | | [ChangeLog][QtBluetooth] Add support for Bluez DBus peripheral role Fixes: QTBUG-107510 Change-Id: I1c26606ff0b01818c6f446147e005090582ba877 Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* Remove unused and redundant table row in documentationJuha Vuolle2022-10-141-7/+0
| | | | | | | | | | The row has been empty since its introduction and even if used, wouldn't provide very useful information (other rows imply the support) Pick-to: 6.2 6.4 Fixes: QTBUG-107196 Change-Id: I3e3ca4e6c446707772a24fc6b3ea000e4b889fdf Reviewed-by: Ivan Solovev <ivan.solovev@qt.io>
* Replace GATT specification link with accessible one in documentationJuha Vuolle2022-10-141-1/+1
| | | | | | | Pick-to: 6.2 6.4 Fixes: QTBUG-107192 Change-Id: Ie2a94c01aed3f47bb40b3b875b1bb1ed13401969 Reviewed-by: Ivan Solovev <ivan.solovev@qt.io>
* Fix unorthodoxically placed parantheses in documentationJuha Vuolle2022-10-141-9/+6
| | | | | | | Pick-to: 6.4 Fixes: QTBUG-107224 Change-Id: I6f21d4fe0b1db26352eb3f24510060a22b7f01c2 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Add a missing verb in BT LE documentationJuha Vuolle2022-10-141-2/+2
| | | | | | | Pick-to: 6.2 6.4 Fixes: QTBUG-107195 Change-Id: I60f6d6fb75c8cf335a90f2c55a5067e5e0b50d2e Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Change the license of all CMakeLists.txt and *.cmake files to BSDLucie Gérard2022-08-231-1/+1
| | | | | | | Task-number: QTBUG-105718 Change-Id: I8df2954bb61e0dc2a89f48c056b10a4bab395e0b Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Add license headers to cmake filesLucie Gérard2022-07-081-0/+3
| | | | | | | | | | | | | CMakeLists.txt and .cmake files of significant size (more than 2 lines according to our check in tst_license.pl) now have the copyright and license header. Existing copyright statements remain intact Task-number: QTBUG-88621 Change-Id: Ic31d264037cb00d72436d585820e45e4ccac5c60 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Fix documentation issues and enable documentation testing in CITopi Reinio2022-06-281-0/+3
| | | | | | | | | | This will fail the integration of changes that introduce new documentation warnings. Pick-to: 6.4 6.3 Change-Id: I503b123417308f7ba264422a78850e6188a10a48 Reviewed-by: Luca Di Sera <luca.disera@qt.io> Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* Use SPDX license identifiersLucie Gérard2022-06-107-205/+14
| | | | | | | | | | | Replace the current license disclaimer in files by a SPDX-License-Identifier. License files are organized under LICENSES directory. Pick-to: 6.4 Task-number: QTBUG-67283 Change-Id: Ifc22d8ae24532e9a1093ca613ed6590a1992bc39 Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Doc: Use find_package(Qt6 REQUIRED COMPONENTS ...) idiomKai Köhne2022-05-131-1/+1
| | | | | | | | | | | Using REQUIRED as a prefix instead of suffix works better with OPTIONAL_COMPONENTS, and is also the order in the CMake manual. Task-number: QTBUG-98867 Pick-to: 6.3 Change-Id: Id019afe67edccdff477569a483ec61393e57602b Reviewed-by: Rui Oliveira Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Doc: Depend bluetooth qdoc on qtgui, qtwidgetsKai Köhne2022-04-041-1/+1
| | | | | | | | | | | Should fix src/bluetooth/doc/src/bluetooth-index.qdoc:28: (qdoc) warning: Can't link to 'QGuiApplication' src/bluetooth/doc/src/bluetooth-index.qdoc:28: (qdoc) warning: Can't link to 'QApplication' src/bluetooth/doc/src/bluetooth-index.qdoc:28: (qdoc) warning: Can't link to 'QGuiApplication' Pick-to: 6.3 6.3.0 Change-Id: Ie1bd5255058816cdbb0814315c8c8cbbd6b0557a Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Revise Qt Bluetooth module landing pageAndreas Eliasson2022-03-281-25/+26
| | | | | | | Task-number: QTBUG-100369 Pick-to: 6.3 6.3.0 Change-Id: Ic86515dc16000ae2df4cf6cf53d9def5297cb489 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: remove mentioning of win32 backendKai Köhne2022-03-211-7/+0
| | | | | | | | | In Qt 6, we only support Windows 10 and the UWP backend. Pick-to: 6.2 6.3 Task-number: QTBUG-84433 Change-Id: Id64616a7547ed72eb64f3a57169bcba4a0ef6c7a Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* Doc: Unify naming of platformsKai Köhne2022-03-211-2/+2
| | | | | | | | The other platforms are also just referenced by their name. Pick-to: 6.3 Change-Id: I0350f557597cb74a911193d03018b2b50398f503 Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* Doc: Add macOS specific dependency informationNico Vertriest2021-10-081-0/+10
| | | | | | | | | | Qt Bluetooth requires QGuiApplication in certain cases, make sure that this is covered by the module docs. Pick-to: 6.2 Task-number: QTBUG-86796 Change-Id: Ib7918321b84ae51b436d2e47921e3de6d6736ad3 Reviewed-by: Timur Pocheptsov <timur.pocheptsov@qt.io>
* Bluetooth docs: mention the Apple's specific requirementsTimur Pocheptsov2021-09-071-0/+10
| | | | | | | | | | Info.plist with a textual description of why and what Bluetooth is needed for by a Qt-based app is required on iOS. Pick-to: 5.15 6.2 Change-Id: If838b57d6c13da9aeaf436dd013bd8496984a8bb Reviewed-by: Alex Blasche <alexander.blasche@qt.io> Reviewed-by: Andreas Buhr <andreas.buhr@qt.io>
* Doc: Update the depends list to fix a broken linkVenugopal Shivashankar2021-09-071-1/+1
| | | | | | | | | | The qmake manual is a separate module that must be in the depends list. Task-number: QTBUB-96181 Pick-to: 6.2 Change-Id: I5d20539de93789e9f6c123284cd47fd3e4b7ebca Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Fix qdoc warningsVenugopal Shivashankar2021-09-063-4/+3
| | | | | | | | | | | qt5/qtconnectivity/src/bluetooth/doc/src/bluetooth-cpp.qdoc:27: (qdoc) warning: Can't link to 'Qt Bluetooth QML Types' qt5/qtconnectivity/src/bluetooth/doc/src/bluetooth-index.qdoc:28: (qdoc) warning: Can't link to 'qmake' qt5/qtconnectivity/src/bluetooth/doc/src/bluetooth-index.qdoc:28: (qdoc) warning: Can't link to 'Build with CMake' Task-number: QTBUG-96181 Pick-to: 6.2 Change-Id: Ia5e9296f91e392aba59f555f6e93dcbe054f08cc Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Remove unsupported customFiltersKai Köhne2021-09-031-3/+0
| | | | | | | | | | customFilters defined in .qdocconf are not supported anymore by Qt Assistant since Qt 5.13. Therefore remove them from all .qdocconf files, also to avoid cargo-culting them to new help modules. Task-number: QTBUG-95987 Change-Id: I4e3c8d8d37d679105aa17b8fbc173db615c1b42a Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Replace "Getting Started" by "Using the Module" in QtBluetooth docsAndreas Buhr2021-08-192-3/+11
| | | | | | | Pick-to: 6.2 Fixes: QTBUG-94894 Change-Id: I628af802fc589e163dc9087fa7fc3fd7db71caba Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Beautify QtBluetooth 6 migration guideAndreas Buhr2021-08-191-55/+71
| | | | | | | | | Better styling, working links. Pick-to: 6.2 Fixes: QTBUG-94905 Change-Id: I3526c64fd15897bd0e0e33c4f78c9852d54fd2ae Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Don't mention changes in Qt 5.7 in QtBluetooth introduction docsAndreas Buhr2021-08-191-3/+0
| | | | | | | | | | People reading the introduction are probably not interested in changes long ago. Pick-to: 6.2 Task-number: QTBUG-94894 Change-Id: Ie9511d90aee6ce356f0f6ad7a4c91d518bc71e97 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Remove documentation of previously removed Qt Bluetooth QML typesAndreas Buhr2021-08-194-141/+1
| | | | | | | | | | | The QML interface to Qt Bluetooth was removed. This patch removes some remainders in the documentation. Pick-to: 6.2 Task-number: QTBUG-94894 Change-Id: I4e4d0ae354ccc1b88aa8530b89e6786752b8af49 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Oliver Wolff <oliver.wolff@qt.io>
* Doc: Fix typoPaul Wicking2021-07-261-1/+1
| | | | | | | Fixes: QTBUG-95349 Pick-to: 6.2 5.15 Change-Id: Ie1a7c71a33e5d620d914ffce193a89d080d81af9 Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* Create Qt5.15 to 6.2 migration documentation for QtBluetoothAndreas Buhr2021-07-222-0/+154
| | | | | | | Task-number: QTBUG-90920 Pick-to: 6.2 Change-Id: I1d99a7f6c6cd0f5f890c65c052ea8ceb87760275 Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* Drop Bluez4 from the documentationAlex Blasche2021-05-071-1/+1
| | | | | | | | | Disclaimer: there is still Bluez4 in the code base which is on its way out too. Change-Id: I4888ac955e51877c7d66f9e2eaa8e45997b4655d Reviewed-by: Andreas Buhr <andreas.buhr@qt.io> Reviewed-by: Timur Pocheptsov <timur.pocheptsov@qt.io>
* Doc: Fix documentation warningsTopi Reinio2021-04-301-0/+3
| | | | | | | | | | | | | * Restore (parts of) snippets.pro files for quoting in the documentation * Remove references to removed method, QNearFieldManager::registerNdefMessageHandler() Task-number: QTBUG-91875 Change-Id: Ib88c71da3426826b379832003a29fffc255aaaf5 Reviewed-by: Andreas Buhr <andreas.buhr@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* Remove link to "Qt for UWP" which has been removedAndreas Buhr2021-04-131-11/+2
| | | | | | | | | Fix build of documentation by removing the link to "Qt for UWP". UWP (Universal Windows Platform) uses the WinRT API. This has been removed from qtconnectivity. Change-Id: Id8582dbacdc75d826df925be7b146be53a55351c Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* Change QLowEnergyService::ServiceState enum to reflect future changesAndreas Buhr2021-04-082-5/+5
| | | | | | | | | | | | In the future, discoverDetails() should become optional. The state of a QLowEnergyService after its creation should have a name which does not imply it is not functional yet. This patch changes the name of the initial state from "DiscoveryRequired" to the neutral "RemoteService". Task-number: QTBUG-75340 Change-Id: Ib407e60f5fc7264a04a124561dacbcebb01bf252 Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* Fix doc warnings related to missing QML APIAlex Blasche2021-03-121-4/+2
| | | | | | Change-Id: If8cd35215db6e95a74b77ca802d3df003f1b3399 Reviewed-by: Andreas Buhr <andreas.buhr@qt.io> Reviewed-by: Karsten Heimrich <karsten.heimrich@qt.io>
* Use scoped enum for constants in QBluetoothUuidAndreas Buhr2021-03-112-8/+8
| | | | | | | | | | | | QBluetoothUuid contains enums for ProtocolUuid, ServiceClassUuid, CharacteristicType and DescriptorType. So far, they all put their constants directly into the QBluetoothUuid namespace, making it easy to mix them up. This patch changes those to scoped enums. That way, each enum has its items in its own namespace. Change-Id: I86ea08ff31009dc8073d84cfe678e27920d693f7 Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* Remove QML API from QtBluetoothAndreas Buhr2021-03-012-8/+0
| | | | | | | | | | | | This patch removes the BluetoothDiscoveryModel, QDeclarativeBluetoothService, and QDeclarativeBluetoothSocket. It also removes the "scanner" example and the "chat" example, both using BluetoothDiscoveryModel. Fixes: QTBUG-75354 Task-number: QTBUG-62877 Change-Id: Id9f6a75330e81c97ae9cd3fcaec793d0224ce72b Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* Remove QBluetoothTransferManager and friendsAndreas Buhr2021-02-264-59/+0
| | | | | | | | | | | | This patch removes QBluetoothTransferManager, QBluetoothTransferReply and QBluetoothTransferRequest. Furthermore, the examples "btfiletransfer" and "picturetransfer" are removed. Fixes: QTBUG-75353 Task-number: QTBUG-62877 Change-Id: Ife192d80196249185df877fb6a4cae317d7e44ad Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* Remove all *.pro files and all "special case" markers in CMakeLists.txtAndreas Buhr2021-01-151-8/+0
| | | | | | | | | | | | To use CMake only in the future to build QtConnectivity, all the traces from the qmake->CMake conversion can now be removed. This patch deletes all ".prev_CMakeLists.txt" files, in deletes all "*.pro" files and it removes all "special case" markers in CMakeLists.txt files. "special case" in "*.cmake" files are kept. Change-Id: Ia0f5d4de5d77b9f2e5cc8d97fc8f04077e042a6f Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io> Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* Rename QLEService::DiscoveringServices to DiscoveringServiceAlex Blasche2020-05-142-2/+2
| | | | | | | | | | | | Singular is a better fit to avoid the notion of several services being discovered at a given time. [ChangeLog][QtBluetooth][QLowEnergyService] Renamed DiscoveringServices enum value to DiscoveringService. Task-number: QTBUG-75344 Change-Id: I9ebe8a8ccba8bb49c55772ae81338f376826ee64 Reviewed-by: Timur Pocheptsov <timur.pocheptsov@qt.io>
* Doc: Fix documentation warningsTopi Reinio2019-11-111-5/+6
| | | | | | | | | | | | | | | Add a \class command for QNearFieldTarget::RequestId whose members were already documented. Remove QDoc comment marker for QBluetoothDeviceInfo::serviceUuids() overload as its declaration in the header file is omitted by a QT_DEPRECATED_SINCE macro. Fix linking issues and missing parameter documentation. Fixes: QTBUG-79814 Change-Id: I9804fcbd559f1924a2a7b16fdbdfb23398605eaa Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Merge remote-tracking branch 'origin/5.13' into 5.14v5.14.0-beta2Liang Qi2019-10-141-5/+6
|\ | | | | | | | | | | | | Conflicts: src/bluetooth/doc/src/bluetooth-index.qdoc Change-Id: If353b4ac63c72d6f94415e1349a206ade4ceb52e
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-22 00:17:36 +0000