summaryrefslogtreecommitdiffstats
path: root/src/multimediawidgets/doc/src/qtmultimediawidgets-index.qdoc
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2013-02-25 13:58:21 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-02-26 01:31:48 +0100
commitf641bda2e72d943dcd6953d76a23426bc0a539ac (patch)
tree75f404f1842c6e5e681016f329d85d0f0d96a753 /src/multimediawidgets/doc/src/qtmultimediawidgets-index.qdoc
parentfb6e49f33fab1046aa234be4994219719a3963a8 (diff)
Doc: Adding Qt Multimedia Widgets documentation.
-added landing page and module page -linked to Qt Multimedia and Qt Widgets -excluded multimediawidgets dir from the Qt Multimedia documentation Task-number: QTBUG-29339 Change-Id: Iaa8dc4117505d5635b8cab97ed5c10e9c4a289e6 Reviewed-by: Lars Knoll <lars.knoll@digia.com> Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com>
Diffstat (limited to 'src/multimediawidgets/doc/src/qtmultimediawidgets-index.qdoc')
-rw-r--r--src/multimediawidgets/doc/src/qtmultimediawidgets-index.qdoc67
1 files changed, 67 insertions, 0 deletions
diff --git a/src/multimediawidgets/doc/src/qtmultimediawidgets-index.qdoc b/src/multimediawidgets/doc/src/qtmultimediawidgets-index.qdoc
new file mode 100644
index 000000000..07fa63205
--- /dev/null
+++ b/src/multimediawidgets/doc/src/qtmultimediawidgets-index.qdoc
@@ -0,0 +1,67 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** 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 Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\page qtmultimediawidgets-index.html
+\title Qt Multimedia Widgets
+\brief An essential module which provides multimedia-related widgets.
+
+Qt Multimedia Widgets provides additional multimedia-related widgets and
+controls. The classes expand the capabilities of the \l{Qt Multimedia} and
+\l{Qt Widgets} modules.
+
+\section1 Getting Started
+
+To enable Qt Multimedia Widgets in a project, add this directive into the
+C++ files:
+\code
+#include <QtMultimediaWidgets>
+\endcode
+
+To link against the C++ libraries, add the following to your \c qmake project
+file:
+\code
+QT += multimediawidgets
+\endcode
+
+\section1 Related Information
+
+\section2 Reference
+\list
+\li \l{Qt Multimedia Widgets C++ Classes}{C++ Classes}
+\endlist
+
+\section2 Examples
+\list
+\li \l{QML Camera Example}
+\li \l{Camera Example}
+\li \l{Media Player Example}
+\li \l{Video Graphics Item Example}
+\li \l{Video Widget Example}
+\endlist
+
+*/