From 17ec45ad2f257dc4f1ee9cc18782f0d305b1a1d3 Mon Sep 17 00:00:00 2001 From: Venugopal Shivashankar Date: Thu, 14 Jun 2018 12:04:54 +0200 Subject: Doc: Move literal codeblocks to snippet files MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: Iff45ea6cf414717fd1cb0a194eef390a9f153838 Reviewed-by: Topi Reiniö --- src/qml/doc/snippets/code/doc_src_qtqml.cpp | 53 +++++++++++++++++++++++++ src/qml/doc/snippets/code/doc_src_qtqml.pro | 3 ++ src/qml/doc/src/qtqml-cpp.qdoc | 8 +--- src/quick/doc/snippets/code/doc_src_qtquick.cpp | 53 +++++++++++++++++++++++++ src/quick/doc/snippets/code/doc_src_qtquick.pro | 3 ++ src/quick/doc/src/qtquick-cpp.qdoc | 8 +--- 6 files changed, 116 insertions(+), 12 deletions(-) create mode 100644 src/qml/doc/snippets/code/doc_src_qtqml.cpp create mode 100644 src/qml/doc/snippets/code/doc_src_qtqml.pro create mode 100644 src/quick/doc/snippets/code/doc_src_qtquick.cpp create mode 100644 src/quick/doc/snippets/code/doc_src_qtquick.pro (limited to 'src') diff --git a/src/qml/doc/snippets/code/doc_src_qtqml.cpp b/src/qml/doc/snippets/code/doc_src_qtqml.cpp new file mode 100644 index 0000000000..745e2f8f94 --- /dev/null +++ b/src/qml/doc/snippets/code/doc_src_qtqml.cpp @@ -0,0 +1,53 @@ +/**************************************************************************** +** +** Copyright (C) 2018 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$ +** +****************************************************************************/ + +//! [0] +#include +//! [0] diff --git a/src/qml/doc/snippets/code/doc_src_qtqml.pro b/src/qml/doc/snippets/code/doc_src_qtqml.pro new file mode 100644 index 0000000000..48dc3ebf6c --- /dev/null +++ b/src/qml/doc/snippets/code/doc_src_qtqml.pro @@ -0,0 +1,3 @@ +#! [0] +QT += qml +#! [0] diff --git a/src/qml/doc/src/qtqml-cpp.qdoc b/src/qml/doc/src/qtqml-cpp.qdoc index 14c9a87ab4..971bb88825 100644 --- a/src/qml/doc/src/qtqml-cpp.qdoc +++ b/src/qml/doc/src/qtqml-cpp.qdoc @@ -34,16 +34,12 @@ To include the definitions of the module's classes, use the following directive: -\code -#include -\endcode +\snippet code/doc_src_qtqml.cpp 0 To link against the module, add this line to your \l qmake \c .pro file: -\code -QT += qml -\endcode +\snippet code/doc_src_qtqml.pro 0 For more information on the Qt QML module, see the \l{Qt QML} module documentation. diff --git a/src/quick/doc/snippets/code/doc_src_qtquick.cpp b/src/quick/doc/snippets/code/doc_src_qtquick.cpp new file mode 100644 index 0000000000..0e9b2a2196 --- /dev/null +++ b/src/quick/doc/snippets/code/doc_src_qtquick.cpp @@ -0,0 +1,53 @@ +/**************************************************************************** +** +** Copyright (C) 2018 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$ +** +****************************************************************************/ + +//! [0] +#include +//! [0] diff --git a/src/quick/doc/snippets/code/doc_src_qtquick.pro b/src/quick/doc/snippets/code/doc_src_qtquick.pro new file mode 100644 index 0000000000..bdd4cd9a9c --- /dev/null +++ b/src/quick/doc/snippets/code/doc_src_qtquick.pro @@ -0,0 +1,3 @@ +#! [0] +QT += quick +#! [0] diff --git a/src/quick/doc/src/qtquick-cpp.qdoc b/src/quick/doc/src/qtquick-cpp.qdoc index 1a4eda6d2f..ca6fe3d0c0 100644 --- a/src/quick/doc/src/qtquick-cpp.qdoc +++ b/src/quick/doc/src/qtquick-cpp.qdoc @@ -36,16 +36,12 @@ To include the definitions of the module's classes, use the following directive: - \code - #include - \endcode + \snippet code/doc_src_qtquick.cpp 0 To link against the module, add this line to your \l qmake \c .pro file: - \code - QT += quick - \endcode + \snippet code/doc_src_qtquick.pro 0 For more information on the Qt Quick module, see the \l{Qt Quick} module documentation. -- cgit v1.2.3