Doc: Added a Qt Network landing page.
authorJerome Pasion <jerome.pasion@nokia.com>
Fri, 3 Aug 2012 15:39:21 +0000 (17:39 +0200)
committerQt by Nokia <qt-info@nokia.com>
Fri, 10 Aug 2012 15:08:34 +0000 (17:08 +0200)
-fixed generated HTML file names
-removed qt-network group in qt/qtdoc and removed \ingroup instances

Change-Id: Ida5ded5da30e6db1978382f6742a5da8036e055e
Reviewed-by: Shane Kearns <shane.kearns@accenture.com>
Reviewed-by: Martin Smith <martin.smith@nokia.com>
Reviewed-by: Laszlo Papp <lpapp@kde.org>
src/corelib/doc/src/datastreamformat.qdoc
src/corelib/doc/src/resource-system.qdoc
src/network/doc/src/bearermanagement.qdoc
src/network/doc/src/network-programming.qdoc
src/network/doc/src/qtnetwork.qdoc
src/network/doc/src/ssl.qdoc

index 8ff3137..fb81840 100644 (file)
@@ -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.
index 87d98ed..5736e01 100644 (file)
@@ -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
     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
index 91dc32c..65809f6 100644 (file)
@@ -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
index 0701b04..0a62a9e 100644 (file)
 */
 
 /*!
-    \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
 
index 092880e..e03a12b 100644 (file)
 ****************************************************************************/
 
 /*!
+    \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 <QtNetwork>
+    \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
index 21828d7..63d7a15 100644 (file)
@@ -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