Adapted documentaton

Change-Id: I6ffcc86b9bbc6efe27b7005a3df6f62f0d1a9293
Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>

6 files changed, 17 insertions, 21 deletions

diff --git a/src/websockets/qwebsocket.cpp b/src/websockets/qwebsocket.cpp
index c797ed1..6c7f0b1 100644
--- a/src/websockets/qwebsocket.cpp
+++ b/src/websockets/qwebsocket.cpp
@@ -20,7 +20,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 /*!
     \class QWebSocket
 
-    \inmodule QWebSockets
+    \inmodule QtWebSockets
     \brief Implements a TCP socket that talks the websocket protocol.
 
     WebSockets is a web technology providing full-duplex communications channels over a single TCP connection.
diff --git a/src/websockets/qwebsocketcorsauthenticator.cpp b/src/websockets/qwebsocketcorsauthenticator.cpp
index b6e7266..7d59a3c 100644
--- a/src/websockets/qwebsocketcorsauthenticator.cpp
+++ b/src/websockets/qwebsocketcorsauthenticator.cpp
@@ -18,17 +18,17 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
 /*!
-    \class QCorsAuthenticator
+    \class QWebSocketCorsAuthenticator
 
-    \inmodule QWebSockets
-    \brief The QCorsAuthenticator class provides an authenticator object for Cross Origin Requests (CORS).
+    \inmodule QtWebSockets
+    \brief The QWebSocketCorsAuthenticator class provides an authenticator object for Cross Origin Requests (CORS).
 
-    The QCorsAuthenticator class is used in the \l{QWebSocketServer::}{originAuthenticationRequired()} signal.
+    The QWebSocketCorsAuthenticator class is used in the \l{QWebSocketServer::}{originAuthenticationRequired()} signal.
     The class provides a way to pass back the required information to the QWebSocketServer.
     It provides applications with fine-grained control over which origin URLs are allowed and which aren't.
     By default, every origin is accepted.
     To get fine grained control, an application connects the \l{QWebSocketServer::}{originAuthenticationRequired()} signal to
-    a slot. When the origin (QCorsAuthenticator::origin()) is accepted, it calls QCorsAuthenticator::setAllowed(true)
+    a slot. When the origin (QWebSocketCorsAuthenticator::origin()) is accepted, it calls QWebSocketCorsAuthenticator::setAllowed(true)
 
     \note Checking on the origin does not make much sense when the server is accessed
     via a non-browser client, as that client can set whatever origin header it likes.
diff --git a/src/websockets/qwebsocketdataprocessor_p.cpp b/src/websockets/qwebsocketdataprocessor_p.cpp
index f3afdee..2b75f5b 100644
--- a/src/websockets/qwebsocketdataprocessor_p.cpp
+++ b/src/websockets/qwebsocketdataprocessor_p.cpp
@@ -17,13 +17,13 @@ License along with this library; if not, write to the Free Software
 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
 /*!
-    \class DataProcessor
-    The class DataProcessor is responsible for reading, validating and interpreting data from a websocket.
+    \class QWebSocketDataProcessor
+    The class QWebSocketDataProcessor is responsible for reading, validating and interpreting data from a websocket.
     It reads data from a QIODevice, validates it against RFC 6455, and parses it into frames (data, control).
     It emits signals that correspond to the type of the frame: textFrameReceived(), binaryFrameReceived(),
     textMessageReceived(), binaryMessageReceived(), pingReceived(), pongReceived() and closeReceived().
     Whenever an error is detected, the errorEncountered() signal is emitted.
-    DataProcessor also checks if a frame is allowed in a sequence of frames (e.g. a continuation frame cannot follow a final frame).
+    QWebSocketDataProcessor also checks if a frame is allowed in a sequence of frames (e.g. a continuation frame cannot follow a final frame).
     This class is an internal class used by QWebSocketInternal for data processing and validation.
 
     \sa Frame()
diff --git a/src/websockets/qwebsocketdataprocessor_p.h b/src/websockets/qwebsocketdataprocessor_p.h
index 4ad4fa6..117a6cf 100644
--- a/src/websockets/qwebsocketdataprocessor_p.h
+++ b/src/websockets/qwebsocketdataprocessor_p.h
@@ -42,10 +42,6 @@ QT_BEGIN_NAMESPACE
 class QIODevice;
 class QWebSocketFrame;
 
-/*!
-    \internal
-    The DataProcessor class reads and interprets incoming websocket messages, and emits appropriate signals.
- */
 class Q_AUTOTEST_EXPORT QWebSocketDataProcessor : public QObject
 {
     Q_OBJECT
diff --git a/src/websockets/qwebsocketprotocol.cpp b/src/websockets/qwebsocketprotocol.cpp
index 6bd3ec4..e6a9db0 100644
--- a/src/websockets/qwebsocketprotocol.cpp
+++ b/src/websockets/qwebsocketprotocol.cpp
@@ -23,7 +23,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 #include <QtEndian>
 
 /*!
-    \enum WebSocketProtocol::CloseCode
+    \enum QWebSocketProtocol::CloseCode
 
     The close codes supported by WebSockets V13
 
@@ -44,7 +44,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
     \sa \l{QWebSocket::} {close()}
 */
 /*!
-    \enum WebSocketProtocol::Version
+    \enum QWebSocketProtocol::Version
 
     \brief The different defined versions of the Websocket protocol.
 
@@ -79,19 +79,19 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
 /*!
-  \fn WebSocketProtocol::isOpCodeReserved(OpCode code)
+  \fn QWebSocketProtocol::isOpCodeReserved(OpCode code)
   Checks if \a code is a valid OpCode
   \internal
 */
 
 /*!
-  \fn WebSocketProtocol::isCloseCodeValid(int closeCode)
+  \fn QWebSocketProtocol::isCloseCodeValid(int closeCode)
   Checks if \a closeCode is a valid web socket close code
   \internal
 */
 
 /*!
-  \fn WebSocketProtocol::getCurrentVersion()
+  \fn QWebSocketProtocol::currentVersion()
   Returns the latest version that WebSocket is supporting
   \internal
 */
diff --git a/src/websockets/qwebsocketserver.cpp b/src/websockets/qwebsocketserver.cpp
index 03c0ec2..1ea0f99 100644
--- a/src/websockets/qwebsocketserver.cpp
+++ b/src/websockets/qwebsocketserver.cpp
@@ -20,7 +20,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 /*!
     \class QWebSocketServer
 
-    \inmodule QWebSockets
+    \inmodule QtWebSockets
 
     \brief Implements a websocket-based server.
 
@@ -88,10 +88,10 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
 /*!
-    \fn void QWebSocketServer::originAuthenticationRequired(QCorsAuthenticator *authenticator)
+    \fn void QWebSocketServer::originAuthenticationRequired(QWebSocketCorsAuthenticator *authenticator)
     This signal is emitted when a new connection is requested.
     The slot connected to this signal should indicate whether the origin (which can be determined by the origin() call)
-    is allowed in the \a authenticator object (by issuing \l{QCorsAuthenticator::}{setAllowed()})
+    is allowed in the \a authenticator object (by issuing \l{QWebSocketCorsAuthenticator::}{setAllowed()})
 
     If no slot is connected to this signal, all origins will be accepted by default.