diff options
author | Topi Reinio <topi.reinio@digia.com> | 2014-08-13 14:14:49 +0200 |
---|---|---|
committer | Milian Wolff <milian.wolff@kdab.com> | 2014-08-13 14:43:24 +0200 |
commit | 62760f579b52fbd19d85d31fa90274f9b0dc5111 (patch) | |
tree | cb348241c606632ad9dbc575e28910e9302a2cc5 /src | |
parent | 150fba9166d0cd63079d8ed15af5f80a759e9549 (diff) | |
download | qtwebchannel-62760f579b52fbd19d85d31fa90274f9b0dc5111.tar.gz |
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>
Diffstat (limited to 'src')
-rw-r--r-- | src/webchannel/doc/src/examples.qdoc | 49 | ||||
-rw-r--r-- | src/webchannel/doc/src/javascript.qdoc | 3 | ||||
-rw-r--r-- | src/webchannel/qwebchannel.cpp | 2 | ||||
-rw-r--r-- | src/webchannel/qwebchannelabstracttransport.cpp | 8 |
4 files changed, 56 insertions, 6 deletions
diff --git a/src/webchannel/doc/src/examples.qdoc b/src/webchannel/doc/src/examples.qdoc new file mode 100644 index 0000000..613d760 --- /dev/null +++ b/src/webchannel/doc/src/examples.qdoc @@ -0,0 +1,49 @@ +/**************************************************************************** +** +** 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$ +** +****************************************************************************/ + +/*! + \title Qt WebChannel Examples + \group qtwebchannel-examples + \brief List of Qt WebChannel examples. + + The examples show how to use the QWebChannel C++ and WebChannel QML API. + +*/ diff --git a/src/webchannel/doc/src/javascript.qdoc b/src/webchannel/doc/src/javascript.qdoc index de211d0..fa8edfe 100644 --- a/src/webchannel/doc/src/javascript.qdoc +++ b/src/webchannel/doc/src/javascript.qdoc @@ -49,7 +49,8 @@ Note that the JavaScript QWebChannel object should be constructed once the transport object is fully operational. In case of a WebSocket, that means you should create the QWebChannel in the - socket's \c onopen handler. Take a look at the \l{Standalone Example} to see how this is done. + socket's \c onopen handler. Take a look at the \l{Qt WebChannel Standalone Example} to see how + this is done. \section1 Interacting with QObjects diff --git a/src/webchannel/qwebchannel.cpp b/src/webchannel/qwebchannel.cpp index 99becfb..e3df0b9 100644 --- a/src/webchannel/qwebchannel.cpp +++ b/src/webchannel/qwebchannel.cpp @@ -73,7 +73,7 @@ QT_BEGIN_NAMESPACE There also exists a declarative WebChannel API. - \sa {Standalone Example} + \sa {Qt WebChannel Standalone Example} */ /*! diff --git a/src/webchannel/qwebchannelabstracttransport.cpp b/src/webchannel/qwebchannelabstracttransport.cpp index f261698..0bfdbb6 100644 --- a/src/webchannel/qwebchannelabstracttransport.cpp +++ b/src/webchannel/qwebchannelabstracttransport.cpp @@ -52,13 +52,13 @@ QT_BEGIN_NAMESPACE Users of the QWebChannel must implement this interface and connect instances of it to the QWebChannel server for every client that should be connected to the QWebChannel. - The {Standalone Example} shows how this can be done using Qt WebSockets. Qt WebKit implements - this interface internally and uses the native WebKit IPC mechanism to transmit messages - to HTML clients. + The {Qt WebChannel Standalone Example}{Standalone Example} shows how this can be done + using Qt WebSockets. Qt WebKit implements this interface internally and uses the native + WebKit IPC mechanism to transmit messages to HTML clients. \note The JSON message protocol is considered internal and might change over time. - \sa {Standalone Example} + \sa {Qt WebChannel Standalone Example} */ /*! |