summaryrefslogtreecommitdiffstats
path: root/src/network/doc
diff options
context:
space:
mode:
authorEskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com>2012-12-04 14:06:35 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2012-12-04 14:40:38 +0100
commit0f8b7deef1e6d2b0d24f83c12c3ce11ed0fc0640 (patch)
tree4fa17e7d53de4b590378d83ae6d41088a8966e42 /src/network/doc
parent4873c4151e895f9a1e4c6c90fa86594f43147298 (diff)
Move Network Examples from qtdoc to qtbase
Move the main example overview and use the \group tag convention to make the list update automatically. Change-Id: Ib2cc8cf7def9a7f3dce6b7ed6d4958771cbdf5cd Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
Diffstat (limited to 'src/network/doc')
-rw-r--r--src/network/doc/images/network-examples.pngbin0 -> 8946 bytes
-rw-r--r--src/network/doc/src/examples.qdoc68
2 files changed, 68 insertions, 0 deletions
diff --git a/src/network/doc/images/network-examples.png b/src/network/doc/images/network-examples.png
new file mode 100644
index 0000000000..15dfba850a
--- /dev/null
+++ b/src/network/doc/images/network-examples.png
Binary files differ
diff --git a/src/network/doc/src/examples.qdoc b/src/network/doc/src/examples.qdoc
new file mode 100644
index 0000000000..1d3b83ae80
--- /dev/null
+++ b/src/network/doc/src/examples.qdoc
@@ -0,0 +1,68 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 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$
+**
+****************************************************************************/
+
+/*!
+ \group examples-network
+ \ingroup all-examples
+ \title Network Examples
+ \brief How to do network programming in Qt.
+
+ \image network-examples.png
+
+ Qt is provided with an extensive set of network classes to support both
+ client-based and server side network programming.
+
+ These examples demonstrate the fundamental aspects of network programming
+ with Qt.
+
+*/
+
+/*
+ \list
+ \li \l{network/blockingfortuneclient}{Blocking Fortune Client}\raisedaster
+ \li \l{network/broadcastreceiver}{Broadcast Receiver}
+ \li \l{network/broadcastsender}{Broadcast Sender}
+ \li \l{network/download}{Download}
+ \li \l{network/downloadmanager}{Download Manager}
+ \li \l{network/network-chat}{Network Chat}
+ \li \l{network/fortuneclient}{Fortune Client}\raisedaster
+ \li \l{network/fortuneserver}{Fortune Server}\raisedaster
+ \li \l{network/qftp}{FTP}\raisedaster
+ \li \l{network/http}{HTTP}
+ \li \l{network/loopback}{Loopback}
+ \li \l{network/threadedfortuneserver}{Threaded Fortune Server}\raisedaster
+ \li \l{network/torrent}{Torrent}
+ \li \l{network/googlesuggest}{Google Suggest}
+ \li \l{network/bearercloud}{Bearer Cloud}\raisedaster
+ \li \l{network/bearermonitor}{Bearer Monitor}
+ \li \l{network/securesocketclient}{Secure Socket Client}
+ \li \l{network/multicastreceiver}{Multicast Receiver}
+ \li \l{network/multicastsender}{Multicast Sender}
+ \endlist
+
+ Examples marked with an asterisk (*) are fully documented.
+*/