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/webchannel/qwebchannelabstracttransport.cpp | |
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/webchannel/qwebchannelabstracttransport.cpp')
-rw-r--r-- | src/webchannel/qwebchannelabstracttransport.cpp | 8 |
1 files changed, 4 insertions, 4 deletions
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} */ /*! |