Doc: Move IPC example documentation

Examples under examples/ipc were not part of any module
documentation. This change adds the above folder to
Qt Core documentation, and moves the corresponding
files so that the example documentation is built
correctly.

Change-Id: If1f34ce7ef04a02df8a87f820bb2e68ffa723dd4
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
bb10
Topi Reinio 2014-03-21 10:02:07 +01:00 committed by The Qt Project
parent ad22303bff
commit ddf2e2367c
8 changed files with 12 additions and 11 deletions

View File

Before

Width:  |  Height:  |  Size: 8.2 KiB

After

Width:  |  Height:  |  Size: 8.2 KiB

View File

Before

Width:  |  Height:  |  Size: 5.6 KiB

After

Width:  |  Height:  |  Size: 5.6 KiB

View File

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

View File

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

View File

@ -26,14 +26,14 @@
****************************************************************************/
/*!
\example ipc/localfortuneclient
\example localfortuneclient
\title Local Fortune Client Example
\ingroup examples-ipc
\brief Demonstrates using QLocalSocket for a simple local service client.
The Local Fortune Client example shows how to create a client for a simple
local service using QLocalSocket. It is intended to be run alongside the
\l{ipc/localfortuneserver}{Local Fortune Server} example.
\l{Local Fortune Server Example}.
\image localfortuneclient-example.png Screenshot of the Local Fortune Client example

View File

@ -26,14 +26,14 @@
****************************************************************************/
/*!
\example ipc/localfortuneserver
\example localfortuneserver
\title Local Fortune Server Example
\ingroup examples-ipc
\brief Demonstrates using QLocalServer and QLocalSocket for serving a simple local service.
The Local Fortune Server example shows how to create a server for a simple
local service. It is intended to be run alongside the
\l{ipc/localfortuneclient}{Local Fortune Client} example
\l{Local Fortune Client Example}
\image localfortuneserver-example.png Screenshot of the Local Fortune Server example
*/

View File

@ -26,7 +26,7 @@
****************************************************************************/
/*!
\example ipc/sharedmemory
\example sharedmemory
\title Shared Memory Example
\ingroup examples-ipc
\brief Demonstrates doing inter-process communication using shared memory with
@ -40,7 +40,7 @@
dialog is displayed and then control is passed to the application in
the standard way.
\snippet examples/ipc/sharedmemory/main.cpp 0
\snippet sharedmemory/main.cpp 0
Two instances of class Dialog appear.
@ -51,12 +51,12 @@
loadFromFile() and loadFromMemory() that correspond to the two
buttons on the dialog.
\snippet examples/ipc/sharedmemory/dialog.h 0
\snippet sharedmemory/dialog.h 0
The constructor builds the user interface widgets and connects the
clicked() signal of each button to the corresponding slot function.
\snippet examples/ipc/sharedmemory/dialog.cpp 0
\snippet sharedmemory/dialog.cpp 0
Note that "QSharedMemoryExample" is passed to the \l {QSharedMemory}
{QSharedMemory()} constructor to be used as the key. This will be
@ -69,7 +69,7 @@
that segment is detached from the process, so we can be assured of
starting off the example correctly.
\snippet examples/ipc/sharedmemory/dialog.cpp 1
\snippet sharedmemory/dialog.cpp 1
The user is then asked to select an image file using
QFileDialog::getOpenFileName(). The selected file is loaded into a
@ -85,7 +85,7 @@
to the image data, which we then use to do a memcopy() from the
QBuffer into the shared memory segment.
\snippet examples/ipc/sharedmemory/dialog.cpp 2
\snippet sharedmemory/dialog.cpp 2
Note that we \l {QSharedMemory::} {lock()} the shared memory segment
before we copy into it, and we \l {QSharedMemory::} {unlock()} it
@ -117,7 +117,7 @@
then streams the data into a QImage and \l {QSharedMemory::unlock()}
{unlocks} the segment.
\snippet examples/ipc/sharedmemory/dialog.cpp 3
\snippet sharedmemory/dialog.cpp 3
In this case, the function does \l {QSharedMemory::} {detach()} from
the segment, because now we are effectively finished using

View File

@ -37,6 +37,7 @@ exampledirs += \
snippets \
../../../examples/threads/ \
../../../examples/tools/ \
../../../examples/ipc/ \
../../../examples/json/ \
../../../examples/network/dnslookup