diff options
author | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2018-06-14 12:04:54 +0200 |
---|---|---|
committer | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2018-06-22 14:34:27 +0000 |
commit | 17ec45ad2f257dc4f1ee9cc18782f0d305b1a1d3 (patch) | |
tree | d0a121abc130373b8c1a3c5e68dd7c54ea1c0463 /src/qml | |
parent | 9fd90b04a33293bac4d840e1f2e10f9c42b3ec13 (diff) |
Doc: Move literal codeblocks to snippet files
Change-Id: Iff45ea6cf414717fd1cb0a194eef390a9f153838
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'src/qml')
-rw-r--r-- | src/qml/doc/snippets/code/doc_src_qtqml.cpp | 53 | ||||
-rw-r--r-- | src/qml/doc/snippets/code/doc_src_qtqml.pro | 3 | ||||
-rw-r--r-- | src/qml/doc/src/qtqml-cpp.qdoc | 8 |
3 files changed, 58 insertions, 6 deletions
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 <QtQml> +//! [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 <QtQml> -\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. |