From 4727bb59912484b7f67a56b1fbed4919d5b71c19 Mon Sep 17 00:00:00 2001 From: Eike Ziller Date: Wed, 28 Nov 2012 17:04:12 +0100 Subject: Add \brief to the examples. That is used by qdoc to generate brief descriptions for the example manifests. Change-Id: I142a6d3259f90d0c9990033b3c36e139062ac343 Reviewed-by: Eike Ziller Reviewed-by: hjk --- examples/network/doc/src/blockingfortuneclient.qdoc | 2 +- examples/network/doc/src/broadcastreceiver.qdoc | 2 +- examples/network/doc/src/broadcastsender.qdoc | 2 +- examples/network/doc/src/fortuneclient.qdoc | 2 +- examples/network/doc/src/fortuneserver.qdoc | 2 +- examples/network/doc/src/googlesuggest.qdoc | 2 +- examples/network/doc/src/http.qdoc | 2 +- examples/network/doc/src/loopback.qdoc | 2 +- examples/network/doc/src/multicastreceiver.qdoc | 2 +- examples/network/doc/src/multicastsender.qdoc | 2 +- examples/network/doc/src/network-chat.qdoc | 2 +- examples/network/doc/src/securesocketclient.qdoc | 2 +- examples/network/doc/src/threadedfortuneserver.qdoc | 2 +- examples/network/doc/src/torrent.qdoc | 2 +- 14 files changed, 14 insertions(+), 14 deletions(-) (limited to 'examples/network/doc') diff --git a/examples/network/doc/src/blockingfortuneclient.qdoc b/examples/network/doc/src/blockingfortuneclient.qdoc index c6aee54da6..581cbe6699 100644 --- a/examples/network/doc/src/blockingfortuneclient.qdoc +++ b/examples/network/doc/src/blockingfortuneclient.qdoc @@ -29,7 +29,7 @@ \example blockingfortuneclient \title Blocking Fortune Client Example - 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. \image blockingfortuneclient-example.png diff --git a/examples/network/doc/src/broadcastreceiver.qdoc b/examples/network/doc/src/broadcastreceiver.qdoc index 28d00ead7a..99a4cd3823 100644 --- a/examples/network/doc/src/broadcastreceiver.qdoc +++ b/examples/network/doc/src/broadcastreceiver.qdoc @@ -29,7 +29,7 @@ \example broadcastreceiver \title Broadcast Receiver Example - 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. \image broadcastreceiver-example.png diff --git a/examples/network/doc/src/broadcastsender.qdoc b/examples/network/doc/src/broadcastsender.qdoc index e2e73825b8..dc916e3fed 100644 --- a/examples/network/doc/src/broadcastsender.qdoc +++ b/examples/network/doc/src/broadcastsender.qdoc @@ -29,7 +29,7 @@ \example broadcastsender \title Broadcast Sender Example - 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. \image broadcastsender-example.png diff --git a/examples/network/doc/src/fortuneclient.qdoc b/examples/network/doc/src/fortuneclient.qdoc index 64609eb8ea..6ef9155337 100644 --- a/examples/network/doc/src/fortuneclient.qdoc +++ b/examples/network/doc/src/fortuneclient.qdoc @@ -29,7 +29,7 @@ \example fortuneclient \title Fortune Client Example - 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 \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 4beb60e967..05e96b4ded 100644 --- a/examples/network/doc/src/fortuneserver.qdoc +++ b/examples/network/doc/src/fortuneserver.qdoc @@ -29,7 +29,7 @@ \example fortuneserver \title Fortune Server Example - 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 \l{fortuneclient}{Fortune Client} example or the \l{blockingfortuneclient}{Blocking Fortune Client} example. diff --git a/examples/network/doc/src/googlesuggest.qdoc b/examples/network/doc/src/googlesuggest.qdoc index b18d082f89..ff16cbf9e0 100644 --- a/examples/network/doc/src/googlesuggest.qdoc +++ b/examples/network/doc/src/googlesuggest.qdoc @@ -29,7 +29,7 @@ \example googlesuggest \title Google Suggest Example - 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 user types into a QLineEdit. diff --git a/examples/network/doc/src/http.qdoc b/examples/network/doc/src/http.qdoc index 052f05e371..67bdbdb558 100644 --- a/examples/network/doc/src/http.qdoc +++ b/examples/network/doc/src/http.qdoc @@ -29,7 +29,7 @@ \example http \title HTTP Example - 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. \image http-example.png diff --git a/examples/network/doc/src/loopback.qdoc b/examples/network/doc/src/loopback.qdoc index 0401f17256..52518a0028 100644 --- a/examples/network/doc/src/loopback.qdoc +++ b/examples/network/doc/src/loopback.qdoc @@ -29,7 +29,7 @@ \example loopback \title Loopback Example - 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. \image loopback-example.png diff --git a/examples/network/doc/src/multicastreceiver.qdoc b/examples/network/doc/src/multicastreceiver.qdoc index d72d42dc5d..fddbafe788 100644 --- a/examples/network/doc/src/multicastreceiver.qdoc +++ b/examples/network/doc/src/multicastreceiver.qdoc @@ -29,7 +29,7 @@ \example multicastreceiver \title Multicast Receiver Example - 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. \image multicastreceiver-example.png diff --git a/examples/network/doc/src/multicastsender.qdoc b/examples/network/doc/src/multicastsender.qdoc index fcb231a12b..8d8a400769 100644 --- a/examples/network/doc/src/multicastsender.qdoc +++ b/examples/network/doc/src/multicastsender.qdoc @@ -29,7 +29,7 @@ \example multicastsender \title Multicast Sender Example - 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. \image multicastsender-example.png diff --git a/examples/network/doc/src/network-chat.qdoc b/examples/network/doc/src/network-chat.qdoc index 3ef95efce3..0430b5219d 100644 --- a/examples/network/doc/src/network-chat.qdoc +++ b/examples/network/doc/src/network-chat.qdoc @@ -29,7 +29,7 @@ \example network-chat \title Network Chat Example - 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 its peers. diff --git a/examples/network/doc/src/securesocketclient.qdoc b/examples/network/doc/src/securesocketclient.qdoc index 538c135a87..16986292af 100644 --- a/examples/network/doc/src/securesocketclient.qdoc +++ b/examples/network/doc/src/securesocketclient.qdoc @@ -29,7 +29,7 @@ \example securesocketclient \title Secure Socket Client Example - 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 to deal with authenticity problems, and how to display security and certificate information. diff --git a/examples/network/doc/src/threadedfortuneserver.qdoc b/examples/network/doc/src/threadedfortuneserver.qdoc index 89f7d3e5d1..f8441bcc2f 100644 --- a/examples/network/doc/src/threadedfortuneserver.qdoc +++ b/examples/network/doc/src/threadedfortuneserver.qdoc @@ -29,7 +29,7 @@ \example threadedfortuneserver \title Threaded Fortune Server Example - 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 clients. It is intended to be run alongside the Fortune Client example. diff --git a/examples/network/doc/src/torrent.qdoc b/examples/network/doc/src/torrent.qdoc index d605115fe4..ef13ef6ed9 100644 --- a/examples/network/doc/src/torrent.qdoc +++ b/examples/network/doc/src/torrent.qdoc @@ -29,7 +29,7 @@ \example torrent \title Torrent Example - 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. \image torrent-example.png -- cgit v1.2.3