Doc: Fix a number of documentation issues

This change fixes a number of documentation issues:
    - Rename index.html landing page (collides with Qt docs)
    - Fix navigation
    - Create Enginio QML module page to get correct documentation
      for import statement, fix linking for QML types
    - Fix subtopics for generated QCH files
    - Remove unused pages and files
    - Update documentation namespaces and URLs
    - Other minor fixes

Change-Id: I0a87ab6d0be7df53199e54f4ecd9f84ef30d8622
Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@digia.com>

13 files changed, 46 insertions, 115 deletions

diff --git a/doc/enginio_global.qdocconf b/doc/enginio_global.qdocconf
index e4b0c01..62c7f63 100644
--- a/doc/enginio_global.qdocconf
+++ b/doc/enginio_global.qdocconf
@@ -1,2 +1,2 @@
-navigation.homepage = "Enginio $QT_VER"
+navigation.homepage = "Enginio Manual"
 buildversion = "Enginio $QT_VERSION Reference Documentation"
\ No newline at end of file
diff --git a/doc/enginio_overview.qdoc b/doc/enginio_overview.qdoc
index 6ae91ff..1169f72 100644
--- a/doc/enginio_overview.qdoc
+++ b/doc/enginio_overview.qdoc
@@ -26,10 +26,8 @@
 ****************************************************************************/
 
 /*!
-\page index.html
-\contentspage {Enginio Manual}{Contents}
-\indexpage Enginio Manual
-\startpage Enginio Manual
+\page enginio-index.html
+\contentspage {enginio-index.html}{Contents}
 \nextpage Enginio Installation and Prerequisites
 
 \title Enginio Manual
@@ -106,10 +104,9 @@ The entire Enginio documentation including backend and client is available here:
 */
 
 /*!
-\page enginio-getting-started
-\indexpage Enginio Manual
+\page enginio-getting-started.html
 \nextpage Getting Started with Enginio using Qt Quick
-\previouspage Enginio Manual
+\previouspage {enginio-index.html}{Enginio Manual}
 
 \title Enginio Installation and Prerequisites
 
@@ -120,17 +117,15 @@ This guide can be also applied when integrating Enginio with existing Qt project
 \section1 Prerequisites
 
 Enginio comes with Qt 5.2 and later (for 5.2.0 only in the online installer).
-Make sure to select the Enginio component in the \tt{Qt Cloud Services} category.
+Make sure to select the Enginio component in the \e {Qt Cloud Services} category.
 
-\note Make sure to have OpenSSL installed for Enginio to work.
-
-On iOS openSSL is not required since the native SSL framework is used.
+\note Make sure to have OpenSSL installed for Enginio to work. On iOS, OpenSSL is not
+required as the native SSL framework is used.
 
 */
 
 /*!
-\page enginio-qml
-\indexpage Enginio Manual
+\page enginio-qml.html
 \nextpage Getting Started with Enginio using C++
 \previouspage Enginio Installation and Prerequisites
 
@@ -183,8 +178,7 @@ Now you can \l{Checking stored objects in the Dashboard}{check the Enginio dashb
 
 
 /*!
-\page enginio-cpp
-\indexpage Enginio Manual
+\page enginio-cpp.html
 \nextpage Checking stored objects in the Dashboard
 \previouspage Getting Started with Enginio using Qt Quick
 
@@ -226,12 +220,12 @@ Create an object in JSON format and fill in the data:
     city.insert("population", 624000);
 \endcode
 
-Create the object in the Enginio database by calling \l{EnginioClient::create()}:
+Create the object in the Enginio database by calling \l{EnginioClient}{EnginioClient::create()}:
 \code
     client->create(city);
     connect(client, SIGNAL(finished(EnginioReply*)), this, SLOT(uploadFinished(EnginioReply*)));
 \endcode
-Note that the \l{EnginioClient::create()}{create()} method performs the actual asynchronous network communication.
+Note that the \c create() method performs the actual asynchronous network communication.
 You need to wait for its completion by connecting to the \l{EnginioClient::finished()}{finished} and \l{EnginioClient::error()}{error} signals.
 
 Now you can \l{Checking stored objects in the Dashboard}{check the Enginio dashboard} for the newly created object.
@@ -241,7 +235,6 @@ Now you can \l{Checking stored objects in the Dashboard}{check the Enginio dashb
 /*!
 \page enginio-dashboard.html
 \title Checking Stored Objects in the Dashboard
-\indexpage Enginio Manual
 \previouspage Getting Started with Enginio using C++
 
 When you have successfully stored objects with Qt C++ or QML code, go to your \l{https://dashboard.engin.io/}{Enginio Dashboard}
@@ -261,7 +254,6 @@ To get convenient access to objects stored in Enginio, consider using \l Enginio
 /*!
 \page tutorials.html
 \title Enginio Tutorials
-\indexpage Enginio Manual
 
 \list
 \li \l {Enginio Installation and Prerequisites}
@@ -270,21 +262,3 @@ To get convenient access to objects stored in Enginio, consider using \l Enginio
 \endlist
 */
 
