summaryrefslogtreecommitdiffstats
path: root/src/bluetooth
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2019-11-09 01:16:37 +0100
committerTopi Reinio <topi.reinio@qt.io>2019-11-11 11:44:57 +0100
commit355f09eccc5ceba421e8c522e04cb7be72fa0a75 (patch)
tree78b5f1d013a384d60527f2044fb2b944d9a291d6 /src/bluetooth
parent176216459d84c59bf0cff26203928cfc144f164e (diff)
Doc: Fix documentation warnings
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>
Diffstat (limited to 'src/bluetooth')
-rw-r--r--src/bluetooth/doc/src/bluetooth-overview.qdoc11
-rw-r--r--src/bluetooth/qbluetoothdeviceinfo.cpp2
2 files changed, 7 insertions, 6 deletions
diff --git a/src/bluetooth/doc/src/bluetooth-overview.qdoc b/src/bluetooth/doc/src/bluetooth-overview.qdoc
index 33ccaa33..60e886a3 100644
--- a/src/bluetooth/doc/src/bluetooth-overview.qdoc
+++ b/src/bluetooth/doc/src/bluetooth-overview.qdoc
@@ -49,12 +49,13 @@
Note that the Object Push Profile is not supported on Android and Windows.
- Note that parts of RFCOMM functionality cannot be configured by Qt on Windows.
- A service's \l {ServiceClassIds} and \l {ProtocolDescriptorList} are filled automatically by
- Windows. Therefore registering a service with custom values for these fields might not yield the
- expected result on Windows.
+ \note Parts of RFCOMM functionality cannot be configured by Qt on
+ Windows. A service's \l {QBluetoothServiceInfo::}{ServiceClassIds} and
+ \l {QBluetoothServiceInfo::}{ProtocolDescriptorList} are filled
+ automatically. Therefore, registering a service with custom values for
+ these fields might not yield the expected result on Windows.
- Note that the Received Signal Strength Indicator (RSSI), as well as
+ \note The Received Signal Strength Indicator (RSSI), as well as
the Manufacturer Specific Data advertised by Bluetooth LE devices are
not supported by the Win32 backend. Also, it is only possible to find
devices that have been previously paired through Windows Settings.
diff --git a/src/bluetooth/qbluetoothdeviceinfo.cpp b/src/bluetooth/qbluetoothdeviceinfo.cpp
index 443902dc..a5bc7b81 100644
--- a/src/bluetooth/qbluetoothdeviceinfo.cpp
+++ b/src/bluetooth/qbluetoothdeviceinfo.cpp
@@ -611,7 +611,7 @@ QList<QBluetoothUuid> QBluetoothDeviceInfo::serviceUuids(DataCompleteness *compl
#else
-/*!
+/*
Returns the list of service UUIDS supported by the device. Most commonly this
list of uuids represents custom uuids or a uuid value specified by
\l QBluetoothUuid::ServiceClassUuid.