summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorLiang Qi <liang.qi@theqtcompany.com>2015-02-17 10:57:02 +0100
committerTopi Reiniƶ <topi.reinio@digia.com>2015-06-03 07:12:49 +0000
commit150db98da8695f74601b1776742e8284602207fe (patch)
tree66636cf0934c653776d5db3bd65c5a2eb4cbe481 /src
parent5edfb3c7ee338c0b562f33a8c4315454bfc18886 (diff)
downloadqtwebsockets-150db98da8695f74601b1776742e8284602207fe.tar.gz
Doc: Add documentation on how to test with Autobahn|Testsuite
Change-Id: Ia18acdc3c54e2bb48209406d2a6f9e156b67324c Reviewed-by: Liang Qi <liang.qi@theqtcompany.com> Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Diffstat (limited to 'src')
-rw-r--r--src/websockets/doc/qtwebsockets.qdocconf3
-rw-r--r--src/websockets/doc/src/index.qdoc20
2 files changed, 21 insertions, 2 deletions
diff --git a/src/websockets/doc/qtwebsockets.qdocconf b/src/websockets/doc/qtwebsockets.qdocconf
index 2e1e15b..8ce18ec 100644
--- a/src/websockets/doc/qtwebsockets.qdocconf
+++ b/src/websockets/doc/qtwebsockets.qdocconf
@@ -44,7 +44,8 @@ headerdirs += .. \
sourcedirs += .. \
src \
- ../../imports
+ ../../imports \
+ ../../../tests/doc
exampledirs += ../../../examples/websockets \
diff --git a/src/websockets/doc/src/index.qdoc b/src/websockets/doc/src/index.qdoc
index 0d28036..344a859 100644
--- a/src/websockets/doc/src/index.qdoc
+++ b/src/websockets/doc/src/index.qdoc
@@ -57,7 +57,7 @@
QT += websockets
\endcode
- \section1 Reference documentation
+ \section1 Reference Documentation
\list
\li \l{Qt WebSockets C++ Classes}{C++ Classes}
\li \l{Qt WebSockets QML Types}{QML Types}
@@ -67,4 +67,22 @@
The module provides the following \l{Qt WebSockets Examples}{Examples} as a guide to using
the API.
+
+ \section1 Conformance
+ \list
+ \li \l {Testing Qt WebSockets}
+ \endlist
+*/
+
+/*!
+ \page qtwebsockets-testing.html
+ \title Testing Qt WebSockets
+
+ \l {http://autobahn.ws/testsuite/}{Autobahn|Testsuite}, a standard test
+ suite for WebSocket Protocol (RFC 6455), can be used for testing the
+ conformance of Qt WebSockets. Refer to Autobahn|Testsuite
+ \l {http://autobahn.ws/testsuite/installation.html}{installation documentation}
+ to set up the test suite.
+
+ \include README testsuite
*/