Doc: Add documentation project for Qt Automotive Suite

Add structure for Qt Automotive Suite documentation set. This is
a high-level overview documentation that links to the rest of
the Automotive component documentation, including Qt IVI.

As part of the new structure, move Qt IVI documentation files
into doc/qtivi subfolder.

Change-Id: I83052ab6cd8cc95f90385e61326fecaeb2b374ec
Reviewed-by: Kalle Viironen <kalle.viironen@theqtcompany.com>
Reviewed-by: Dominik Holland <dominik.holland@pelagicore.com>
Reviewed-by: Johan Thelin <johan.thelin@pelagicore.com>

10 files changed, 312 insertions, 4 deletions

diff --git a/.gitignore b/.gitignore
index 3c46069..66223de 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,7 @@
 *Makefile
 *.pro.user
 *.moc
+*_wrapper.sh
 moc_*
 ui_*
 .build
diff --git a/src/doc/doc.pro b/src/doc/doc.pro
index 570cd71..e471cbb 100644
--- a/src/doc/doc.pro
+++ b/src/doc/doc.pro
@@ -1,3 +1,4 @@
-TEMPLATE = aux
+TEMPLATE = subdirs
 
-QMAKE_DOCS = $$PWD/qtivi.qdocconf
+SUBDIRS = qtivi \
+          qtautomotivesuite
diff --git a/src/doc/qtautomotivesuite/qtautomotivesuite.pro b/src/doc/qtautomotivesuite/qtautomotivesuite.pro
new file mode 100644
index 0000000..c98bf07
--- /dev/null
+++ b/src/doc/qtautomotivesuite/qtautomotivesuite.pro
@@ -0,0 +1,4 @@
+TEMPLATE = aux
+
+QMAKE_DOCS = $$PWD/qtautomotivesuite.qdocconf
+QMAKE_DOCS_OUTPUTDIR = $$OUT_PWD/qtautomotivesuite
diff --git a/src/doc/qtautomotivesuite/qtautomotivesuite.qdocconf b/src/doc/qtautomotivesuite/qtautomotivesuite.qdocconf
new file mode 100644
index 0000000..df7935c
--- /dev/null
+++ b/src/doc/qtautomotivesuite/qtautomotivesuite.qdocconf
@@ -0,0 +1,35 @@
+include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
+
+project                       = QtAutomotiveSuite
+description                   = Qt Automotive Suite Documentation
+version                       = 1.0.0
+
+sourcedirs                   += src
+
+qhp.projects                  = QtAutomotiveSuite
+
+qhp.QtAutomotiveSuite.file                = qtautomotivesuite.qhp
+qhp.QtAutomotiveSuite.namespace           = org.qt-project.qtautomotivesuite.100
+qhp.QtAutomotiveSuite.virtualFolder       = qtautomotivesuite
+qhp.QtAutomotiveSuite.indexTitle          = Qt Automotive Suite
+qhp.QtAutomotiveSuite.indexRoot           =
+
+qhp.QtAutomotiveSuite.filterAttributes    = qtautomotivesuite 1.0.0 qtrefdoc
+qhp.QtAutomotiveSuite.customFilters.Qt.name = QtAutomotiveSuite 1.0.0
+qhp.QtAutomotiveSuite.customFilters.Qt.filterAttributes = qtautomotivesuite 1.0.0
+
+qhp.QtAutomotiveSuite.subprojects                   = manual
+qhp.QtAutomotiveSuite.subprojects.manual.title      = Qt Automotive Suite
+qhp.QtAutomotiveSuite.subprojects.manual.indexTitle = Qt Automotive Suite
+qhp.QtAutomotiveSuite.subprojects.manual.selectors  = doc:page
+qhp.QtAutomotiveSuite.subprojects.manual.sortPages  = true
+
+tagfile                       = qtautomotivesuite.tags
+
+depends += qtdoc qtivi qtautomotiveota
+
+buildversion = "Qt Automotive Suite 1.0"
+
+macro.QAS = "Qt Automotive Suite"
+navigation.homepage = "Qt Automotive Suite"
+HTML.nosubdirs = "false"
diff --git a/src/doc/qtautomotivesuite/src/external-resources.qdoc b/src/doc/qtautomotivesuite/src/external-resources.qdoc
new file mode 100644
index 0000000..15ac7dd
--- /dev/null
+++ b/src/doc/qtautomotivesuite/src/external-resources.qdoc
@@ -0,0 +1,101 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Automotive Suite.
+**
+** $QT_BEGIN_LICENSE:FDL-QTAS$
+** Commercial License Usage
+** Licensees holding valid commercial Qt Automotive Suite 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.
+**
+** 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: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \externalpage http://www.genivi.org/
+    \title GENIVI
+*/
+
+/*!
+    \externalpage https://doc.qt.io/
+    \title Qt reference documentation
+*/
+
+/*!
+    \externalpage https://doc.qt.io/QtDataVisualization
+    \title Qt Data Visualization
+*/
+
+/*!
+    \externalpage https://doc.qt.io/QtVirtualKeyboard
+    \title Qt Virtual Keyboard
+*/
+
+/*!
+    \externalpage https://doc.qt.io/QtCharts
+    \title Qt Charts
+*/
+
+/*!
+    \externalpage https://doc.qt.io/QtQuickCompiler
+    \title Qt Quick Compiler
+*/
+
+/*!
+    \externalpage https://doc.qt.io/qt-5/qtwebengine-index.html
+    \title Qt WebEngine
+*/
+
+/*!
+    \externalpage https://doc.qt.io/qt-5/qtquick-index.html
+    \title Qt Quick
+*/
+
+/*!
+    \externalpage https://doc.qt.io/qtcreator/
+    \title Qt Creator
+*/
+
+/*!
+    \externalpage https://www.kdab.com/gammaray/
+    \title GammaRay
+*/
+
+/*!
+    \externalpage https://doc.qt.io/QtWebBrowser/
+    \title Qt Web Browser
+*/
+
+/*!
+    \externalpage https://doc.qt.io/qt-5/qtquickcontrols2-index.html
+    \title Qt Quick Controls 2
+*/
+
+/*!
+    \externalpage https://doc.qt.io/qtcreator/creator-visual-editor.html
+    \title Qt Creator: Developing Qt Quick Applications
+*/
+
+/*!
+    \externalpage https://doc.qt.io/qtcreator/creator-analyze-mode.html
+    \title Qt Creator: Analyzing Code
+*/
+
+/*!
+    \externalpage https://doc.qt.io/qtcreator/creator-debugging.html
+    \title Qt Creator: Debugging
+*/
diff --git a/src/doc/qtautomotivesuite/src/qtautomotivesuite.qdoc b/src/doc/qtautomotivesuite/src/qtautomotivesuite.qdoc
new file mode 100644
index 0000000..c52ba53
--- /dev/null
+++ b/src/doc/qtautomotivesuite/src/qtautomotivesuite.qdoc
@@ -0,0 +1,163 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Automotive Suite.
+**
+** $QT_BEGIN_LICENSE:FDL-QTAS$
+** Commercial License Usage
+** Licensees holding valid commercial Qt Automotive Suite 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.
+**
+** 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: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \page qtautomotivesuite-index.html
+    \title Qt Automotive Suite
+
+    \e {\QAS} is a collection of software components and tools to enable
+    development of \e In-Vehicle-Infotainment (IVI) systems. Built on top
+    of the Qt framework and compliant with the \l GENIVI automotive platform
+    architecture, \QAS includes an embedded development environment with
+    additional tools for rapid UI development, as well as application
+    introspection and debugging.
+
+    \QAS comes with libraries and ready-made components, as well as hardware
+    adaptation APIs for creating full-featured IVI solutions. In addition,
+    it includes a reference UI for embedded platforms, and reference
+    IVI applications and application store implementations.
+
+    \section1 Contents
+
+    \list
+        \li \l {Qt Automotive Suite Overview}{Overview}
+        \li \l {Installing Qt Automotive Suite}
+        \li \l {Reference Device Images}
+        \li \l {Related Information}
+    \endlist
+
+    \section1 Installing \QAS
+
+    \section1 Reference Device Images
+
+    \section1 Related Information
+*/
+
+/*!
+    \page qtas-overview.html
+    \title Qt Automotive Suite Overview
+
+    \section1 Components
+
+    \QAS includes several components built on Qt and the \l {Qt Creator}
+    integrated development environment.
+
+    \section2 Qt
+
+    Cross-platform \l {http://www.qt.io/}{Qt} development libraries (Qt 5.7)
+    and core tools, developed through an open-source collaboration model.
+    Qt is a full development framework designed to streamline the creation of
+    applications and user interfaces for desktop, embedded, and mobile
+    platforms.
+
+    The Qt libraries provide high-level APIs for a large variety of both
+    non-GUI and GUI related functionality. For UI creation, Qt provides a
+    number of approaches: traditional C++, declarative UI design with
+    \l {Qt Quick} or HTML5/hybrid user interfaces with the \l {Qt WebEngine}
+    module.
+
+    For overview about Qt libraries see the \l {Qt reference documentation}.
+
+    Qt modules that are especially useful for embedded/IVI application
+    development include:
+
+    \list
+        \li \l {Qt Virtual Keyboard} - complete virtual keyboard solution with
+            word-prediction and multiple languages supported.
+        \li \l {Qt Quick Controls 2} - provides a set of controls for building
+            complete user interfaces in Qt Quick.
+        \li \l {Qt Quick Compiler} - enables compiling .qml source files into
+            application binaries, improving load times and security for code
+            assets.
+        \li \l {Qt Charts} - UI Components for displaying visually pleasing
+            charts, driven by static or dynamic data models.
+        \li \l {Qt Data Visualization} - UI Components for creating stunning 3D
+            data visualizations.
+        \li \l {Qt WebEngine} - provides a web browser engine based on the
+            \l {http://www.chromium.org}{Chromium} project.
+    \endlist
+
+    \section2 Development Environment
+
+    The development environment in \QAS is built around \l {Qt Creator}.
+
+    \list
+      \li \l {Qt Creator: Developing Qt Quick Applications}
+      \li \l {Qt Creator: Analyzing Code}
+      \li \l {Qt Creator: Debugging}
+    \endlist
+
+    \QAS comes with additional functionality for diagnostics and debugging,
+    as well as deployment:
+
+    \section3 GammaRay
+
+    GammaRay is a plugin for Qt Creator that provides software introspection
+    for Qt applications. It allows visualization of application behavior and
+    manipulating it at run-time, both locally and remotely on an embedded
+    target.
+
+    \section3 QmlLive
+
+    \e QmlLive provides a live reloader environment for rapid development of
+    Qt Quick applications, dramatically reducing the time it takes to
+    deploy and test changes in the UI design.
+
+    \section3 Deployment
+
+    Device deployment can be done directly from the Qt Creator IDE to a
+    device connected via USB or local area network, or to an emulator
+    running the same, full software stack as the devices.
+
+    As with any Qt application, the same project can be deployed to
+    desktop or mobile targets as well.
+
+    \section2 Automotive APIs
+
+    The \l {Qt IVI} module provides C++ and QML interfaces for accessing
+    vehicle features, and also enables implementing new IVI features.
+
+    \section2 Qt Application Manager
+
+    \e {Qt Application Manager} provides application lifecycle management.
+
+    \section2 Reference Applications
+
+    \QAS includes \l Neptune, a reference UI designed for IVI systems, including
+    multiple IVI applications and an application store implementation.
+
+    \section3 Web Browser
+
+    \l {Qt Web Browser} is a browser designed for embedded devices, based on
+    \l {Qt WebEngine}, with a slick, touch-friendly user interface.
+
+    \section2 Over-The-Air Updates
+
+    \QAS comes with \l {Over-The-Air Update}{Over-The-Air} (OTA) package, proviving
+    tools that assist in enabling distribution of software updates in embedded
+    Linux devices over wireless networks.
+*/
diff --git a/src/doc/qtivi/qtivi.pro b/src/doc/qtivi/qtivi.pro
new file mode 100644
index 0000000..570cd71
--- /dev/null
+++ b/src/doc/qtivi/qtivi.pro
@@ -0,0 +1,3 @@
+TEMPLATE = aux
+
+QMAKE_DOCS = $$PWD/qtivi.qdocconf
diff --git a/src/doc/qtivi.qdocconf b/src/doc/qtivi/qtivi.qdocconf
index 9cf283d..9c02fea 100644
--- a/src/doc/qtivi.qdocconf
+++ b/src/doc/qtivi/qtivi.qdocconf
@@ -8,8 +8,8 @@ sourcedirs                   += .
 headerdirs                   += .
 
 # include sub-modules' sources and headers
-include(../ivicore/doc/qtivicore.qdocconf)
-include(../ivivehiclefunctions/doc/qtivivehiclefunctions.qdocconf)
+include(../../ivicore/doc/qtivicore.qdocconf)
+include(../../ivivehiclefunctions/doc/qtivivehiclefunctions.qdocconf)
 
 qhp.projects                  = QtIvi
 
diff --git a/src/doc/src/qtivi-modules.qdoc b/src/doc/qtivi/src/qtivi-modules.qdoc
index 3498531..3498531 100644
--- a/src/doc/src/qtivi-modules.qdoc
+++ b/src/doc/qtivi/src/qtivi-modules.qdoc
diff --git a/src/doc/src/qtivi.qdoc b/src/doc/qtivi/src/qtivi.qdoc
index 0ce2674..0ce2674 100644
--- a/src/doc/src/qtivi.qdoc
+++ b/src/doc/qtivi/src/qtivi.qdoc