Doc: Review documentation Qt WebSockets
[contrib/qtwebsockets.git] / src / websockets / doc / src / index.qdoc
index 2f4812f..2961ef3 100644 (file)
 
 /*!
     \page qtwebsockets-index.html
-    \since 5.2
+    \since 5.3
     \title Qt WebSockets
     \brief Provides an implementation of the WebSocket protocol.
 
-    The QtWebSockets module implements the WebSocket protocol as specified in \l {http://tools.ietf.org/html/rfc6455} {RFC 6455}.
+    The QtWebSockets module implements the WebSocket protocol as specified in
+    \l {http://tools.ietf.org/html/rfc6455} {RFC 6455}.
     It solely depends on Qt (no external dependencies).
 
 
     QT += websockets
     \endcode
 
-    \section1 Related information
+    \section1 Reference documentation
     \list
     \li \l{Qt WebSockets C++ Classes}{C++ Classes}
     \li \l{Qt WebSockets QML Types}{QML Types}
-    \li \l{Qt WebSockets Examples}{Examples}
     \endlist
+
+    \section1 Examples
+
+    The module provides the following examples as a guide to using
+    the API.
+    \l{Qt WebSockets Examples}{Examples}
 */