Commit bc8f1704 authored by Venugopal Shivashankar's avatar Venugopal Shivashankar
Browse files

Doc: Move the literal codeblocks to snippet files


Change-Id: Icd9dff16b807d0bc7143a3d41f9799432035fa54
Reviewed-by: default avatarTopi Reiniö <topi.reinio@qt.io>
parent 91bab737
No related merge requests found
Showing with 127 additions and 7 deletions
...@@ -44,7 +44,8 @@ qhp.QtMultimedia.subprojects.examples.selectors = doc:example ...@@ -44,7 +44,8 @@ qhp.QtMultimedia.subprojects.examples.selectors = doc:example
qhp.QtMultimedia.subprojects.examples.sortPages = true qhp.QtMultimedia.subprojects.examples.sortPages = true
exampledirs += ../../../examples \ exampledirs += ../../../examples \
snippets snippets \
../../multimediawidgets/doc/snippets
manifestmeta.highlighted.names = "QtMultimedia/QML Video Shader Effects Example" \ manifestmeta.highlighted.names = "QtMultimedia/QML Video Shader Effects Example" \
"QtMultimedia/Media Player Example" "QtMultimedia/Media Player Example"
......
/****************************************************************************
**
** 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 <QtMultimedia>
//! [0]
#! [0]
QT += multimedia
#! [0]
...@@ -33,6 +33,16 @@ ...@@ -33,6 +33,16 @@
\brief The \l {Qt Multimedia} module provides audio, video, radio and camera \brief The \l {Qt Multimedia} module provides audio, video, radio and camera
functionality. functionality.
To enable Qt Multimedia in a project, add this directive into the
C++ files:
\snippet doc_src_qtmultimedia.cpp 0
To link against the C++ libraries, add the following to your \c qmake project
file:
\snippet doc_src_qtmultimedia.pro 0
*/ */
/*! /*!
......
/****************************************************************************
**
** 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]
#! [0]
QT += multimediawidgets
#! [0]
...@@ -35,14 +35,11 @@ These classes are part of the \l{Qt Multimedia Widgets} module. ...@@ -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 To enable Qt Multimedia Widgets in a project, add this directive into the
C++ files: C++ files:
\code
#include <QtMultimediaWidgets> \snippet doc_src_qtmultimediawidgets.cpp 0
\endcode
To link against the C++ libraries, add the following to your \c qmake project To link against the C++ libraries, add the following to your \c qmake project
file: file:
\code
QT += multimediawidgets
\endcode
\snippet doc_src_qtmultimediawidgets.pro 0
*/ */
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment