diff options
author | Kai Koehne <kai.koehne@qt.io> | 2020-03-06 15:51:29 +0100 |
---|---|---|
committer | Kai Koehne <kai.koehne@qt.io> | 2020-03-09 14:53:50 +0100 |
commit | 2097932dc54b3ef9a369da956704733792e965b3 (patch) | |
tree | c3c4e13d19632ae5dea97ffe977ff636d5a95f4e /src/network/doc/src/qtnetwork.qdoc | |
parent | 20167a7fe9c1e62881d1673ad05a9779e614d9d3 (diff) |
Document how to use CMake for Qt Network
Add documentation on how to use a module from CMake, alongside
the existing documentation about qmake.
While at it, also remove the mentioning of the central include;
It is not something we should actively advocate anymore. Instead,
the documentation of every class gives the correct include to use.
Task-number: QTBUG-73058
Change-Id: I71ed5a62f4f0a6d868dd1f84ea39e5ac385a2fb8
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Diffstat (limited to 'src/network/doc/src/qtnetwork.qdoc')
-rw-r--r-- | src/network/doc/src/qtnetwork.qdoc | 30 |
1 files changed, 10 insertions, 20 deletions
diff --git a/src/network/doc/src/qtnetwork.qdoc b/src/network/doc/src/qtnetwork.qdoc index 85a3c198a0..57b0210b7f 100644 --- a/src/network/doc/src/qtnetwork.qdoc +++ b/src/network/doc/src/qtnetwork.qdoc @@ -34,19 +34,16 @@ TCP/IP. Operations such as requests, cookies, and sending data over HTTP are handled by various C++ classes. - \section1 Getting Started + \include module-use.qdocinc using qt module + \snippet CMakeLists.txt 0 - To use Qt Network classes,add this directive into the C++ files: - \code - #include <QtNetwork> - \endcode + See also the \l{Build with CMake} overview. - \if !defined(qtforpython) - To link against the Qt Network module, add this line to the project file: - \code - QT += network - \endcode - \endif + \section2 Building with qmake + + Add \c network to the \c QT variable: + + \snippet snippets.pro 0 \section1 Articles and Guides @@ -100,13 +97,6 @@ \qtvariable network \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 + Qt Network provides a set of APIs for programming applications that use + TCP/IP. See the \l{Qt Network} overview for more information. */ |