-/*!
-\page enginio-classes.html
-\title Enginio C++ Classes
-\indexpage Enginio Manual
-
-Enginio provides these \b{C++ classes}:
-\generatelist {classesbymodule enginio-qt}
-*/
-
-/*!
-\page enginio-qml-types.html
-\title Enginio QML Types
-\indexpage Enginio Manual
-
-Enginio provides these \b{QML types}:
-\annotatedlist engino-qml
-*/
-
diff --git a/doc/qtenginiooverview.qdocconf b/doc/qtenginiooverview.qdocconf
index 3c8c701..638fa00 100644
--- a/doc/qtenginiooverview.qdocconf
+++ b/doc/qtenginiooverview.qdocconf
@@ -4,7 +4,7 @@ include(enginio_global.qdocconf)
 
 project = QtEnginioOverview
 description = Enginio Client Library
-url = http://engin.io
+url = http://qt-project.org/doc/qt-$QT_VER
 version = $QT_VERSION
 
 sourcedirs += .
@@ -17,7 +17,7 @@ depends += qtcore qtgui qtwidgets qtnetwork qtdoc qtenginio qtenginioqml
 qhp.projects            = QtEnginioOverview
 
 qhp.QtEnginioOverview.file                = qtenginiooverview.qhp
-qhp.QtEnginioOverview.namespace           = io.engin.overview.$QT_VERSION_TAG
+qhp.QtEnginioOverview.namespace           = org.qt-project.qtenginiooverview.$QT_VERSION_TAG
 qhp.QtEnginioOverview.virtualFolder       = enginiooverview
 qhp.QtEnginioOverview.indexTitle          = Enginio Manual
 
@@ -25,8 +25,7 @@ qhp.QtEnginioOverview.filterAttributes    = enginio $QT_VERSION
 qhp.QtEnginioOverview.customFilters.Qt.name = Enginio $QT_VERSION
 qhp.QtEnginioOverview.customFilters.Qt.filterAttributes = enginio $QT_VERSION
 
-qhp.QtEnginioOverview.subprojects = manual
-qhp.QtEnginioOverview.subprojects.manual.title = Manual
+qhp.QtEnginioOverview.subprojects                   = manual
+qhp.QtEnginioOverview.subprojects.manual.title      = Enginio Manual
 qhp.QtEnginioOverview.subprojects.manual.indexTitle = Enginio Manual
-qhp.QtEnginioOverview.subprojects.manual.selectors = fake:page
-
+qhp.QtEnginioOverview.subprojects.manual.type       = manual
diff --git a/examples/enginio/quick/image-gallery/doc/src/image-gallery.qdoc b/examples/enginio/quick/image-gallery/doc/src/image-gallery.qdoc
index 7832203..418a724 100644
--- a/examples/enginio/quick/image-gallery/doc/src/image-gallery.qdoc
+++ b/examples/enginio/quick/image-gallery/doc/src/image-gallery.qdoc
@@ -64,7 +64,7 @@
 
     \section1 The example code
 
-    The first step is to set up the \l Enginio1::EnginioClient client.
+    The first step is to set up the \l Enginio::EnginioClient client.
     \snippet image-gallery/image-gallery.qml client
 
     The model gets initialized with the client declared above.
diff --git a/examples/enginio/quick/todos/doc/src/todos.qdoc b/examples/enginio/quick/todos/doc/src/todos.qdoc
index 2bdc91b..bbf9b1d 100644
--- a/examples/enginio/quick/todos/doc/src/todos.qdoc
+++ b/examples/enginio/quick/todos/doc/src/todos.qdoc
@@ -39,7 +39,7 @@
     In this simple schema the objects will only have two properties that are added
     to the default properties (such as creation date which always exists).
     A string "title" and a bool "completed". The object type will be created
-    when a call to create, or, in this case, a call to \l{Enginio1::EnginioModel::append()}{EnginioModel::append()} is made.
+    when a call to create, or, in this case, a call to \l{Enginio::EnginioModel::append()}{EnginioModel::append()} is made.
 
     A todo object will look like this (in JSON):
     \code
@@ -52,7 +52,7 @@
     The example uses Qt Quick Controls, Layouts, and Enginio.
     \snippet todos/todo.qml imports
 
-    The first step is to create an \l{Enginio1::EnginioModel} and
+    The first step is to create an \l{Enginio::EnginioModel} and
     the Enginio instance with the backend configuration.
     To get nice debug output in case something goes wrong, the onError signal in
     Enginio is handled. Since the error is a JSON object, JSON.stringify is used
@@ -75,7 +75,7 @@
     boolean is used to display the item with a strikeout font and a light color.
     \snippet todos/todo.qml delegate-properties
 
-    The \l Enginio1::EnginioModel::setProperty() function is called to update the data in the Enginio backend.
+    The \l Enginio::EnginioModel::setProperty() function is called to update the data in the Enginio backend.
 
     \snippet todos/todo.qml setProperty
 
@@ -86,6 +86,6 @@
     \snippet todos/todo.qml sync
 
     Finally, a remove button is visible when hovering over an item with the mouse.
-    Removal is implemented by calling \l{Enginio1::EnginioModel::remove()}{EnginioModel::remove()} with the row of the item.
+    Removal is implemented by calling \l{Enginio::EnginioModel::remove()}{EnginioModel::remove()} with the row of the item.
     \snippet todos/todo.qml remove
 */
diff --git a/examples/enginio/quick/users/doc/src/users.qdoc b/examples/enginio/quick/users/doc/src/users.qdoc
index c735ad7..e93af16 100644
--- a/examples/enginio/quick/users/doc/src/users.qdoc
+++ b/examples/enginio/quick/users/doc/src/users.qdoc
@@ -65,17 +65,17 @@
     This example uses QtEnginio library together with QtQuickControls, therefore both have
     to be imported.
     \snippet users/Browse.qml imports
-    We will also use a common \l {Enginio1::EnginioClient}{EnginioClient} connection as shown here:
+    We will also use a common \l {Enginio::EnginioClient}{EnginioClient} connection as shown here:
     \snippet users/users.qml client
 
     The example is organized into separate tabs by using \l TabView. Each tab shows different
     functionality.
 
     \section1 Browsing users' data
-    The most convenient method to browse users is to use \l{Enginio1::EnginioModel}{EnginioModel}. The model can
+    The most convenient method to browse users is to use \l{Enginio::EnginioModel}{EnginioModel}. The model can
     automatically download all data that we need. It is sufficient to set three properties:
-    \l{Enginio1::EnginioModel::client}{client}, \l{Enginio1::EnginioModel::query}{query}
-    and \l{Enginio1::EnginioModel::operation}{operation} as shown below:
+    \l{Enginio::EnginioModel::client}{client}, \l{Enginio::EnginioModel::query}{query}
+    and \l{Enginio::EnginioModel::operation}{operation} as shown below:
     \snippet users/Browse.qml browse
 
     The model is used directly by TableView, in which we define data that will be shown.
@@ -111,6 +111,6 @@
     by using the \l{EnginioClient::create}{create} function, as shown below:
     \snippet users/Register.qml create
 
-    We could also use the \l{Enginio1::EnginioModel::append}{EnginioModel::append} method in the browsing example
+    We could also use the \l{Enginio::EnginioModel::append}{EnginioModel::append} method in the browsing example
     to accomplish the same task.
 */
diff --git a/src/enginio_client/doc/qtenginio.qdocconf b/src/enginio_client/doc/qtenginio.qdocconf
index 50bc32b..b4f7f2b 100644
--- a/src/enginio_client/doc/qtenginio.qdocconf
+++ b/src/enginio_client/doc/qtenginio.qdocconf
@@ -4,7 +4,7 @@ include(../../../doc/enginio_global.qdocconf)
 
 project = QtEnginio
 description = Client library for Enginio
-url = http://engin.io
+url = http://qt-project.org/doc/qt-$QT_VER
 version = $QT_VERSION
 
 sourcedirs += ..  \
@@ -24,12 +24,12 @@ exampledirs += \
 # Specify example install dir under QT_INSTALL_EXAMPLES
 examplesinstallpath = enginio/widgets
 
-depends += qtcore qtgui qtwidgets qtnetwork
+depends += qtcore qtgui qtwidgets qtnetwork qtenginiooverview
 
 qhp.projects            = QtEnginio
 
 qhp.QtEnginio.file                = qtenginio.qhp
