diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2022-04-22 20:33:12 +0200 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2022-05-09 15:21:14 +0200 |
| commit | f82be9691a29bc2e07277661e664fed3d94b5fa5 (patch) | |
| tree | 604874bbca8d4af3178a27a8c2f5e03418c4a187 /src | |
| parent | b0030b2b4dd640a1289e483121ab20b1b35dd0be (diff) | |
| download | qtwebsockets-f82be9691a29bc2e07277661e664fed3d94b5fa5.tar.gz | |
Fix remaining documentation warnings and enable doc testing in CI
Change-Id: If1238f62ed41fcf17cb794ffcf68a0ee3e17b030
Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
Diffstat (limited to 'src')
| -rw-r--r-- | src/websockets/doc/qtwebsockets.qdocconf | 11 | ||||
| -rw-r--r-- | src/websockets/qwebsockethandshakeoptions.cpp | 15 |
2 files changed, 13 insertions, 13 deletions
diff --git a/src/websockets/doc/qtwebsockets.qdocconf b/src/websockets/doc/qtwebsockets.qdocconf index c052fb0..d386eeb 100644 --- a/src/websockets/doc/qtwebsockets.qdocconf +++ b/src/websockets/doc/qtwebsockets.qdocconf @@ -18,23 +18,23 @@ qhp.QtWebSockets.indexRoot = qhp.QtWebSockets.subprojects = classes qml examples qhp.QtWebSockets.subprojects.classes.title = C++ Classes qhp.QtWebSockets.subprojects.classes.indexTitle = Qt WebSockets C++ Classes -qhp.QtWebSockets.subprojects.classes.selectors = class fake:headerfile +qhp.QtWebSockets.subprojects.classes.selectors = class headerfile qhp.QtWebSockets.subprojects.classes.sortPages = true qhp.QtWebSockets.subprojects.qml.title = QML Types qhp.QtWebSockets.subprojects.qml.indexTitle = Qt WebSockets QML Types -qhp.QtWebSockets.subprojects.qml.selectors = qmlclass +qhp.QtWebSockets.subprojects.qml.selectors = qmltype qhp.QtWebSockets.subprojects.qml.sortPages = true qhp.QtWebSockets.subprojects.examples.title = Examples qhp.QtWebSockets.subprojects.examples.indexTitle = Qt WebSockets Examples -qhp.QtWebSockets.subprojects.examples.selectors = fake:example +qhp.QtWebSockets.subprojects.examples.selectors = doc:example qhp.QtWebSockets.subprojects.examples.sortPages = true tagfile = ../../../doc/qtwebsockets/qtwebsockets.tags -depends += qtcore qtnetwork qtdoc qmake +depends += qtcore qtnetwork qtdoc qmake qtcmake headerdirs += .. \ ../../imports @@ -62,3 +62,6 @@ manifestmeta.thumbnail.names += "QtWebSockets/Echo Client navigation.landingpage = "Qt WebSockets" navigation.cppclassespage = "Qt WebSockets C++ Classes" navigation.qmltypespage = "Qt WebSockets QML Types" + +# Enforce zero warnings for documentation build +warninglimit = 0 diff --git a/src/websockets/qwebsockethandshakeoptions.cpp b/src/websockets/qwebsockethandshakeoptions.cpp index cef92c5..fc7eb8b 100644 --- a/src/websockets/qwebsockethandshakeoptions.cpp +++ b/src/websockets/qwebsockethandshakeoptions.cpp @@ -89,7 +89,7 @@ QWebSocketHandshakeOptions::~QWebSocketHandshakeOptions() } /*! - \fn QWebSocketHandshakeOptions &operator=(QWebSocketHandshakeOptions &&other) noexcept + \fn QWebSocketHandshakeOptions &QWebSocketHandshakeOptions::operator=(QWebSocketHandshakeOptions &&other) \brief Moves \a other to this object. */ @@ -118,8 +118,8 @@ QStringList QWebSocketHandshakeOptions::subprotocols() const } /*! - \brief Sets the list of WebSocket subprotocols to send along with the - websocket handshake. + \brief Sets the list of WebSocket subprotocols \a protocols to send along + with the websocket handshake. WebSocket subprotocol names may only consist of those US-ASCII characters that are in the unreserved group. Invalid protocol names will not be @@ -136,12 +136,9 @@ bool QWebSocketHandshakeOptions::equals(const QWebSocketHandshakeOptions &other) } /*! - \fn operator==(const QWebSocketHandshakeOptions &lhs, const QWebSocketHandshakeOptions &rhs) + //! friend + \fn QWebSocketHandshakeOptions::operator==(const QWebSocketHandshakeOptions &lhs, const QWebSocketHandshakeOptions &rhs) + \fn QWebSocketHandshakeOptions::operator!=(const QWebSocketHandshakeOptions &lhs, const QWebSocketHandshakeOptions &rhs) \brief Compares \a lhs for equality with \a rhs. */ -/*! - \fn operator!=(const QWebSocketHandshakeOptions &lhs, const QWebSocketHandshakeOptions &rhs) - \brief Compares \a lhs for inequality with \a rhs. -*/ - QT_END_NAMESPACE |