From 059b10f295d8d04c4144984daf1464115bcb69c9 Mon Sep 17 00:00:00 2001 From: Venugopal Shivashankar Date: Thu, 28 Jun 2018 14:55:06 +0200 Subject: Doc: Check before including the \snippet from a .pro file MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: Icc7552b46a2657c81958e40f33596ddeee045172 Reviewed-by: Friedemann Kleint Reviewed-by: Topi Reiniö --- src/dbus/doc/src/qtdbus-module.qdoc | 2 ++ src/gui/doc/src/qtgui.qdoc | 5 ++++- src/network/doc/src/qtnetwork.qdoc | 3 +++ src/opengl/doc/src/qtopengl-index.qdoc | 2 ++ src/opengl/doc/src/qtopengl-module.qdoc | 2 ++ src/printsupport/doc/src/qtprintsupport-module.qdoc | 2 ++ src/sql/doc/src/qtsql.qdoc | 2 ++ src/testlib/doc/src/qttest-index.qdoc | 2 ++ src/testlib/doc/src/qttest.qdoc | 2 ++ src/testlib/doc/src/qttestlib-manual.qdoc | 2 ++ src/widgets/doc/src/qtwidgets.qdoc | 2 ++ src/xml/doc/src/qtxml-index.qdoc | 2 ++ src/xml/doc/src/qtxml.qdoc | 2 ++ 13 files changed, 29 insertions(+), 1 deletion(-) diff --git a/src/dbus/doc/src/qtdbus-module.qdoc b/src/dbus/doc/src/qtdbus-module.qdoc index 965475ab8d..0ef5999b11 100644 --- a/src/dbus/doc/src/qtdbus-module.qdoc +++ b/src/dbus/doc/src/qtdbus-module.qdoc @@ -51,6 +51,7 @@ \snippet code/doc_src_qtdbus.cpp 0 + \if !defined(qtforpython) If you're using qmake to build your application, you can add this line to your .pro file to make it link against the Qt D-Bus libraries: @@ -60,6 +61,7 @@ \note The source code for this module is located in the \c{src/qdbus} directory. When installing Qt from source, this module is built when Qt's tools are built. + \endif See the \l {Qt D-Bus}{D-Bus} page for detailed information on how to use this module. diff --git a/src/gui/doc/src/qtgui.qdoc b/src/gui/doc/src/qtgui.qdoc index a425c8a84d..53fd55bd39 100644 --- a/src/gui/doc/src/qtgui.qdoc +++ b/src/gui/doc/src/qtgui.qdoc @@ -46,11 +46,12 @@ \snippet code/doc_src_qtgui.pro 0 + \if !defined(qtforpython) If you use \l qmake to build your projects, \l{Qt GUI} is included by default. To disable Qt GUI, add the following line to your \c .pro file: \snippet code/doc_src_qtgui.pro 1 - + \endif */ /*! @@ -75,10 +76,12 @@ \snippet code/doc_src_qtgui.pro 0 + \if !defined(qtforpython) If you use \l qmake to build your projects, Qt GUI is included by default. To disable Qt GUI, add the following line to your \c .pro file: \snippet code/doc_src_qtgui.pro 1 + \endif \section1 Application Windows diff --git a/src/network/doc/src/qtnetwork.qdoc b/src/network/doc/src/qtnetwork.qdoc index 517e0a72cb..c931a1c19f 100644 --- a/src/network/doc/src/qtnetwork.qdoc +++ b/src/network/doc/src/qtnetwork.qdoc @@ -40,10 +40,13 @@ \code #include \endcode + + \if !defined(qtforpython) To link against the Qt Network module, add this line to the project file: \code QT += network \endcode + \endif \section1 Articles and Guides diff --git a/src/opengl/doc/src/qtopengl-index.qdoc b/src/opengl/doc/src/qtopengl-index.qdoc index 30b657f6db..4694f68a93 100644 --- a/src/opengl/doc/src/qtopengl-index.qdoc +++ b/src/opengl/doc/src/qtopengl-index.qdoc @@ -51,10 +51,12 @@ \snippet code/doc_src_qtopengl.cpp 0 + \if !defined(qtforpython) To link against the module, add this line to your \l qmake \c .pro file: \snippet code/doc_src_qtopengl.pro 1 + \endif The Qt OpenGL module is implemented as a platform-independent Qt/C++ wrapper around the platform-dependent GLX (version 1.3 or later), diff --git a/src/opengl/doc/src/qtopengl-module.qdoc b/src/opengl/doc/src/qtopengl-module.qdoc index e9b1258266..336d37c73f 100644 --- a/src/opengl/doc/src/qtopengl-module.qdoc +++ b/src/opengl/doc/src/qtopengl-module.qdoc @@ -57,10 +57,12 @@ \snippet code/doc_src_qtopengl.cpp 0 + \if !defined(qtforpython) To link against the module, add this line to your \l qmake \c .pro file: \snippet code/doc_src_qtopengl.pro 1 + \endif The Qt OpenGL module is implemented as a platform-independent Qt/C++ wrapper around the platform-dependent GLX (version 1.3 or later), diff --git a/src/printsupport/doc/src/qtprintsupport-module.qdoc b/src/printsupport/doc/src/qtprintsupport-module.qdoc index 686d16f38a..0e851e593c 100644 --- a/src/printsupport/doc/src/qtprintsupport-module.qdoc +++ b/src/printsupport/doc/src/qtprintsupport-module.qdoc @@ -38,8 +38,10 @@ \snippet code/doc_src_qtprintsupport.cpp 1 + \if !defined(qtforpython) To link against the module, add this line to your \l qmake \c .pro file: \snippet code/doc_src_qtprintsupport.pro 0 + \endif */ diff --git a/src/sql/doc/src/qtsql.qdoc b/src/sql/doc/src/qtsql.qdoc index f0d74739b0..39c0e44187 100644 --- a/src/sql/doc/src/qtsql.qdoc +++ b/src/sql/doc/src/qtsql.qdoc @@ -87,10 +87,12 @@ \snippet code/doc_src_qtsql.cpp 0 + \if !defined(qtforpython) To link against the module, add this line to your \l qmake \c .pro file: \snippet code/doc_src_qtsql.pro 1 + \endif See the \l{SQL Programming} guide for information about using this module in your applications. diff --git a/src/testlib/doc/src/qttest-index.qdoc b/src/testlib/doc/src/qttest-index.qdoc index b3c2be7375..8c817b3653 100644 --- a/src/testlib/doc/src/qttest-index.qdoc +++ b/src/testlib/doc/src/qttest-index.qdoc @@ -41,9 +41,11 @@ \snippet code/doc_src_qttest.cpp 0 + \if !define(qtforpython) To link against Qt Test, add this line to the project file: \snippet code/doc_src_qttest.pro 1 + \endif \section1 Articles and Guides diff --git a/src/testlib/doc/src/qttest.qdoc b/src/testlib/doc/src/qttest.qdoc index 696111f2f3..e61fd71e69 100644 --- a/src/testlib/doc/src/qttest.qdoc +++ b/src/testlib/doc/src/qttest.qdoc @@ -42,10 +42,12 @@ \snippet code/doc_src_qttest.cpp 0 + \if !defined(qtforpython) To link against the module, add this line to your \l qmake \c .pro file: \snippet code/doc_src_qttest.pro 1 + \endif See \l{Qt Test Overview} for an introduction on how to use Qt's unit testing features with your applications. diff --git a/src/testlib/doc/src/qttestlib-manual.qdoc b/src/testlib/doc/src/qttestlib-manual.qdoc index 9bd210d71f..363ec17c6c 100644 --- a/src/testlib/doc/src/qttestlib-manual.qdoc +++ b/src/testlib/doc/src/qttestlib-manual.qdoc @@ -109,6 +109,7 @@ For more examples, refer to the \l{Qt Test Tutorial}. + \if !defined(qtforpython) \section1 Building a Test If you are using \c qmake as your build tool, just add the @@ -132,6 +133,7 @@ See \l {Chapter 1: Writing a Unit Test}{Writing a Unit Test} for a step by step explanation. + \endif \section1 Qt Test Command Line Arguments diff --git a/src/widgets/doc/src/qtwidgets.qdoc b/src/widgets/doc/src/qtwidgets.qdoc index e0a5b094cd..72ba22681c 100644 --- a/src/widgets/doc/src/qtwidgets.qdoc +++ b/src/widgets/doc/src/qtwidgets.qdoc @@ -38,9 +38,11 @@ \snippet code/doc_src_qtwidgets.cpp 1 + \if !defined(qtforpython) To link against the module, add this line to your \l qmake \c .pro file: \snippet code/doc_src_qtwidgets.pro 0 + \endif */ diff --git a/src/xml/doc/src/qtxml-index.qdoc b/src/xml/doc/src/qtxml-index.qdoc index 91f2515d60..dfb9b45fa7 100644 --- a/src/xml/doc/src/qtxml-index.qdoc +++ b/src/xml/doc/src/qtxml-index.qdoc @@ -38,10 +38,12 @@ \snippet code/doc_src_qtxml.cpp 0 + \if !defined(qtforpython) To link against the module, add this line to your \l qmake \c .pro file: \snippet code/doc_src_qtxml.pro 1 + \endif The \l{Qt XML C++ Classes} page gives an overview over the available classes in this module. diff --git a/src/xml/doc/src/qtxml.qdoc b/src/xml/doc/src/qtxml.qdoc index dbad66a507..ad9b08b623 100644 --- a/src/xml/doc/src/qtxml.qdoc +++ b/src/xml/doc/src/qtxml.qdoc @@ -41,8 +41,10 @@ \snippet code/doc_src_qtxml.cpp 0 + \if !defined(qtforpython) To link against the module, add this line to your \l qmake \c .pro file: \snippet code/doc_src_qtxml.pro 1 + \endif */ -- cgit v1.2.3