summaryrefslogtreecommitdiffstats
path: root/src/multimediawidgets/doc
diff options
context:
space:
mode:
authorVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2018-06-14 12:18:38 +0200
committerVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2018-06-21 11:13:27 +0000
commitbc8f1704fcbeb07fe88970521301c57f33d0ca5f (patch)
treeb273a2ec04171fd098ef8cc2ab6a7ae622855bc5 /src/multimediawidgets/doc
parent91bab737cbb1b50e89856a3061cbdb2d53af1e23 (diff)
Doc: Move the literal codeblocks to snippet files
Change-Id: Icd9dff16b807d0bc7143a3d41f9799432035fa54 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Diffstat (limited to 'src/multimediawidgets/doc')
-rw-r--r--src/multimediawidgets/doc/snippets/doc_src_qtmultimediawidgets.cpp53
-rw-r--r--src/multimediawidgets/doc/snippets/doc_src_qtmultimediawidgets.pro3
-rw-r--r--src/multimediawidgets/doc/src/qtmultimediawidgets.qdoc9
3 files changed, 59 insertions, 6 deletions
diff --git a/src/multimediawidgets/doc/snippets/doc_src_qtmultimediawidgets.cpp b/src/multimediawidgets/doc/snippets/doc_src_qtmultimediawidgets.cpp
new file mode 100644
index 000000000..0598cfab9
--- /dev/null
+++ b/src/multimediawidgets/doc/snippets/doc_src_qtmultimediawidgets.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 <QtMultimediaWidgets>
+//! [0]
diff --git a/src/multimediawidgets/doc/snippets/doc_src_qtmultimediawidgets.pro b/src/multimediawidgets/doc/snippets/doc_src_qtmultimediawidgets.pro
new file mode 100644
index 000000000..29c3e9cae
--- /dev/null
+++ b/src/multimediawidgets/doc/snippets/doc_src_qtmultimediawidgets.pro
@@ -0,0 +1,3 @@
+#! [0]
+QT += multimediawidgets
+#! [0]
diff --git a/src/multimediawidgets/doc/src/qtmultimediawidgets.qdoc b/src/multimediawidgets/doc/src/qtmultimediawidgets.qdoc
index 691d66838..d7964c557 100644
--- a/src/multimediawidgets/doc/src/qtmultimediawidgets.qdoc
+++ b/src/multimediawidgets/doc/src/qtmultimediawidgets.qdoc
@@ -35,14 +35,11 @@ These classes are part of the \l{Qt Multimedia Widgets} module.
To enable Qt Multimedia Widgets in a project, add this directive into the
C++ files:
-\code
-#include <QtMultimediaWidgets>
-\endcode
+
+\snippet doc_src_qtmultimediawidgets.cpp 0
To link against the C++ libraries, add the following to your \c qmake project
file:
-\code
-QT += multimediawidgets
-\endcode
+\snippet doc_src_qtmultimediawidgets.pro 0
*/