diff options
author | Jerome Pasion <jerome.pasion@nokia.com> | 2012-08-03 17:39:21 +0200 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-08-10 17:08:34 +0200 |
commit | 06ca4e38cf52e5c5ddad8497fa72d2d28d81b2a9 (patch) | |
tree | adae2ea3145a8fc7f34bc4c61a91dbbfd9f8697b /src/network/doc/src/qtnetwork.qdoc | |
parent | 2b4ce2f0ffd90cb3783ce80f0dc68c4d7891d560 (diff) |
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 <shane.kearns@accenture.com>
Reviewed-by: Martin Smith <martin.smith@nokia.com>
Reviewed-by: Laszlo Papp <lpapp@kde.org>
Diffstat (limited to 'src/network/doc/src/qtnetwork.qdoc')
-rw-r--r-- | src/network/doc/src/qtnetwork.qdoc | 38 |
1 files changed, 37 insertions, 1 deletions
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 @@ -26,8 +26,44 @@ ****************************************************************************/ /*! + \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 |