summaryrefslogtreecommitdiffstats
path: root/src/network/doc/snippets
diff options
context:
space:
mode:
authorKai Koehne <kai.koehne@qt.io>2020-03-06 15:51:29 +0100
committerKai Koehne <kai.koehne@qt.io>2020-03-09 14:53:50 +0100
commit2097932dc54b3ef9a369da956704733792e965b3 (patch)
treec3c4e13d19632ae5dea97ffe977ff636d5a95f4e /src/network/doc/snippets
parent20167a7fe9c1e62881d1673ad05a9779e614d9d3 (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/snippets')
-rw-r--r--src/network/doc/snippets/CMakeLists.txt12
-rw-r--r--src/network/doc/snippets/code/doc_src_qtnetwork.pro3
-rw-r--r--src/network/doc/snippets/network/tcpwait.cpp2
-rw-r--r--src/network/doc/snippets/snippets.pro2
4 files changed, 15 insertions, 4 deletions
diff --git a/src/network/doc/snippets/CMakeLists.txt b/src/network/doc/snippets/CMakeLists.txt
new file mode 100644
index 0000000000..a8030dd260
--- /dev/null
+++ b/src/network/doc/snippets/CMakeLists.txt
@@ -0,0 +1,12 @@
+cmake_minimum_required(VERSION 3.1.0)
+
+project(network_cppsnippets)
+
+add_executable(mytarget
+ network/tcpwait.cpp
+)
+
+# ![0]
+find_package(Qt5 COMPONENTS Network REQUIRED)
+target_link_libraries(mytarget Qt5::Network)
+# ![0]
diff --git a/src/network/doc/snippets/code/doc_src_qtnetwork.pro b/src/network/doc/snippets/code/doc_src_qtnetwork.pro
deleted file mode 100644
index a100943e58..0000000000
--- a/src/network/doc/snippets/code/doc_src_qtnetwork.pro
+++ /dev/null
@@ -1,3 +0,0 @@
-#! [0]
-QT += network
-#! [0]
diff --git a/src/network/doc/snippets/network/tcpwait.cpp b/src/network/doc/snippets/network/tcpwait.cpp
index d57305930c..b81c5c1d53 100644
--- a/src/network/doc/snippets/network/tcpwait.cpp
+++ b/src/network/doc/snippets/network/tcpwait.cpp
@@ -48,7 +48,7 @@
**
****************************************************************************/
-#include <QtGui>
+#include <QCoreApplication>
#include <QTcpSocket>
int main(int argv, char **args)
diff --git a/src/network/doc/snippets/snippets.pro b/src/network/doc/snippets/snippets.pro
index 39153e0c8e..bdf854e454 100644
--- a/src/network/doc/snippets/snippets.pro
+++ b/src/network/doc/snippets/snippets.pro
@@ -2,6 +2,8 @@ TEMPLATE = app
TARGET = network_cppsnippets
+# ![0]
QT += network
+# ![0]
SOURCES += network/tcpwait.cpp