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>
This commit is contained in:
parent
4873c4151e
commit
0f8b7deef1
@ -28,6 +28,7 @@
|
|||||||
/*!
|
/*!
|
||||||
\example blockingfortuneclient
|
\example blockingfortuneclient
|
||||||
\title Blocking Fortune Client Example
|
\title Blocking Fortune Client Example
|
||||||
|
\ingroup examples-network
|
||||||
|
|
||||||
\brief The Blocking Fortune Client example shows how to create a client for a
|
\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.
|
network service using QTcpSocket's synchronous API in a non-GUI thread.
|
||||||
|
@ -28,6 +28,7 @@
|
|||||||
/*!
|
/*!
|
||||||
\example broadcastreceiver
|
\example broadcastreceiver
|
||||||
\title Broadcast Receiver Example
|
\title Broadcast Receiver Example
|
||||||
|
\ingroup examples-network
|
||||||
|
|
||||||
\brief The Broadcast Receiver example shows how to receive information that is broadcasted
|
\brief The Broadcast Receiver example shows how to receive information that is broadcasted
|
||||||
over a local network.
|
over a local network.
|
||||||
|
@ -28,6 +28,7 @@
|
|||||||
/*!
|
/*!
|
||||||
\example broadcastsender
|
\example broadcastsender
|
||||||
\title Broadcast Sender Example
|
\title Broadcast Sender Example
|
||||||
|
\ingroup examples-network
|
||||||
|
|
||||||
\brief The Broadcast Sender example shows how to broadcast information to multiple clients
|
\brief The Broadcast Sender example shows how to broadcast information to multiple clients
|
||||||
on a local network.
|
on a local network.
|
||||||
|
@ -28,6 +28,7 @@
|
|||||||
/*!
|
/*!
|
||||||
\example fortuneclient
|
\example fortuneclient
|
||||||
\title Fortune Client Example
|
\title Fortune Client Example
|
||||||
|
\ingroup examples-network
|
||||||
|
|
||||||
\brief The Fortune Client example shows how to create a client for a simple
|
\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
|
network service using QTcpSocket. It is intended to be run alongside the
|
||||||
|
@ -28,6 +28,7 @@
|
|||||||
/*!
|
/*!
|
||||||
\example fortuneserver
|
\example fortuneserver
|
||||||
\title Fortune Server Example
|
\title Fortune Server Example
|
||||||
|
\ingroup examples-network
|
||||||
|
|
||||||
\brief The Fortune Server example shows how to create a server for a simple
|
\brief The Fortune Server example shows how to create a server for a simple
|
||||||
network service. It is intended to be run alongside the
|
network service. It is intended to be run alongside the
|
||||||
|
@ -28,6 +28,7 @@
|
|||||||
/*!
|
/*!
|
||||||
\example googlesuggest
|
\example googlesuggest
|
||||||
\title Google Suggest Example
|
\title Google Suggest Example
|
||||||
|
\ingroup examples-network
|
||||||
|
|
||||||
\brief The Google Suggest example demonstrates how to use the QNetworkAccessManager
|
\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
|
class to obtain a list of suggestions from the Google search engine as the
|
||||||
|
@ -28,6 +28,7 @@
|
|||||||
/*!
|
/*!
|
||||||
\example http
|
\example http
|
||||||
\title HTTP Example
|
\title HTTP Example
|
||||||
|
\ingroup examples-network
|
||||||
|
|
||||||
\brief The HTTP example demonstrates a simple HTTP client that shows how to fetch files
|
\brief The HTTP example demonstrates a simple HTTP client that shows how to fetch files
|
||||||
specified by URLs from remote hosts.
|
specified by URLs from remote hosts.
|
||||||
|
@ -28,6 +28,7 @@
|
|||||||
/*!
|
/*!
|
||||||
\example loopback
|
\example loopback
|
||||||
\title Loopback Example
|
\title Loopback Example
|
||||||
|
\ingroup examples-network
|
||||||
|
|
||||||
\brief The Loopback example shows how to communicate between simple clients and servers on a local
|
\brief The Loopback example shows how to communicate between simple clients and servers on a local
|
||||||
host.
|
host.
|
||||||
|
@ -28,6 +28,7 @@
|
|||||||
/*!
|
/*!
|
||||||
\example multicastreceiver
|
\example multicastreceiver
|
||||||
\title Multicast Receiver Example
|
\title Multicast Receiver Example
|
||||||
|
\ingroup examples-network
|
||||||
|
|
||||||
\brief The Multicast Receiever example shows how to receive information that is
|
\brief The Multicast Receiever example shows how to receive information that is
|
||||||
sent to a multicast group.
|
sent to a multicast group.
|
||||||
|
@ -28,6 +28,7 @@
|
|||||||
/*!
|
/*!
|
||||||
\example multicastsender
|
\example multicastsender
|
||||||
\title Multicast Sender Example
|
\title Multicast Sender Example
|
||||||
|
\ingroup examples-network
|
||||||
|
|
||||||
\brief The Multicast Sender example shows how to send information to multiple
|
\brief The Multicast Sender example shows how to send information to multiple
|
||||||
clients in a multicast group.
|
clients in a multicast group.
|
||||||
|
@ -28,6 +28,7 @@
|
|||||||
/*!
|
/*!
|
||||||
\example network-chat
|
\example network-chat
|
||||||
\title Network Chat Example
|
\title Network Chat Example
|
||||||
|
\ingroup examples-network
|
||||||
|
|
||||||
\brief The Network Chat example demonstrates a stateful peer-to-peer Chat client
|
\brief The Network Chat example demonstrates a stateful peer-to-peer Chat client
|
||||||
that uses broadcasting with QUdpSocket and QNetworkInterface to discover
|
that uses broadcasting with QUdpSocket and QNetworkInterface to discover
|
||||||
|
@ -28,6 +28,7 @@
|
|||||||
/*!
|
/*!
|
||||||
\example securesocketclient
|
\example securesocketclient
|
||||||
\title Secure Socket Client Example
|
\title Secure Socket Client Example
|
||||||
|
\ingroup examples-network
|
||||||
|
|
||||||
\brief The Secure Socket Client example shows how to use QSslSocket to
|
\brief The Secure Socket Client example shows how to use QSslSocket to
|
||||||
communicate over an encrypted (SSL) connection. It also demonstrates how
|
communicate over an encrypted (SSL) connection. It also demonstrates how
|
||||||
|
@ -28,6 +28,7 @@
|
|||||||
/*!
|
/*!
|
||||||
\example threadedfortuneserver
|
\example threadedfortuneserver
|
||||||
\title Threaded Fortune Server Example
|
\title Threaded Fortune Server Example
|
||||||
|
\ingroup examples-network
|
||||||
|
|
||||||
\brief The Threaded Fortune Server example shows how to create a server for a
|
\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
|
simple network service that uses threads to handle requests from different
|
||||||
|
@ -28,6 +28,7 @@
|
|||||||
/*!
|
/*!
|
||||||
\example torrent
|
\example torrent
|
||||||
\title Torrent Example
|
\title Torrent Example
|
||||||
|
\ingroup examples-network
|
||||||
|
|
||||||
\brief The Torrent example is a functional BitTorrent client that
|
\brief The Torrent example is a functional BitTorrent client that
|
||||||
illustrates how to write a complex TCP/IP application using Qt.
|
illustrates how to write a complex TCP/IP application using Qt.
|
||||||
|
BIN
src/network/doc/images/network-examples.png
Normal file
BIN
src/network/doc/images/network-examples.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 8.7 KiB |
68
src/network/doc/src/examples.qdoc
Normal file
68
src/network/doc/src/examples.qdoc
Normal 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.
|
||||||
|
*/
|
Loading…
x
Reference in New Issue
Block a user