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, 68 insertions, 0 deletions

diff --git a/examples/webchannel/standalone/doc/src/standalone.qdoc b/examples/webchannel/standalone/doc/src/standalone.qdoc
new file mode 100644
index 0000000..46c09c3
--- /dev/null
+++ b/examples/webchannel/standalone/doc/src/standalone.qdoc
@@ -0,0 +1,68 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+/*!
+    \example standalone
+    \title Qt WebChannel Standalone Example
+    \ingroup qtwebchannel-examples
+    \image standalone-screenshot.png
+    \brief Shows how to use the QWebChannel C++ API to communicate with an external client.
+
+    The standalone example is a simple chat between a pure C++/Qt application and a remote HTML
+    client running in your default browser.
+
+    \include examples-run.qdocinc
+
+    \section1 Overview
+
+    The C++ application sets up a QWebChannel instance and publishes a Dialog object over it.
+    For the remote client side, \c index.html is opened. Both show a dialog with the list of
+    received messages and an input box to send messages to the other end.
+
+    The Dialog emits the Dialog::sendText() signal when the user sends a message. The signal
+    automatically gets propagated to the HTML client. When the user enters a message on the HTML
+    side, Dialog::receiveText() is called.
+
+    All communication between the HTML client and the C++/Qt server is done over a WebSocket.
+    The C++ side instantiates a QWebSocketServer and wraps incoming QWebSocket connections
+    in WebSocketTransport objects, which implement QWebChannelAbstractTransport. These objects are
+    then connected to the QWebChannel instance.
+*/