summaryrefslogtreecommitdiffstats
path: root/examples/ipc/doc/src/localfortuneclient.qdoc
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2014-03-21 10:02:07 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-03-27 15:16:20 +0100
commitddf2e2367ccf651fc25f02a3e7975a8b57a4bc98 (patch)
treeb151d5638a9a80717482428eae3e5cde97224674 /examples/ipc/doc/src/localfortuneclient.qdoc
parentad22303bff0dac7accc748e284bd1ffbf6b24cb3 (diff)
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>
Diffstat (limited to 'examples/ipc/doc/src/localfortuneclient.qdoc')
-rw-r--r--examples/ipc/doc/src/localfortuneclient.qdoc40
1 files changed, 40 insertions, 0 deletions
diff --git a/examples/ipc/doc/src/localfortuneclient.qdoc b/examples/ipc/doc/src/localfortuneclient.qdoc
new file mode 100644
index 0000000000..a68f4bad0c
--- /dev/null
+++ b/examples/ipc/doc/src/localfortuneclient.qdoc
@@ -0,0 +1,40 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** 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 Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \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{Local Fortune Server Example}.
+
+ \image localfortuneclient-example.png Screenshot of the Local Fortune Client example
+
+*/