From 06ca4e38cf52e5c5ddad8497fa72d2d28d81b2a9 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Fri, 3 Aug 2012 17:39:21 +0200 Subject: Doc: Added a Qt Network landing page. -fixed generated HTML file names -removed qt-network group in qt/qtdoc and removed \ingroup instances Change-Id: Ida5ded5da30e6db1978382f6742a5da8036e055e Reviewed-by: Shane Kearns Reviewed-by: Martin Smith Reviewed-by: Laszlo Papp --- src/corelib/doc/src/datastreamformat.qdoc | 1 - src/corelib/doc/src/resource-system.qdoc | 3 +-- src/network/doc/src/bearermanagement.qdoc | 1 - src/network/doc/src/network-programming.qdoc | 14 +++++----- src/network/doc/src/qtnetwork.qdoc | 38 +++++++++++++++++++++++++++- src/network/doc/src/ssl.qdoc | 1 - 6 files changed, 44 insertions(+), 14 deletions(-) diff --git a/src/corelib/doc/src/datastreamformat.qdoc b/src/corelib/doc/src/datastreamformat.qdoc index 8ff31371a2..fb81840144 100644 --- a/src/corelib/doc/src/datastreamformat.qdoc +++ b/src/corelib/doc/src/datastreamformat.qdoc @@ -28,7 +28,6 @@ /*! \page datastreamformat.html \title Serializing Qt Data Types - \ingroup qt-network \brief Representations of data types that can be serialized by QDataStream. The \l QDataStream allows you to serialize some of the Qt data types. diff --git a/src/corelib/doc/src/resource-system.qdoc b/src/corelib/doc/src/resource-system.qdoc index 87d98edff0..5736e01806 100644 --- a/src/corelib/doc/src/resource-system.qdoc +++ b/src/corelib/doc/src/resource-system.qdoc @@ -28,7 +28,6 @@ /*! \page resources.html \title The Qt Resource System - \ingroup qt-network \brief A platform-independent mechanism for storing binary files in an application. \keyword resource system @@ -153,7 +152,7 @@ argument. \code - rcc -no-compress myresources.qrc + rcc -no-compress myresources.qrc \endcode \c rcc also gives you some control over the compression. You can diff --git a/src/network/doc/src/bearermanagement.qdoc b/src/network/doc/src/bearermanagement.qdoc index 91dc32c5a5..65809f6b10 100644 --- a/src/network/doc/src/bearermanagement.qdoc +++ b/src/network/doc/src/bearermanagement.qdoc @@ -29,7 +29,6 @@ \page bearer-management.html \title Bearer Management -\ingroup qt-network \brief An API to control the system's connectivity state. Bearer Management controls the connectivity state of the system so that diff --git a/src/network/doc/src/network-programming.qdoc b/src/network/doc/src/network-programming.qdoc index 0701b04f6f..0a62a9edae 100644 --- a/src/network/doc/src/network-programming.qdoc +++ b/src/network/doc/src/network-programming.qdoc @@ -34,12 +34,11 @@ */ /*! - \page network-programming.html - \title Network Programming - \ingroup qt-network - \brief An Introduction to Network Programming with Qt + \page qtnetwork-programming.html + \title Network Programming with Qt + \brief Programming applications with networking capabilities - The QtNetwork module offers classes that allow you to write TCP/IP clients + The Qt Network module offers classes that allow you to write TCP/IP clients and servers. It offers lower-level classes such as QTcpSocket, QTcpServer and QUdpSocket that represent low level network concepts, and high level classes such as QNetworkRequest, QNetworkReply and @@ -52,9 +51,8 @@ \section1 Qt's Classes for Network Programming - The following classes provide support for network programming in Qt. - - \annotatedlist network + The \l{Qt Network - C++ Classes} page contains a list of the C++ classes + in Qt Network. \section1 High Level Network Operations for HTTP and FTP diff --git a/src/network/doc/src/qtnetwork.qdoc b/src/network/doc/src/qtnetwork.qdoc index 092880ef59..e03a12b35a 100644 --- a/src/network/doc/src/qtnetwork.qdoc +++ b/src/network/doc/src/qtnetwork.qdoc @@ -25,9 +25,45 @@ ** ****************************************************************************/ +/*! + \page qtnetwork-index.html + \title Qt Network + \brief A module that provides networking capabilities + + Qt Network provides a set of APIs for programming applications that use + TCP/IP. Operations such as requests, cookies, and sending data over HTTP + are handled by various C++ classes. + + \section1 Getting Started + + To use Qt Network classes,add this directive into the C++ files: + \code + #include + \endcode + To link against the Qt Network module, add this line to the project file: + \code + QT += network + \endcode + + \section1 Articles and Guides + + These articles contain information about Qt Network setup and about + applications with networking capabilities. + \list + \li \l{Network Programming with Qt} - Programming applications with networking capabilities + \li \l{Bearer Management} - An API to control the system's connectivity state + \li \l{Secure Sockets Layer (SSL) Classes} - Classes for secure communication over network sockets + \endlist + + \section1 API Reference + These are links to the API reference materials. + \list + \li \l{Qt Network - C++ Classes} + \endlist +*/ /*! \module QtNetwork - \title QtNetwork Module + \title Qt Network - C++ Classes \ingroup modules \brief The QtNetwork module provides classes to make network programming diff --git a/src/network/doc/src/ssl.qdoc b/src/network/doc/src/ssl.qdoc index 21828d7af9..63d7a15485 100644 --- a/src/network/doc/src/ssl.qdoc +++ b/src/network/doc/src/ssl.qdoc @@ -29,7 +29,6 @@ \page ssl.html \title Secure Sockets Layer (SSL) Classes \brief Classes for secure communication over network sockets. - \ingroup qt-network \keyword SSL -- cgit v1.2.3