Doc: Fix example documentation and paths

To fix issues related to example documentation and to follow Qt
convention, do the following changes:
    - Rename examples/qwebchannel to examples/webchannel
    - Move example-specific documentation to correct location(s)
    - Include generic 'Running the Example' instructions
    - Add the module name to example title, fix links

This ensures that example docs are built and the example manifest
file generated correctly.

Change-Id: I284e0b13db95a6738d72258735018b59156cc7da
Reviewed-by: Milian Wolff <milian.wolff@kdab.com>

1 files changed, 0 insertions, 108 deletions

diff --git a/examples/qwebchannel/standalone/websockettransport.cpp b/examples/qwebchannel/standalone/websockettransport.cpp
deleted file mode 100644
index 5714463..0000000
--- a/examples/qwebchannel/standalone/websockettransport.cpp
+++ /dev/null
@@ -1,108 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2014 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author Milian Wolff <milian.wolff@kdab.com>
-** Contact: http://www.qt-project.org/legal
-**
-** This file is part of the QtWebChannel module of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:LGPL$
-** Commercial License Usage
-** Licensees holding valid commercial Qt licenses may use this file in
-** accordance with the commercial license agreement provided with the
-** Software or, alternatively, in accordance with the terms contained in
-** a written agreement between you and Digia.  For licensing terms and
-** conditions see http://qt.digia.com/licensing.  For further information
-** use the contact form at http://qt.digia.com/contact-us.
-**
-** GNU Lesser General Public License Usage
-** Alternatively, this file may be used under the terms of the GNU Lesser
-** General Public License version 2.1 as published by the Free Software
-** Foundation and appearing in the file LICENSE.LGPL included in the
-** packaging of this file.  Please review the following information to
-** ensure the GNU Lesser General Public License version 2.1 requirements
-** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
-**
-** In addition, as a special exception, Digia gives you certain additional
-** rights.  These rights are described in the Digia Qt LGPL Exception
-** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
-**
-** GNU General Public License Usage
-** Alternatively, this file may be used under the terms of the GNU
-** General Public License version 3.0 as published by the Free Software
-** Foundation and appearing in the file LICENSE.GPL included in the
-** packaging of this file.  Please review the following information to
-** ensure the GNU General Public License version 3.0 requirements will be
-** met: http://www.gnu.org/copyleft/gpl.html.
-**
-**
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-#include "websockettransport.h"
-
-#include <QJsonDocument>
-#include <QJsonObject>
-#include <QDebug>
-
-#include <QtWebSockets/QWebSocket>
-
-/*!
-    \brief QWebChannelAbstractSocket implementation that uses a QWebSocket internally.
-
-    The transport delegates all messages received over the QWebSocket over its
-    textMessageReceived signal. Analogously, all calls to sendTextMessage will
-    be send over the QWebSocket to the remote client.
-*/
-
-QT_BEGIN_NAMESPACE
-
-/*!
-    Construct the transport object and wrap the given socket.
-
-    The socket is also set as the parent of the transport object.
-*/
-WebSocketTransport::WebSocketTransport(QWebSocket *socket)
-: QWebChannelAbstractTransport(socket)
-, m_socket(socket)
-{
-    connect(socket, &QWebSocket::textMessageReceived,
-            this, &WebSocketTransport::textMessageReceived);
-}
-
-/*!
-    Destroys the WebSocketTransport.
-*/
-WebSocketTransport::~WebSocketTransport()
-{
-
-}
-
-/*!
-    Serialize the JSON message and send it as a text message via the WebSocket to the client.
-*/
-void WebSocketTransport::sendMessage(const QJsonObject &message)
-{
-    QJsonDocument doc(message);
-    m_socket->sendTextMessage(QString::fromUtf8(doc.toJson(QJsonDocument::Compact)));
-}
-
-/*!
-    Deserialize the stringified JSON messageData and emit messageReceived.
-*/
-void WebSocketTransport::textMessageReceived(const QString &messageData)
-{
-    QJsonParseError error;
-    QJsonDocument message = QJsonDocument::fromJson(messageData.toUtf8(), &error);
-    if (error.error) {
-        qWarning() << "Failed to parse text message as JSON object:" << messageData
-                   << "Error is:" << error.errorString();
-        return;
-    } else if (!message.isObject()) {
-        qWarning() << "Received JSON message that is not an object: " << messageData;
-        return;
-    }
-    emit messageReceived(message.object(), this);
-}
-
-QT_END_NAMESPACE