diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2019-11-09 01:16:37 +0100 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2019-11-11 11:44:57 +0100 |
| commit | 355f09eccc5ceba421e8c522e04cb7be72fa0a75 (patch) | |
| tree | 78b5f1d013a384d60527f2044fb2b944d9a291d6 | |
| parent | 176216459d84c59bf0cff26203928cfc144f164e (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>
| -rw-r--r-- | src/bluetooth/doc/src/bluetooth-overview.qdoc | 11 | ||||
| -rw-r--r-- | src/bluetooth/qbluetoothdeviceinfo.cpp | 2 | ||||
| -rw-r--r-- | src/nfc/qnearfieldmanager.cpp | 2 | ||||
| -rw-r--r-- | src/nfc/qnearfieldtarget.cpp | 7 |
4 files changed, 15 insertions, 7 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. diff --git a/src/nfc/qnearfieldmanager.cpp b/src/nfc/qnearfieldmanager.cpp index 02e4d918..82a8bfbe 100644 --- a/src/nfc/qnearfieldmanager.cpp +++ b/src/nfc/qnearfieldmanager.cpp @@ -150,7 +150,7 @@ QT_BEGIN_NAMESPACE \since 5.12 - This signal is emitted whenever the state of the NFC adapter changed. + This signal is emitted whenever the \a state of the NFC adapter changed. \note Currently, this signal is only emitted on Android. */ diff --git a/src/nfc/qnearfieldtarget.cpp b/src/nfc/qnearfieldtarget.cpp index 7d83db78..2905c380 100644 --- a/src/nfc/qnearfieldtarget.cpp +++ b/src/nfc/qnearfieldtarget.cpp @@ -176,6 +176,13 @@ quint16 qNfcChecksum(const char *data, uint len) */ /*! + \class QNearFieldTarget::RequestId + \inmodule QtHfc + \inheaderfile QNearFieldTarget + \brief A request id handle. +*/ + +/*! Constructs a new invalid request id handle. */ QNearFieldTarget::RequestId::RequestId() |