diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2021-09-08 10:50:23 +0200 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@qt.io> | 2021-09-08 12:56:09 +0000 |
| commit | 742ba2c5172a306a2c584da90ba7f7aa9c0c1317 (patch) | |
| tree | 95041fab1e2dcea60e434a11fcd6bced2559e8b3 | |
| parent | c2bea6210637c0ba5cc4123dc4c4fc42a5286745 (diff) | |
Doc: Fix documentation warnings
* Rename a file included by QDoc to have the correct extension
* Add missing \a command to mark a function argument
Pick-to: 6.2
Fixes: QTBUG-96287
Change-Id: I9724b67f641ba634c91a74e3e05821f1edfeb4ad
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
| -rw-r--r-- | src/websockets/doc/src/index.qdoc | 2 | ||||
| -rw-r--r-- | src/websockets/qwebsocketserver.cpp | 2 | ||||
| -rw-r--r-- | tests/doc/README.qdocinc (renamed from tests/doc/README) | 0 |
3 files changed, 2 insertions, 2 deletions
diff --git a/src/websockets/doc/src/index.qdoc b/src/websockets/doc/src/index.qdoc index 81a2cb4..9bd5e30 100644 --- a/src/websockets/doc/src/index.qdoc +++ b/src/websockets/doc/src/index.qdoc @@ -98,5 +98,5 @@ \l {Autobahn|Testsuite installation documentation} to set up the test suite. - \include README testsuite + \include README.qdocinc testsuite */ diff --git a/src/websockets/qwebsocketserver.cpp b/src/websockets/qwebsocketserver.cpp index 989812f..5cbdbec 100644 --- a/src/websockets/qwebsocketserver.cpp +++ b/src/websockets/qwebsocketserver.cpp @@ -253,7 +253,7 @@ \fn void QWebSocketServer::handshakeInterruptedOnError(const QSslError &error) \since 6.2 - QWebSocketServer emits this signal if a certificate verification error was + QWebSocketServer emits this signal if a certificate verification \a error was found and if early error reporting was enabled in QSslConfiguration. \sa sslErrors(), QSslConfiguration::setHandshakeMustInterruptOnError() diff --git a/tests/doc/README b/tests/doc/README.qdocinc index da9b2b5..da9b2b5 100644 --- a/tests/doc/README +++ b/tests/doc/README.qdocinc |