-qhp.QtEnginio.namespace           = io.engin.$QT_VERSION_TAG
+qhp.QtEnginio.namespace           = org.qt-project.qtenginio.$QT_VERSION_TAG
 qhp.QtEnginio.virtualFolder       = qtenginio
 qhp.QtEnginio.indexTitle          = Enginio C++ Classes and Examples
 qhp.QtEnginio.indexRoot           =
@@ -41,11 +41,13 @@ qhp.QtEnginio.customFilters.Qt.filterAttributes = qtenginio $QT_VERSION
 qhp.QtEnginio.subprojects         = classes examples
 
 qhp.QtEnginio.subprojects.classes.title = C++ Classes
-qhp.QtEnginio.subprojects.classes.indexTitle = Enginio C++ Classes
+qhp.QtEnginio.subprojects.classes.indexTitle = Enginio C++ Classes and Examples
 qhp.QtEnginio.subprojects.classes.selectors = class
 qhp.QtEnginio.subprojects.classes.sortPages = true
 
 qhp.QtEnginio.subprojects.examples.title = Examples
-qhp.QtEnginio.subprojects.examples.indexTitle = Enginio Examples
+qhp.QtEnginio.subprojects.examples.indexTitle = Enginio C++ Classes and Examples
 qhp.QtEnginio.subprojects.examples.selectors = fake:example
 qhp.QtEnginio.subprojects.examples.sortPages = true
+
+navigation.landingpage = "Enginio C++ Classes and Examples"
diff --git a/src/enginio_plugin/doc/qtenginioqml.qdocconf b/src/enginio_plugin/doc/qtenginioqml.qdocconf
index 5d3b091..135782a 100644
--- a/src/enginio_plugin/doc/qtenginioqml.qdocconf
+++ b/src/enginio_plugin/doc/qtenginioqml.qdocconf
@@ -4,7 +4,7 @@ include(../../../doc/enginio_global.qdocconf)
 
 project = QtEnginioQml
 description = Client library for Enginio from QML
-url = http://engin.io
+url = http://qt-project.org/doc/qt-$QT_VER
 version = $QT_VERSION
 
 sourcedirs += .. \
@@ -25,12 +25,12 @@ exampledirs += \
 # Specify example install dir under QT_INSTALL_EXAMPLES
 examplesinstallpath = enginio/quick
 
-depends += qtcore qtgui qtnetwork qtqml qtquick qtquickcontrols qtenginio
+depends += qtcore qtgui qtnetwork qtqml qtquick qtquickcontrols qtenginio qtenginiooverview
 
 qhp.projects            = QtEnginioQml
 
 qhp.QtEnginioQml.file                = qtenginioqml.qhp
-qhp.QtEnginioQml.namespace           = io.engin.qml.$QT_VERSION_TAG
+qhp.QtEnginioQml.namespace           = org.qt-project.qtenginioqml.$QT_VERSION_TAG
 qhp.QtEnginioQml.virtualFolder       = qtenginioqml
 qhp.QtEnginioQml.indexTitle          = Enginio QML Types and Examples
 qhp.QtEnginioQml.indexRoot           =
@@ -42,11 +42,13 @@ qhp.QtEnginioQml.customFilters.Qt.filterAttributes = qtenginio $QT_VERSION
 qhp.QtEnginioQml.subprojects         = qmltypes examples
 
 qhp.QtEnginioQml.subprojects.qmltypes.title = QML Types
-qhp.QtEnginioQml.subprojects.qmltypes.indexTitle = Enginio QML Types
+qhp.QtEnginioQml.subprojects.qmltypes.indexTitle = Enginio QML Types and Examples
 qhp.QtEnginioQml.subprojects.qmltypes.selectors = fake:qmlclass
 qhp.QtEnginioQml.subprojects.qmltypes.sortPages = true
 
 qhp.QtEnginioQml.subprojects.examples.title = Examples
-qhp.QtEnginioQml.subprojects.examples.indexTitle = Enginio Examples
+qhp.QtEnginioQml.subprojects.examples.indexTitle = Enginio QML Types and Examples
 qhp.QtEnginioQml.subprojects.examples.selectors = fake:example
 qhp.QtEnginioQml.subprojects.examples.sortPages = true
