diff options
Diffstat (limited to 'examples/network/doc/src')
-rw-r--r-- | examples/network/doc/src/blockingfortuneclient.qdoc | 5 | ||||
-rw-r--r-- | examples/network/doc/src/broadcastreceiver.qdoc | 6 | ||||
-rw-r--r-- | examples/network/doc/src/broadcastsender.qdoc | 6 | ||||
-rw-r--r-- | examples/network/doc/src/fortuneclient.qdoc | 5 | ||||
-rw-r--r-- | examples/network/doc/src/fortuneserver.qdoc | 9 | ||||
-rw-r--r-- | examples/network/doc/src/googlesuggest.qdoc | 7 | ||||
-rw-r--r-- | examples/network/doc/src/http.qdoc | 6 | ||||
-rw-r--r-- | examples/network/doc/src/loopback.qdoc | 6 | ||||
-rw-r--r-- | examples/network/doc/src/multicastreceiver.qdoc | 6 | ||||
-rw-r--r-- | examples/network/doc/src/multicastsender.qdoc | 6 | ||||
-rw-r--r-- | examples/network/doc/src/network-chat.qdoc | 7 | ||||
-rw-r--r-- | examples/network/doc/src/network-download.qdoc | 41 | ||||
-rw-r--r-- | examples/network/doc/src/network-downloadmanager.qdoc | 41 | ||||
-rw-r--r-- | examples/network/doc/src/securesocketclient.qdoc | 9 | ||||
-rw-r--r-- | examples/network/doc/src/threadedfortuneserver.qdoc | 1 | ||||
-rw-r--r-- | examples/network/doc/src/torrent.qdoc | 8 |
16 files changed, 134 insertions, 35 deletions
diff --git a/examples/network/doc/src/blockingfortuneclient.qdoc b/examples/network/doc/src/blockingfortuneclient.qdoc index 581cbe6699..c16fd60248 100644 --- a/examples/network/doc/src/blockingfortuneclient.qdoc +++ b/examples/network/doc/src/blockingfortuneclient.qdoc @@ -28,9 +28,8 @@ /*! \example blockingfortuneclient \title Blocking Fortune Client Example - - \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. + \ingroup examples-network + \brief Demonstrates how to create a client for a network service \image blockingfortuneclient-example.png diff --git a/examples/network/doc/src/broadcastreceiver.qdoc b/examples/network/doc/src/broadcastreceiver.qdoc index 99a4cd3823..2ab3c6be67 100644 --- a/examples/network/doc/src/broadcastreceiver.qdoc +++ b/examples/network/doc/src/broadcastreceiver.qdoc @@ -28,9 +28,11 @@ /*! \example broadcastreceiver \title Broadcast Receiver Example + \ingroup examples-network + \brief Demonstrates how to receive information broadcasted over a local network. - \brief The Broadcast Receiver example shows how to receive information that is broadcasted - over a local network. + This example uses the Qt Network APIs to demonstrate how to receive + messages broadcasted over a local network. \image broadcastreceiver-example.png */ diff --git a/examples/network/doc/src/broadcastsender.qdoc b/examples/network/doc/src/broadcastsender.qdoc index dc916e3fed..a9aa1f96d8 100644 --- a/examples/network/doc/src/broadcastsender.qdoc +++ b/examples/network/doc/src/broadcastsender.qdoc @@ -28,9 +28,11 @@ /*! \example broadcastsender \title Broadcast Sender Example + \ingroup examples-network + \brief Demonstrates how to broadcast information to multiple clients on a local network. - \brief The Broadcast Sender example shows how to broadcast information to multiple clients - on a local network. + This example uses Qt Network APIs to demonstrate how to broadcast messages + to multiple clients over a local network. \image broadcastsender-example.png */ diff --git a/examples/network/doc/src/fortuneclient.qdoc b/examples/network/doc/src/fortuneclient.qdoc index 6ef9155337..1d69415f3c 100644 --- a/examples/network/doc/src/fortuneclient.qdoc +++ b/examples/network/doc/src/fortuneclient.qdoc @@ -28,9 +28,10 @@ /*! \example fortuneclient \title Fortune Client Example + \ingroup examples-network + \brief Demonstrates how to create a client for a network service - \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 + This example uses QTcpSocket, and is intended to be run alongside the \l{fortuneserver}{Fortune Server} example or the \l{threadedfortuneserver}{Threaded Fortune Server} example. diff --git a/examples/network/doc/src/fortuneserver.qdoc b/examples/network/doc/src/fortuneserver.qdoc index 05e96b4ded..ca04d80ade 100644 --- a/examples/network/doc/src/fortuneserver.qdoc +++ b/examples/network/doc/src/fortuneserver.qdoc @@ -28,15 +28,16 @@ /*! \example fortuneserver \title Fortune Server Example + \ingroup examples-network + \brief Demonstrates how to create a server for a network service. - \brief The Fortune Server example shows how to create a server for a simple - network service. It is intended to be run alongside the + This example is intended to be run alongside the \l{fortuneclient}{Fortune Client} example or the \l{blockingfortuneclient}{Blocking Fortune Client} example. \image fortuneserver-example.png Screenshot of the Fortune Server example - This example uses QTcpServer to accept incoming TCP connections, and a + It uses QTcpServer to accept incoming TCP connections, and a simple QDataStream based data transfer protocol to write a fortune to the connecting client (from the \l{fortuneclient}{Fortune Client} example), before closing the connection. @@ -55,7 +56,7 @@ \snippet fortuneserver/server.cpp 2 - Our server generates a list of random fortunes that is can send to + Our server generates a list of random fortunes that it can send to connecting clients. \snippet fortuneserver/server.cpp 3 diff --git a/examples/network/doc/src/googlesuggest.qdoc b/examples/network/doc/src/googlesuggest.qdoc index ff16cbf9e0..b53c394d76 100644 --- a/examples/network/doc/src/googlesuggest.qdoc +++ b/examples/network/doc/src/googlesuggest.qdoc @@ -28,10 +28,11 @@ /*! \example googlesuggest \title Google Suggest Example + \ingroup examples-network + \brief Obtains the list of search recommendations by the Google search engine - \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 - user types into a QLineEdit. + The example uses the QNetworkAccessManager to obtain the list of search + recommendations by Google as the user types into a QLineEdit. \image googlesuggest-example.png diff --git a/examples/network/doc/src/http.qdoc b/examples/network/doc/src/http.qdoc index 67bdbdb558..62cfffd603 100644 --- a/examples/network/doc/src/http.qdoc +++ b/examples/network/doc/src/http.qdoc @@ -28,9 +28,11 @@ /*! \example http \title HTTP Example + \ingroup examples-network + \brief Demonstrates a simple HTTP client - \brief The HTTP example demonstrates a simple HTTP client that shows how to fetch files - specified by URLs from remote hosts. + This example demonstrates how a simple HTTP client can fetch files + from remote hosts. \image http-example.png */ diff --git a/examples/network/doc/src/loopback.qdoc b/examples/network/doc/src/loopback.qdoc index 52518a0028..6d74a187fd 100644 --- a/examples/network/doc/src/loopback.qdoc +++ b/examples/network/doc/src/loopback.qdoc @@ -28,9 +28,11 @@ /*! \example loopback \title Loopback Example + \ingroup examples-network + \brief Demonstrates the client-server communication on a local host - \brief The Loopback example shows how to communicate between simple clients and servers on a local - host. + The example demonstrates how the clients and servers on a local host + communicate with each other. \image loopback-example.png */ diff --git a/examples/network/doc/src/multicastreceiver.qdoc b/examples/network/doc/src/multicastreceiver.qdoc index fddbafe788..62174f5d4d 100644 --- a/examples/network/doc/src/multicastreceiver.qdoc +++ b/examples/network/doc/src/multicastreceiver.qdoc @@ -28,9 +28,9 @@ /*! \example multicastreceiver \title Multicast Receiver Example + \ingroup examples-network + \brief Demonstrates how to receive information sent to a multicast group - \brief The Multicast Receiever example shows how to receive information that is - sent to a multicast group. - + This example demonstrates how to receive messages sent to a multicast group \image multicastreceiver-example.png */ diff --git a/examples/network/doc/src/multicastsender.qdoc b/examples/network/doc/src/multicastsender.qdoc index 8d8a400769..c4b93ea0a6 100644 --- a/examples/network/doc/src/multicastsender.qdoc +++ b/examples/network/doc/src/multicastsender.qdoc @@ -28,9 +28,11 @@ /*! \example multicastsender \title Multicast Sender Example + \ingroup examples-network + \brief Demonstrates how to send messages to a multicast group - \brief The Multicast Sender example shows how to send information to multiple - clients in a multicast group. + This example demonstrates how to send messages to the clients of a + multicast group. \image multicastsender-example.png */ diff --git a/examples/network/doc/src/network-chat.qdoc b/examples/network/doc/src/network-chat.qdoc index 0430b5219d..b95a13098f 100644 --- a/examples/network/doc/src/network-chat.qdoc +++ b/examples/network/doc/src/network-chat.qdoc @@ -28,10 +28,11 @@ /*! \example network-chat \title Network Chat Example + \ingroup examples-network + \brief 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 - its peers. + This example uses broadcasting with QUdpSocket and QNetworkInterface to + discover its peers. \image network-chat-example.png */ diff --git a/examples/network/doc/src/network-download.qdoc b/examples/network/doc/src/network-download.qdoc new file mode 100644 index 0000000000..1144361fb5 --- /dev/null +++ b/examples/network/doc/src/network-download.qdoc @@ -0,0 +1,41 @@ +/**************************************************************************** +** +** 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$ +** +****************************************************************************/ + +/*! + \example network/download + \title Network Download Example + \brief Demonstrates how to use networking APIs for multiple downloads + \ingroup examples-network + + The Network Download example shows how to perform multiple downloads in + parallel using the QNetworkAccessManager class. + + This example is designed to be run from the command-line. + + The \l{Network Download Manager Example} implements a more complex system + that places files in a queue for sequential downloading. +*/ diff --git a/examples/network/doc/src/network-downloadmanager.qdoc b/examples/network/doc/src/network-downloadmanager.qdoc new file mode 100644 index 0000000000..9722996d30 --- /dev/null +++ b/examples/network/doc/src/network-downloadmanager.qdoc @@ -0,0 +1,41 @@ +/**************************************************************************** +** +** 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$ +** +****************************************************************************/ + +/*! + \example network/downloadmanager + \title Network Download Manager Example + \brief Demonstrates how to use the networking APIs for multiple downloads + \ingroup examples-network + + The Network Download example shows how to implement a queue for multiple + downloads using the QNetworkAccessManager class. + + This example is designed to be run from the command-line. + + See the \l{Network Download Example} for a simpler version of this example + that obtains multiple files in parallel. +*/ diff --git a/examples/network/doc/src/securesocketclient.qdoc b/examples/network/doc/src/securesocketclient.qdoc index 16986292af..e025b51931 100644 --- a/examples/network/doc/src/securesocketclient.qdoc +++ b/examples/network/doc/src/securesocketclient.qdoc @@ -28,11 +28,12 @@ /*! \example securesocketclient \title Secure Socket Client Example + \ingroup examples-network + \brief Demonstrates how to communicate over an encrypted (SSL) connection - \brief The Secure Socket Client example shows how to use QSslSocket to - communicate over an encrypted (SSL) connection. It also demonstrates how - to deal with authenticity problems, and how to display security and - certificate information. + This example uses QSslSocket to demonstrate how to communicate over an + encrypted connection, deal with authenticity problems, and display security + and certificate information. \image securesocketclient.png \image securesocketclient2.png 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..4bd70eed97 100644 --- a/examples/network/doc/src/torrent.qdoc +++ b/examples/network/doc/src/torrent.qdoc @@ -28,16 +28,18 @@ /*! \example torrent \title Torrent Example + \ingroup examples-network + \brief Demonstrates complex TCP/IP operations - \brief The Torrent example is a functional BitTorrent client that - illustrates how to write a complex TCP/IP application using Qt. + This example demonstrates some of the complex TCP/IP operations + supported by the Qt Network APIs. \image torrent-example.png \section1 License Information The implementation of the US Secure Hash Algorithm 1 (SHA1) in this example is - derived from the original description in \l{RFC 3174}. + derived from the original description in \l{http://www.rfc-editor.org/rfc/rfc3174.txt}{RFC 3174}. \legalese Copyright (C) The Internet Society (2001). All Rights Reserved. |