summaryrefslogtreecommitdiffstats
path: root/src/network/doc/src/qtnetwork.qdoc
blob: 6d9f6023abc1999340e1bba2fcb3296d399a5a89 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/****************************************************************************
**
** Copyright (C) 2013 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$
**
****************************************************************************/

/*!
    \page qtnetwork-index.html
    \title Qt Network
    \brief 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}{C++ Classes}
    \endlist
*/
/*!
    \module QtNetwork
    \title Qt Network C++ Classes
    \ingroup modules
    \brief Provides classes to make network programming easier and portable

    To include the definitions of the module's classes, use the
    following directive:

    \snippet code/doc_src_qtnetwork.cpp 1

    To link against the module, add this line to your \l qmake \c
    .pro file:

    \snippet code/doc_src_qtnetwork.pro 0
*/