+
+navigation.landingpage               = "Enginio QML Types and Examples"
diff --git a/src/enginio_plugin/enginioplugin.cpp b/src/enginio_plugin/enginioplugin.cpp
index ab076a9..e41ea33 100644
--- a/src/enginio_plugin/enginioplugin.cpp
+++ b/src/enginio_plugin/enginioplugin.cpp
@@ -56,7 +56,7 @@
 QT_BEGIN_NAMESPACE
 
 /*!
- * \qmlmodule enginio-plugin
+ * \qmlmodule Enginio 1.0
  * \title Enginio QML Plugin
  * 
  * The Enginio QML plugin provides access to the Enginio service through a set of
diff --git a/src/enginio_plugin/enginioqmlclient.cpp b/src/enginio_plugin/enginioqmlclient.cpp
index b538be1..a68541d 100644
--- a/src/enginio_plugin/enginioqmlclient.cpp
+++ b/src/enginio_plugin/enginioqmlclient.cpp
@@ -57,7 +57,7 @@ QT_BEGIN_NAMESPACE
 /*!
   \qmltype EnginioClient
   \instantiates EnginioQmlClient
-  \inqmlmodule Enginio 1
+  \inqmlmodule Enginio
   \ingroup engino-qml
   \target EnginioClientQml
 
@@ -153,7 +153,7 @@ QT_BEGIN_NAMESPACE
 
 /*!
   \qmlmethod EnginioReply EnginioClient::update(QJSValue query, Operation operation)
-  \include client-remove.qdocinc
+  \include client-update.qdocinc
 
   \return an EnginioReply containing the status once it is finished.
 */
diff --git a/src/enginio_plugin/enginioqmlmodel.cpp b/src/enginio_plugin/enginioqmlmodel.cpp
index 8e60252..00a33c4 100644
--- a/src/enginio_plugin/enginioqmlmodel.cpp
+++ b/src/enginio_plugin/enginioqmlmodel.cpp
@@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE
 /*!
   \qmltype EnginioModel
   \instantiates EnginioQmlModel
-  \inqmlmodule Enginio 1
+  \inqmlmodule Enginio
   \ingroup engino-qml
 
   \brief Makes accessing collections of objects easy
diff --git a/src/enginio_plugin/enginioqmlreply.cpp b/src/enginio_plugin/enginioqmlreply.cpp
index 4e0bf0a..16201af 100644
--- a/src/enginio_plugin/enginioqmlreply.cpp
+++ b/src/enginio_plugin/enginioqmlreply.cpp
@@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE
 /*!
   \qmltype EnginioReply
   \instantiates EnginioQmlReply
-  \inqmlmodule Enginio 1
+  \inqmlmodule Enginio
   \ingroup engino-qml
   \target EnginioModelQml
 
diff --git a/src/qtenginio_overview.qdocconf b/src/qtenginio_overview.qdocconf
deleted file mode 100644
index d04a668..0000000
--- a/src/qtenginio_overview.qdocconf
+++ /dev/null
@@ -1,46 +0,0 @@
-include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
-
-project = qtenginio
-description = Client library for Enginio - Overview
-url = http://engin.io
-
-sourcedirs += ..
-headerdirs += ..
-
-imagedirs += images
-
-outputdir = ./html
-outputformats = HTML
-
-exampledirs += \
-               ../../../examples/enginio/widgets \
-               ../../../tests/auto \
-
-# Specify example install dir under QT_INSTALL_EXAMPLES
-examplesinstallpath = enginio/widgets
-
-depends += qtcore qtgui qtwidgets qtnetwork qtdoc qtenginio_plugin
-
-qhp.projects            = Enginio
-
-qhp.Enginio.file                = qtenginio.qhp
-qhp.Enginio.namespace           = io.engin.101
-qhp.Enginio.virtualFolder       = enginio
-qhp.Enginio.indexTitle          = Enginio Overview
-qhp.Enginio.indexRoot           =
-
-qhp.Enginio.filterAttributes    = enginio 1.0.1
-qhp.Enginio.customFilters.Qt.name = Enginio 1.0.1
-qhp.Enginio.customFilters.Qt.filterAttributes = enginio 1.0.1
-
-qhp.Enginio.subprojects         = classes examples
-
-qhp.Enginio.subprojects.classes.title = C++ Classes
-qhp.Enginio.subprojects.classes.indexTitle = Enginio C++ Classes
-qhp.Enginio.subprojects.classes.selectors = class
-qhp.Enginio.subprojects.classes.sortPages = true
-
-qhp.Enginio.subprojects.examples.title = Examples
-qhp.Enginio.subprojects.examples.indexTitle = Enginio Examples
-qhp.Enginio.subprojects.examples.selectors = fake:example
-qhp.Enginio.subprojects.examples.sortPages = true