From 62760f579b52fbd19d85d31fa90274f9b0dc5111 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Wed, 13 Aug 2014 14:14:49 +0200 Subject: 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 --- src/webchannel/qwebchannelabstracttransport.cpp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'src/webchannel/qwebchannelabstracttransport.cpp') 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} */ /*! -- cgit v1.2.1