Fix documentation issues and enable documentation testing in CI
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>
This commit is contained in:
parent
7c7d860ca5
commit
74215aeed1
|
@ -10,3 +10,4 @@ instructions:
|
|||
|
||||
Test:
|
||||
- !include "{{qt/qtbase}}/coin_module_test_template_v3.yaml"
|
||||
- !include "{{qt/qtbase}}/coin_module_test_docs.yaml"
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -752,13 +752,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
|
||||
|
|
|
@ -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
|
||||
|
|
Loading…
Reference in New Issue