diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2022-06-22 15:52:19 +0200 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2022-06-28 11:44:58 +0000 |
| commit | 2a061abd67828462c1f6d329e82cc452dfb02a41 (patch) | |
| tree | 94c275eb9b771ea792865bc00d669e98d1007d80 | |
| parent | ab00a53c8dd8879b24a0fb2cfe282f72e945bcd5 (diff) | |
| download | qtconnectivity-2a061abd67828462c1f6d329e82cc452dfb02a41.tar.gz | |
Fix documentation issues and enable documentation testing in CI
This will fail the integration of changes that introduce new
documentation warnings.
Change-Id: I503b123417308f7ba264422a78850e6188a10a48
Reviewed-by: Luca Di Sera <luca.disera@qt.io>
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
(cherry picked from commit 74215aeed1c27b56acd266673ba4447b287c145d)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
| -rw-r--r-- | coin/module_config.yaml | 1 | ||||
| -rw-r--r-- | src/bluetooth/doc/qtbluetooth.qdocconf | 3 | ||||
| -rw-r--r-- | src/bluetooth/qbluetoothsocket.cpp | 12 | ||||
| -rw-r--r-- | src/nfc/doc/qtnfc.qdocconf | 3 |
4 files changed, 14 insertions, 5 deletions
diff --git a/coin/module_config.yaml b/coin/module_config.yaml index 16d158c6..aaf33238 100644 --- a/coin/module_config.yaml +++ b/coin/module_config.yaml @@ -10,3 +10,4 @@ instructions: Test: - !include "{{qt/qtbase}}/coin_module_test_template_v3.yaml" + - !include "{{qt/qtbase}}/coin_module_test_docs.yaml" diff --git a/src/bluetooth/doc/qtbluetooth.qdocconf b/src/bluetooth/doc/qtbluetooth.qdocconf index 5040acfc..d8bc6e7a 100644 --- a/src/bluetooth/doc/qtbluetooth.qdocconf +++ b/src/bluetooth/doc/qtbluetooth.qdocconf @@ -46,3 +46,6 @@ imagedirs += images navigation.landingpage = "Qt Bluetooth" navigation.cppclassespage = "Qt Bluetooth C++ Classes" + +# Fail the documentation build if there are more warnings than the limit +warninglimit = 0 diff --git a/src/bluetooth/qbluetoothsocket.cpp b/src/bluetooth/qbluetoothsocket.cpp index e597bc86..62c3fa42 100644 --- a/src/bluetooth/qbluetoothsocket.cpp +++ b/src/bluetooth/qbluetoothsocket.cpp @@ -786,13 +786,15 @@ void QBluetoothSocket::close() } /*! - Set the socket to use \a socketDescriptor with a type of \a socketType, - which is in state, \a socketState, and mode, \a openMode. + \fn bool QBluetoothSocket::setSocketDescriptor(int socketDescriptor, QBluetoothServiceInfo::Protocol socketType, SocketState socketState, OpenMode openMode) - The set socket descriptor is considered owned by the QBluetoothSocket - and may be e.g. closed once finished. + Sets the socket to use \a socketDescriptor with a type of \a socketType, + which is in state \a socketState, and mode \a openMode. - Returns true on success + The socket descriptor is owned by the QBluetoothSocket instance and may + be closed once finished. + + Returns \c true on success. */ // ### Qt 7 consider making this function private. The qbluetoothsocket_bluez backend is the diff --git a/src/nfc/doc/qtnfc.qdocconf b/src/nfc/doc/qtnfc.qdocconf index 7d69c45d..f3c39bf2 100644 --- a/src/nfc/doc/qtnfc.qdocconf +++ b/src/nfc/doc/qtnfc.qdocconf @@ -43,3 +43,6 @@ imagedirs += images navigation.landingpage = "Qt NFC" navigation.cppclassespage = "Qt NFC C++ Classes" + +# Fail the documentation build if there are more warnings than the limit +warninglimit = 0 |