From d0bc34adc5cd733b93efb50b18794bce14d58075 Mon Sep 17 00:00:00 2001 From: Nico Vertriest Date: Wed, 29 Apr 2020 13:03:47 +0200 Subject: Make QtQuickTest snippets compilable Task-number: QTBUG-81495 Change-Id: I9e57ac2a22cea9d35847145842a7e822fd1c4c30 Reviewed-by: Venugopal Shivashankar Reviewed-by: Paul Wicking --- src/qmltest/doc/snippets/snippets.pro | 7 +++ .../doc/snippets/src_qmltest_qquicktest.cpp | 13 ++--- .../snippets/src_qmltest_qquicktest_snippet.cpp | 57 ++++++++++++++++++++++ src/qmltest/doc/src/qtquicktest-cppapi.qdoc | 2 +- src/qmltest/doc/src/qtquicktest-index.qdoc | 4 +- src/qmltest/doc/src/qtquicktest.qdoc | 2 +- 6 files changed, 71 insertions(+), 14 deletions(-) create mode 100644 src/qmltest/doc/snippets/snippets.pro create mode 100644 src/qmltest/doc/snippets/src_qmltest_qquicktest_snippet.cpp (limited to 'src/qmltest/doc') diff --git a/src/qmltest/doc/snippets/snippets.pro b/src/qmltest/doc/snippets/snippets.pro new file mode 100644 index 0000000000..cf47e4efce --- /dev/null +++ b/src/qmltest/doc/snippets/snippets.pro @@ -0,0 +1,7 @@ +TEMPLATE = lib + +QT += qml qmltest + +TARGET = qtquick_test_snippets + +SOURCES += src_qmltest_qquicktest.cpp diff --git a/src/qmltest/doc/snippets/src_qmltest_qquicktest.cpp b/src/qmltest/doc/snippets/src_qmltest_qquicktest.cpp index 191f693a9a..e773063e83 100644 --- a/src/qmltest/doc/snippets/src_qmltest_qquicktest.cpp +++ b/src/qmltest/doc/snippets/src_qmltest_qquicktest.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the documentation of the Qt Toolkit. @@ -48,15 +48,8 @@ ** ****************************************************************************/ -//! [1] -//! [0] -#include -//! [0] -QUICK_TEST_MAIN(example) -//! [1] - //! [2] -// tst_mytest.cpp +// src_qmltest_qquicktest.cpp #include #include #include @@ -77,5 +70,5 @@ public slots: QUICK_TEST_MAIN_WITH_SETUP(mytest, Setup) -#include "tst_mytest.moc" +#include "src_qmltest_qquicktest.moc" //! [2] diff --git a/src/qmltest/doc/snippets/src_qmltest_qquicktest_snippet.cpp b/src/qmltest/doc/snippets/src_qmltest_qquicktest_snippet.cpp new file mode 100644 index 0000000000..47a126958a --- /dev/null +++ b/src/qmltest/doc/snippets/src_qmltest_qquicktest_snippet.cpp @@ -0,0 +1,57 @@ +/**************************************************************************** +** +** Copyright (C) 2020 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:BSD$ +** 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 The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** BSD License Usage +** Alternatively, you may use this file under the terms of the BSD license +** as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of The Qt Company Ltd nor the names of its +** contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +//! [1] +//! [0] +#include +//! [0] +QUICK_TEST_MAIN(example) +//! [1] + diff --git a/src/qmltest/doc/src/qtquicktest-cppapi.qdoc b/src/qmltest/doc/src/qtquicktest-cppapi.qdoc index 0e5dab8887..7dbdaae4a5 100644 --- a/src/qmltest/doc/src/qtquicktest-cppapi.qdoc +++ b/src/qmltest/doc/src/qtquicktest-cppapi.qdoc @@ -36,7 +36,7 @@ The C++ macros and functions can be included into your application using the following include statement: - \snippet src_qmltest_qquicktest.cpp 0 + \snippet src_qmltest_qquicktest_snippet.cpp 0 There are two ways to link against the corresponding C++ library. If your test project uses a QML \l TestCase, you should already have the following diff --git a/src/qmltest/doc/src/qtquicktest-index.qdoc b/src/qmltest/doc/src/qtquicktest-index.qdoc index a7a840f2b3..836030aedc 100644 --- a/src/qmltest/doc/src/qtquicktest-index.qdoc +++ b/src/qmltest/doc/src/qtquicktest-index.qdoc @@ -69,7 +69,7 @@ Test cases are launched by a C++ harness that consists of the following code: - \snippet src_qmltest_qquicktest.cpp 1 + \snippet src_qmltest_qquicktest_snippet.cpp 1 Where "example" is the identifier to use to uniquely identify this set of tests. Finally, add \c{CONFIG += qmltestcase} to the project @@ -187,7 +187,7 @@ The \c .moc include is based on the file name of the \c .cpp file. For example, in the example above, the \c .cpp file is named - \c tst_mytest.cpp. If the file was named \c MyTest.cpp, the include would + \c src_qmltest_qquicktest.cpp. If the file was named \c MyTest.cpp, the include would be: \code diff --git a/src/qmltest/doc/src/qtquicktest.qdoc b/src/qmltest/doc/src/qtquicktest.qdoc index 31c097ed76..13e8144659 100644 --- a/src/qmltest/doc/src/qtquicktest.qdoc +++ b/src/qmltest/doc/src/qtquicktest.qdoc @@ -47,7 +47,7 @@ \brief Sets up the entry point for a Qt Quick Test application. The \a name argument uniquely identifies this set of tests. - \snippet src_qmltest_qquicktest.cpp 1 + \snippet src_qmltest_qquicktest_snippet.cpp 1 \note The macro assumes that your test sources are in the current directory, unless the \c QUICK_TEST_SOURCE_DIR environment variable is set. -- cgit v1.2.3