From 8d811c04dc52ea60a0be0eec9211d74f3519d56b Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Wed, 8 Sep 2021 10:50:23 +0200 Subject: Doc: Fix documentation warnings * Rename a file included by QDoc to have the correct extension * Add missing \a command to mark a function argument Fixes: QTBUG-96287 Change-Id: I9724b67f641ba634c91a74e3e05821f1edfeb4ad Reviewed-by: Venugopal Shivashankar (cherry picked from commit 742ba2c5172a306a2c584da90ba7f7aa9c0c1317) Reviewed-by: Qt Cherry-pick Bot --- tests/doc/README | 58 ------------------------------------------------ tests/doc/README.qdocinc | 58 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 58 insertions(+), 58 deletions(-) delete mode 100644 tests/doc/README create mode 100644 tests/doc/README.qdocinc (limited to 'tests') diff --git a/tests/doc/README b/tests/doc/README deleted file mode 100644 index da9b2b5..0000000 --- a/tests/doc/README +++ /dev/null @@ -1,58 +0,0 @@ -This directory contains autotests and manual tests for the Qt WebSockets -module. - -In addition, Autobahn|Testsuite, a standard test suite for WebSocket -Protocol (RFC 6455), can be used for testing the conformance of Qt -WebSockets. - -http://autobahn.ws/testsuite/ - -Refer to Autobahn|Testsuite installation documentation at -http://autobahn.ws/testsuite/installation.html - -//! [testsuite] -\section1 Testing Qt WebSockets with Autobahn|Testsuite - - -\section2 wstest - fuzzingserver mode - -\code - cd your_build_dir/tests/manual/compliance - qmake your_src_dir/tests/manual/compliance/compliance.pro - make - - cd ~ - wstest -m fuzzingserver -\endcode - -Then, in another terminal: - -\code - cd your_build_dir/tests/manual/compliance - ./tst_compliance -\endcode - -Test results will be generated under ~/reports/clients directory. -Point your browser to ~/reports/clients/index.html. - - -\section2 wstest - fuzzingclient mode - -\code - cd your_build_dir/examples/websockets/echoserver - qmake your_src_dir/examples/websockets/echoserver/echoserver.pro - make - - ./echoserver -p 9001 -\endcode - -Then, in another terminal: - -\code - cd ~ - wstest -m fuzzingclient -\endcode - -Test results will be generated under ~/reports/servers directory. -Point your browser to ~/reports/servers/index.html. -//! [testsuite] diff --git a/tests/doc/README.qdocinc b/tests/doc/README.qdocinc new file mode 100644 index 0000000..da9b2b5 --- /dev/null +++ b/tests/doc/README.qdocinc @@ -0,0 +1,58 @@ +This directory contains autotests and manual tests for the Qt WebSockets +module. + +In addition, Autobahn|Testsuite, a standard test suite for WebSocket +Protocol (RFC 6455), can be used for testing the conformance of Qt +WebSockets. + +http://autobahn.ws/testsuite/ + +Refer to Autobahn|Testsuite installation documentation at +http://autobahn.ws/testsuite/installation.html + +//! [testsuite] +\section1 Testing Qt WebSockets with Autobahn|Testsuite + + +\section2 wstest - fuzzingserver mode + +\code + cd your_build_dir/tests/manual/compliance + qmake your_src_dir/tests/manual/compliance/compliance.pro + make + + cd ~ + wstest -m fuzzingserver +\endcode + +Then, in another terminal: + +\code + cd your_build_dir/tests/manual/compliance + ./tst_compliance +\endcode + +Test results will be generated under ~/reports/clients directory. +Point your browser to ~/reports/clients/index.html. + + +\section2 wstest - fuzzingclient mode + +\code + cd your_build_dir/examples/websockets/echoserver + qmake your_src_dir/examples/websockets/echoserver/echoserver.pro + make + + ./echoserver -p 9001 +\endcode + +Then, in another terminal: + +\code + cd ~ + wstest -m fuzzingclient +\endcode + +Test results will be generated under ~/reports/servers directory. +Point your browser to ~/reports/servers/index.html. +//! [testsuite] -- cgit v1.2.1