Extras: add documentation skeleton.

Change-Id: I31da59c893681455ab276c6ef3bf8a44bfa27f29
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>

5 files changed, 183 insertions, 0 deletions

diff --git a/src/extras/doc/qtquickextras2.qdocconf b/src/extras/doc/qtquickextras2.qdocconf
new file mode 100644
index 00000000..b97288ce
--- /dev/null
+++ b/src/extras/doc/qtquickextras2.qdocconf
@@ -0,0 +1,42 @@
+include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
+
+project                 = QtQuickExtras2
+description             = Qt Quick Extras 2 Reference Documentation
+version                 = $QT_VERSION
+
+qhp.projects            = QtQuickExtras2
+
+qhp.QtQuickExtras2.file          = qtquickextras2.qhp
+qhp.QtQuickExtras2.namespace     = org.qt-project.qtquickextras2.$QT_VERSION_TAG
+qhp.QtQuickExtras2.virtualFolder = qtquickextras2
+qhp.QtQuickExtras2.indexTitle    = Qt Quick Extras 2
+qhp.QtQuickExtras2.indexRoot     =
+
+qhp.QtQuickExtras2.filterAttributes                  = qtquickextras2 $QT_VERSION qtrefdoc
+qhp.QtQuickExtras2.customFilters.Qt.name             = QtQuickExtras2 $QT_VERSION
+qhp.QtQuickExtras2.customFilters.Qt.filterAttributes = qtquickextras2 $QT_VERSION
+
+qhp.QtQuickExtras2.subprojects = qtquickextras2qmltypes
+
+qhp.QtQuickExtras2.subprojects.qtquickextras2qmltypes.title      = Extras 2 QML Types
+qhp.QtQuickExtras2.subprojects.qtquickextras2qmltypes.indexTitle = Qt Quick Extras 2 QML Types
+qhp.QtQuickExtras2.subprojects.qtquickextras2qmltypes.selectors  = qmlclass
+qhp.QtQuickExtras2.subprojects.qtquickextras2qmltypes.sortPages  = true
+
+depends = qtcore qtgui qtdoc qtqml qtquick qtquicklayouts qtquickdialogs qtquickcontrols2
+
+# Specify the install path under QT_INSTALL_EXAMPLES
+# Examples will be installed under quick/extras - 'extras' subdirectory
+# is given as part of \example commands
+exampledirs += ../../../examples/quick/extras
+examplesinstallpath = quick/extras2
+
+headerdirs += ../
+sourcedirs += ../
+
+imagedirs += images
+
+navigation.landingpage  = "Qt Quick Extras 2"
+navigation.qmltypespage = "Qt Quick Extras 2 QML Types"
+
+tagfile                 = qtquickextras2.tags
diff --git a/src/extras/doc/src/qtquickextras2-index.qdoc b/src/extras/doc/src/qtquickextras2-index.qdoc
new file mode 100644
index 00000000..53712e22
--- /dev/null
+++ b/src/extras/doc/src/qtquickextras2-index.qdoc
@@ -0,0 +1,49 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** 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 The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/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 qtquickextras2-index.html
+    \title Qt Quick Extras 2
+
+    \brief The Qt Quick Extras 2 module provides a set of specialized UI
+    controls for Qt Quick.
+
+    The Qt Quick Extras 2 module provides a set of controls that can be used to
+    build interfaces in Qt Quick.
+
+    The module is new in Qt 5.6.
+
+    Visit the \l{Qt Quick Extras 2 Overview} page to get started.
+
+    \section1 Related Information
+
+    \list
+      \li \l{Qt Quick}
+      \li \l{Qt Quick Extras 2 Overview}
+      \li \l{Qt Quick Extras 2 QML Types}{Qt Quick Extras 2 QML Types}
+    \endlist
+*/
diff --git a/src/extras/doc/src/qtquickextras2-overview.qdoc b/src/extras/doc/src/qtquickextras2-overview.qdoc
new file mode 100644
index 00000000..739086ad
--- /dev/null
+++ b/src/extras/doc/src/qtquickextras2-overview.qdoc
@@ -0,0 +1,46 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** 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 The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/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 qtquickextras2-overview.html
+    \title Qt Quick Extras 2 Overview
+    \brief A set of UI controls to create user interfaces in Qt Quick
+
+    The Qt Quick Extras 2 module provides a set of UI controls to create user
+    interfaces in Qt Quick.
+
+    \section1 Getting Started
+
+    TODO
+
+    \section1 Related Information
+
+     \list
+       \li \l{Qt Quick}
+       \li \l{Qt Quick Controls 2}
+    \endlist
+*/
diff --git a/src/extras/doc/src/qtquickextras2.qdoc b/src/extras/doc/src/qtquickextras2.qdoc
new file mode 100644
index 00000000..74dbd778
--- /dev/null
+++ b/src/extras/doc/src/qtquickextras2.qdoc
@@ -0,0 +1,44 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** 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 The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/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$
+**
+****************************************************************************/
+
+/*!
+    \qmlmodule QtQuick.Extras 2.0
+    \title Qt Quick Extras 2 QML Types
+    \ingroup qmlmodules
+    \brief Provides QML types for user interfaces.
+
+    The \l{Qt Quick Extras 2} module provides QML types for creating user
+    interfaces. These QML types work in conjunction with \l{Qt Quick},
+    \l{Qt Quick Layouts} and \l{Qt Quick Controls 2}.
+
+    The QML types can be imported into your application using the
+    following import statement in your .qml file.
+
+    \badcode
+    import QtQuick.Extras 2.0
+    \endcode
+*/
diff --git a/src/extras/extras.pro b/src/extras/extras.pro
index c1e697e3..49a82277 100644
--- a/src/extras/extras.pro
+++ b/src/extras/extras.pro
@@ -7,6 +7,8 @@ QT += core-private gui-private qml-private quick-private quickcontrols2-private
 
 DEFINES += QT_NO_CAST_TO_ASCII QT_NO_CAST_FROM_ASCII
 
+QMAKE_DOCS = $$PWD/doc/qtquickextras2.qdocconf
+
 HEADERS += \
     $$PWD/qtquickextrasglobal_p.h