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 | |
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>
-rw-r--r-- | examples/examples.pro | 2 | ||||
-rw-r--r-- | examples/webchannel/exampleassets.pri (renamed from examples/qwebchannel/exampleassets.pri) | 0 | ||||
-rw-r--r-- | examples/webchannel/nodejs/README (renamed from examples/qwebchannel/nodejs/README) | 0 | ||||
-rw-r--r-- | examples/webchannel/nodejs/chatclient.js (renamed from examples/qwebchannel/nodejs/chatclient.js) | 0 | ||||
-rw-r--r-- | examples/webchannel/nodejs/nodejs.pro (renamed from examples/qwebchannel/nodejs/nodejs.pro) | 0 | ||||
-rw-r--r-- | examples/webchannel/nodejs/package.json (renamed from examples/qwebchannel/nodejs/package.json) | 0 | ||||
-rw-r--r-- | examples/webchannel/standalone/dialog.ui (renamed from examples/qwebchannel/standalone/dialog.ui) | 0 | ||||
-rw-r--r-- | examples/webchannel/standalone/doc/images/standalone-screenshot.png (renamed from examples/qwebchannel/doc/standalone-screenshot.png) | bin | 30363 -> 30363 bytes | |||
-rw-r--r-- | examples/webchannel/standalone/doc/src/standalone.qdoc (renamed from examples/qwebchannel/doc/standalone.qdoc) | 10 | ||||
-rw-r--r-- | examples/webchannel/standalone/index.html (renamed from examples/qwebchannel/standalone/index.html) | 0 | ||||
-rw-r--r-- | examples/webchannel/standalone/main.cpp (renamed from examples/qwebchannel/standalone/main.cpp) | 0 | ||||
-rw-r--r-- | examples/webchannel/standalone/standalone.pro (renamed from examples/qwebchannel/standalone/standalone.pro) | 0 | ||||
-rw-r--r-- | examples/webchannel/standalone/websocketclientwrapper.cpp (renamed from examples/qwebchannel/standalone/websocketclientwrapper.cpp) | 0 | ||||
-rw-r--r-- | examples/webchannel/standalone/websocketclientwrapper.h (renamed from examples/qwebchannel/standalone/websocketclientwrapper.h) | 0 | ||||
-rw-r--r-- | examples/webchannel/standalone/websockettransport.cpp (renamed from examples/qwebchannel/standalone/websockettransport.cpp) | 0 | ||||
-rw-r--r-- | examples/webchannel/standalone/websockettransport.h (renamed from examples/qwebchannel/standalone/websockettransport.h) | 0 | ||||
-rw-r--r-- | examples/webchannel/webchannel.pro (renamed from examples/qwebchannel/qwebchannel.pro) | 0 | ||||
-rw-r--r-- | src/webchannel/doc/src/examples.qdoc (renamed from examples/qwebchannel/doc/examples.qdoc) | 0 | ||||
-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 |
21 files changed, 15 insertions, 10 deletions
diff --git a/examples/examples.pro b/examples/examples.pro index 1cb6c9f..657e144 100644 --- a/examples/examples.pro +++ b/examples/examples.pro @@ -1,3 +1,3 @@ TEMPLATE = subdirs -SUBDIRS += qwebchannel +SUBDIRS += webchannel diff --git a/examples/qwebchannel/exampleassets.pri b/examples/webchannel/exampleassets.pri index 035ca12..035ca12 100644 --- a/examples/qwebchannel/exampleassets.pri +++ b/examples/webchannel/exampleassets.pri diff --git a/examples/qwebchannel/nodejs/README b/examples/webchannel/nodejs/README index 07f8fd8..07f8fd8 100644 --- a/examples/qwebchannel/nodejs/README +++ b/examples/webchannel/nodejs/README diff --git a/examples/qwebchannel/nodejs/chatclient.js b/examples/webchannel/nodejs/chatclient.js index 03ce214..03ce214 100644 --- a/examples/qwebchannel/nodejs/chatclient.js +++ b/examples/webchannel/nodejs/chatclient.js diff --git a/examples/qwebchannel/nodejs/nodejs.pro b/examples/webchannel/nodejs/nodejs.pro index 4df94d2..4df94d2 100644 --- a/examples/qwebchannel/nodejs/nodejs.pro +++ b/examples/webchannel/nodejs/nodejs.pro diff --git a/examples/qwebchannel/nodejs/package.json b/examples/webchannel/nodejs/package.json index 2d863cc..2d863cc 100644 --- a/examples/qwebchannel/nodejs/package.json +++ b/examples/webchannel/nodejs/package.json diff --git a/examples/qwebchannel/standalone/dialog.ui b/examples/webchannel/standalone/dialog.ui index 056a3f5..056a3f5 100644 --- a/examples/qwebchannel/standalone/dialog.ui +++ b/examples/webchannel/standalone/dialog.ui diff --git a/examples/qwebchannel/doc/standalone-screenshot.png b/examples/webchannel/standalone/doc/images/standalone-screenshot.png Binary files differindex 3c55e19..3c55e19 100644 --- a/examples/qwebchannel/doc/standalone-screenshot.png +++ b/examples/webchannel/standalone/doc/images/standalone-screenshot.png diff --git a/examples/qwebchannel/doc/standalone.qdoc b/examples/webchannel/standalone/doc/src/standalone.qdoc index 1d81dad..46c09c3 100644 --- a/examples/qwebchannel/doc/standalone.qdoc +++ b/examples/webchannel/standalone/doc/src/standalone.qdoc @@ -41,7 +41,7 @@ /*! \example standalone - \title Standalone Example + \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. @@ -49,11 +49,15 @@ The standalone example is a simple chat between a pure C++/Qt application and a remote HTML client running in your default browser. - The C++ app sets up a QWebChannel and publishes a Dialog object over it. + \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 sents a message. The signal + 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. diff --git a/examples/qwebchannel/standalone/index.html b/examples/webchannel/standalone/index.html index 778a502..778a502 100644 --- a/examples/qwebchannel/standalone/index.html +++ b/examples/webchannel/standalone/index.html diff --git a/examples/qwebchannel/standalone/main.cpp b/examples/webchannel/standalone/main.cpp index 2cbc6b8..2cbc6b8 100644 --- a/examples/qwebchannel/standalone/main.cpp +++ b/examples/webchannel/standalone/main.cpp diff --git a/examples/qwebchannel/standalone/standalone.pro b/examples/webchannel/standalone/standalone.pro index fdeb87a..fdeb87a 100644 --- a/examples/qwebchannel/standalone/standalone.pro +++ b/examples/webchannel/standalone/standalone.pro diff --git a/examples/qwebchannel/standalone/websocketclientwrapper.cpp b/examples/webchannel/standalone/websocketclientwrapper.cpp index 0e776e1..0e776e1 100644 --- a/examples/qwebchannel/standalone/websocketclientwrapper.cpp +++ b/examples/webchannel/standalone/websocketclientwrapper.cpp diff --git a/examples/qwebchannel/standalone/websocketclientwrapper.h b/examples/webchannel/standalone/websocketclientwrapper.h index 1f742f7..1f742f7 100644 --- a/examples/qwebchannel/standalone/websocketclientwrapper.h +++ b/examples/webchannel/standalone/websocketclientwrapper.h diff --git a/examples/qwebchannel/standalone/websockettransport.cpp b/examples/webchannel/standalone/websockettransport.cpp index 5714463..5714463 100644 --- a/examples/qwebchannel/standalone/websockettransport.cpp +++ b/examples/webchannel/standalone/websockettransport.cpp diff --git a/examples/qwebchannel/standalone/websockettransport.h b/examples/webchannel/standalone/websockettransport.h index 828ac00..828ac00 100644 --- a/examples/qwebchannel/standalone/websockettransport.h +++ b/examples/webchannel/standalone/websockettransport.h diff --git a/examples/qwebchannel/qwebchannel.pro b/examples/webchannel/webchannel.pro index de6b4b8..de6b4b8 100644 --- a/examples/qwebchannel/qwebchannel.pro +++ b/examples/webchannel/webchannel.pro diff --git a/examples/qwebchannel/doc/examples.qdoc b/src/webchannel/doc/src/examples.qdoc index 613d760..613d760 100644 --- a/examples/qwebchannel/doc/examples.qdoc +++ b/src/webchannel/doc/src/examples.qdoc 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} */ /*! |