summaryrefslogtreecommitdiffstats
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
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>
-rw-r--r--examples/network/doc/src/blockingfortuneclient.qdoc1
-rw-r--r--examples/network/doc/src/broadcastreceiver.qdoc1
-rw-r--r--examples/network/doc/src/broadcastsender.qdoc1
-rw-r--r--examples/network/doc/src/fortuneclient.qdoc1
-rw-r--r--examples/network/doc/src/fortuneserver.qdoc1
-rw-r--r--examples/network/doc/src/googlesuggest.qdoc1
-rw-r--r--examples/network/doc/src/http.qdoc1
-rw-r--r--examples/network/doc/src/loopback.qdoc1
-rw-r--r--examples/network/doc/src/multicastreceiver.qdoc1
-rw-r--r--examples/network/doc/src/multicastsender.qdoc1
-rw-r--r--examples/network/doc/src/network-chat.qdoc1
-rw-r--r--examples/network/doc/src/securesocketclient.qdoc1
-rw-r--r--examples/network/doc/src/threadedfortuneserver.qdoc1
-rw-r--r--examples/network/doc/src/torrent.qdoc1
-rw-r--r--src/network/doc/images/network-examples.pngbin0 -> 8946 bytes
-rw-r--r--src/network/doc/src/examples.qdoc68
16 files changed, 82 insertions, 0 deletions
diff --git a/examples/network/doc/src/blockingfortuneclient.qdoc b/examples/network/doc/src/blockingfortuneclient.qdoc
index 581cbe6699..4e105b50a7 100644
--- a/examples/network/doc/src/blockingfortuneclient.qdoc
+++ b/examples/network/doc/src/blockingfortuneclient.qdoc
@@ -28,6 +28,7 @@
/*!
\example blockingfortuneclient
\title Blocking Fortune Client Example
+ \ingroup examples-network
\brief The Blocking Fortune Client example shows how to create a client for a
network service using QTcpSocket's synchronous API in a non-GUI thread.
diff --git a/examples/network/doc/src/broadcastreceiver.qdoc b/examples/network/doc/src/broadcastreceiver.qdoc
index 99a4cd3823..374bc29244 100644
--- a/examples/network/doc/src/broadcastreceiver.qdoc
+++ b/examples/network/doc/src/broadcastreceiver.qdoc
@@ -28,6 +28,7 @@
/*!
\example broadcastreceiver
\title Broadcast Receiver Example
+ \ingroup examples-network
\brief The Broadcast Receiver example shows how to receive information that is broadcasted
over a local network.
diff --git a/examples/network/doc/src/broadcastsender.qdoc b/examples/network/doc/src/broadcastsender.qdoc
index dc916e3fed..a587c5fddd 100644
--- a/examples/network/doc/src/broadcastsender.qdoc
+++ b/examples/network/doc/src/broadcastsender.qdoc
@@ -28,6 +28,7 @@
/*!
\example broadcastsender
\title Broadcast Sender Example
+ \ingroup examples-network
\brief The Broadcast Sender example shows how to broadcast information to multiple clients
on a local network.
diff --git a/examples/network/doc/src/fortuneclient.qdoc b/examples/network/doc/src/fortuneclient.qdoc
index 6ef9155337..f7a4c56020 100644
--- a/examples/network/doc/src/fortuneclient.qdoc
+++ b/examples/network/doc/src/fortuneclient.qdoc
@@ -28,6 +28,7 @@
/*!
\example fortuneclient
\title Fortune Client Example
+ \ingroup examples-network
\brief The Fortune Client example shows how to create a client for a simple
network service using QTcpSocket. It is intended to be run alongside the
diff --git a/examples/network/doc/src/fortuneserver.qdoc b/examples/network/doc/src/fortuneserver.qdoc
index 05e96b4ded..d702bc6bb1 100644
--- a/examples/network/doc/src/fortuneserver.qdoc
+++ b/examples/network/doc/src/fortuneserver.qdoc
@@ -28,6 +28,7 @@
/*!
\example fortuneserver
\title Fortune Server Example
+ \ingroup examples-network
\brief The Fortune Server example shows how to create a server for a simple
network service. It is intended to be run alongside the
diff --git a/examples/network/doc/src/googlesuggest.qdoc b/examples/network/doc/src/googlesuggest.qdoc
index ff16cbf9e0..c04e65c3f9 100644
--- a/examples/network/doc/src/googlesuggest.qdoc
+++ b/examples/network/doc/src/googlesuggest.qdoc
@@ -28,6 +28,7 @@
/*!
\example googlesuggest
\title Google Suggest Example
+ \ingroup examples-network
\brief The Google Suggest example demonstrates how to use the QNetworkAccessManager
class to obtain a list of suggestions from the Google search engine as the
diff --git a/examples/network/doc/src/http.qdoc b/examples/network/doc/src/http.qdoc
index 67bdbdb558..89223b7894 100644
--- a/examples/network/doc/src/http.qdoc
+++ b/examples/network/doc/src/http.qdoc
@@ -28,6 +28,7 @@
/*!
\example http
\title HTTP Example
+ \ingroup examples-network
\brief The HTTP example demonstrates a simple HTTP client that shows how to fetch files
specified by URLs from remote hosts.
diff --git a/examples/network/doc/src/loopback.qdoc b/examples/network/doc/src/loopback.qdoc
index 52518a0028..e278a9e9bd 100644
--- a/examples/network/doc/src/loopback.qdoc
+++ b/examples/network/doc/src/loopback.qdoc
@@ -28,6 +28,7 @@
/*!
\example loopback
\title Loopback Example
+ \ingroup examples-network
\brief The Loopback example shows how to communicate between simple clients and servers on a local
host.
diff --git a/examples/network/doc/src/multicastreceiver.qdoc b/examples/network/doc/src/multicastreceiver.qdoc
index fddbafe788..88ed6020d4 100644
--- a/examples/network/doc/src/multicastreceiver.qdoc
+++ b/examples/network/doc/src/multicastreceiver.qdoc
@@ -28,6 +28,7 @@
/*!
\example multicastreceiver
\title Multicast Receiver Example
+ \ingroup examples-network
\brief The Multicast Receiever example shows how to receive information that is
sent to a multicast group.
diff --git a/examples/network/doc/src/multicastsender.qdoc b/examples/network/doc/src/multicastsender.qdoc
index 8d8a400769..4ec9defb53 100644
--- a/examples/network/doc/src/multicastsender.qdoc
+++ b/examples/network/doc/src/multicastsender.qdoc
@@ -28,6 +28,7 @@
/*!
\example multicastsender
\title Multicast Sender Example
+ \ingroup examples-network
\brief The Multicast Sender example shows how to send information to multiple
clients in a multicast group.
diff --git a/examples/network/doc/src/network-chat.qdoc b/examples/network/doc/src/network-chat.qdoc
index 0430b5219d..cd5ec4b348 100644
--- a/examples/network/doc/src/network-chat.qdoc
+++ b/examples/network/doc/src/network-chat.qdoc
@@ -28,6 +28,7 @@
/*!
\example network-chat
\title Network Chat Example
+ \ingroup examples-network
\brief The Network Chat example demonstrates a stateful peer-to-peer Chat client
that uses broadcasting with QUdpSocket and QNetworkInterface to discover
diff --git a/examples/network/doc/src/securesocketclient.qdoc b/examples/network/doc/src/securesocketclient.qdoc
index 16986292af..a61a00e833 100644
--- a/examples/network/doc/src/securesocketclient.qdoc
+++ b/examples/network/doc/src/securesocketclient.qdoc
@@ -28,6 +28,7 @@
/*!
\example securesocketclient
\title Secure Socket Client Example
+ \ingroup examples-network
\brief The Secure Socket Client example shows how to use QSslSocket to
communicate over an encrypted (SSL) connection. It also demonstrates how
diff --git a/examples/network/doc/src/threadedfortuneserver.qdoc b/examples/network/doc/src/threadedfortuneserver.qdoc
index f8441bcc2f..43a7e88241 100644
--- a/examples/network/doc/src/threadedfortuneserver.qdoc
+++ b/examples/network/doc/src/threadedfortuneserver.qdoc
@@ -28,6 +28,7 @@
/*!
\example threadedfortuneserver
\title Threaded Fortune Server Example
+ \ingroup examples-network
\brief The Threaded Fortune Server example shows how to create a server for a
simple network service that uses threads to handle requests from different
diff --git a/examples/network/doc/src/torrent.qdoc b/examples/network/doc/src/torrent.qdoc
index ef13ef6ed9..791464c9a4 100644
--- a/examples/network/doc/src/torrent.qdoc
+++ b/examples/network/doc/src/torrent.qdoc
@@ -28,6 +28,7 @@
/*!
\example torrent
\title Torrent Example
+ \ingroup examples-network
\brief The Torrent example is a functional BitTorrent client that
illustrates how to write a complex TCP/IP application using Qt.
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.
+*/