summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLuca Di Sera <luca.disera@qt.io>2022-09-08 15:29:47 +0200
committerLuca Di Sera <luca.disera@qt.io>2022-09-08 16:10:47 +0200
commit0fb9178d3865bca4a56fe97b039b170644e81da2 (patch)
tree717a8497caf8f437068d61d12c133ae3d62749d8
parent9cfa2465fd1b5b0089eabd89f9eb52b92f284d5d (diff)
downloadqtwebsockets-0fb9178d3865bca4a56fe97b039b170644e81da2.tar.gz
Doc: Remove usages of the second argument of a "\page" command
The "\page" command for QDoc, used to construct a standalone documentation page in the output documentation of a project, was able to take a second argument, apart from the first argument representing the name for the generated documentation page, that roughly represented the type of the page that was to be generated. This second argument was not actually used by QDoc, such that it had no meaningful effect. QDoc was recently modified to not support this second argument, internally, and officially removed its use. For technical legacy reason, QDoc will still support the usage of a second argument for a "\page" command, albeit it will do nothing, as before. To avoid confusion for future readers who might not be aware of the history of the "\page" argument and that will not find an explanation in QDoc's documentation anymore, the usages of the second argument in "\page" commands are now removed. Change-Id: Ia41f57d5afd76b0c369f58b3f9c25854e55a33fc Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
-rw-r--r--src/websockets/qwebsocket.cpp2
-rw-r--r--src/websockets/qwebsocketserver.cpp2
2 files changed, 2 insertions, 2 deletions
diff --git a/src/websockets/qwebsocket.cpp b/src/websockets/qwebsocket.cpp
index 3d96907..93d07f4 100644
--- a/src/websockets/qwebsocket.cpp
+++ b/src/websockets/qwebsocket.cpp
@@ -40,7 +40,7 @@
*/
/*!
- \page echoclient.html example
+ \page echoclient.html
\title QWebSocket client example
\brief A sample WebSocket client that sends a message and displays the message that
it receives back.
diff --git a/src/websockets/qwebsocketserver.cpp b/src/websockets/qwebsocketserver.cpp
index 2b5e634..0c69d22 100644
--- a/src/websockets/qwebsocketserver.cpp
+++ b/src/websockets/qwebsocketserver.cpp
@@ -46,7 +46,7 @@
*/
/*!
- \page echoserver.html example
+ \page echoserver.html
\title WebSocket server example
\brief A sample WebSocket server echoing back messages sent to it.