1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Move Network Examples from qtdoc to qtbase

Browse Source 
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>
This commit is contained in:
Eskil Abrahamsen Blomfeldt 2012-12-04 14:06:35 +01:00 committed by The Qt Project
parent 4873c4151e
commit 0f8b7deef1
16 changed files with 82 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
examples/network/doc/src/blockingfortuneclient.qdoc
View File

@ -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.

1
examples/network/doc/src/broadcastreceiver.qdoc
View File

@ -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.

1
examples/network/doc/src/broadcastsender.qdoc
View File

@ -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.

1
examples/network/doc/src/fortuneclient.qdoc
View File

@ -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

1
examples/network/doc/src/fortuneserver.qdoc
View File

@ -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

1
examples/network/doc/src/googlesuggest.qdoc
View File

@ -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

1
examples/network/doc/src/http.qdoc
View File

@ -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.

1
examples/network/doc/src/loopback.qdoc
View File

@ -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.

1
examples/network/doc/src/multicastreceiver.qdoc
View File

@ -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.

1
examples/network/doc/src/multicastsender.qdoc
View File

@ -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.

1
examples/network/doc/src/network-chat.qdoc
View File

@ -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

1
examples/network/doc/src/securesocketclient.qdoc
View File

@ -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

1
examples/network/doc/src/threadedfortuneserver.qdoc
View File

@ -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

1
examples/network/doc/src/torrent.qdoc
View File

@ -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.

BIN
src/network/doc/images/network-examples.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 8.7 KiB

68
src/network/doc/src/examples.qdoc Normal file
View File

@ -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.
*/