Doc: Use standard documentation structure for the module

- Link to separate QML types and C++ classes topics from front page
  (instead of listing the types there)
- Turn the \page topic that lists all QML types into the \qmlmodule
  topic for the module
- Add a \module topic to list C++ classes
- Add \ingroup, \title, and \brief commands to \qmlmodule topics
  to display the docs correctly in tables
- Add standard content to \qmlmodule topics
- Remove unused \qmlmodule topics
- Fix \inmodule commands as necessary

Change-Id: I6f6538264fff2ad38994114a2fed7212495a18c2
Reviewed-by: Jarkko Koivikko <jarkko.koivikko@code-q.fi>
Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>

8 files changed, 96 insertions, 38 deletions

diff --git a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc
index 4874dddd..6a382bdd 100644
--- a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc
+++ b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc
@@ -98,17 +98,12 @@
     \li \l {User Guide}
     \endlist
 
-    \section1 QML Types
+    \section1 API Reference
 
-    \annotatedlist qtvirtualkeyboard-qml
-
-    Styling components:
-
-    \annotatedlist qtvirtualkeyboard-styles-qml
-
-    Settings components:
-
-    \annotatedlist qtvirtualkeyboard-settings-qml
+    \list
+        \li \l{Qt Virtual Keyboard QML Types}{QML Types}
+        \li \l{Qt Virtual Keyboard C++ Classes}{C++ Classes}
+    \endlist
 
     \section1 Examples
 
@@ -118,17 +113,29 @@
 */
 
 /*!
-\page qt-virtual-keyboard-qmltypes.html
+\qmlmodule QtQuick.VirtualKeyboard 2.0
 \title Qt Virtual Keyboard QML Types
-\inmodule qtvirtualkeyboard
+\ingroup qmlmodules
+\brief Provides QML types for an input framework and a reference keyboard front
+end.
+
+    The QML types can be imported into your application using the following
+    import statements in your .qml file:
+
+    \badcode
+    import QtQuick.VirtualKeyboard 2.0
+    import QtQuick.VirtualKeyboard.Styles 2.0
+    import QtQuick.VirtualKeyboard.Settings 2.0
+    \endcode
+
+Styling:
 
-\annotatedlist qtvirtualkeyboard-qml
+\generatelist qmltypesbymodule QtQuick.VirtualKeyboard.Styles
 
-Styling components:
+Settings:
 
-\annotatedlist qtvirtualkeyboard-styles-qml
+\generatelist qmltypesbymodule QtQuick.VirtualKeyboard.Settings
 
-Settings components:
+Input framework and keys:
 
-\annotatedlist qtvirtualkeyboard-settings-qml
 */
diff --git a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-module-cpp.qdoc b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-module-cpp.qdoc
new file mode 100644
index 00000000..a2c3fb1d
--- /dev/null
+++ b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-module-cpp.qdoc
@@ -0,0 +1,47 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: https://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 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$
+**
+****************************************************************************/
+
+/*!
+    \module QtVirtualKeyboard
+    \title Qt Virtual Keyboard C++ Classes
+    \brief Provides classes to implement input methods for virtual keyboards.
+
+    \ingroup modules
+    \qtvariable virtualkeyboard
+
+    To include the definitions of the module's classes, use the following directive:
+
+    \code
+    #include <QVirtualKeyboard>
+    \endcode
+
+    To link against the module, add this line to your qmake .pro file:
+
+    \badcode
+    QT += virtualkeyboard
+    \endcode
+*/
diff --git a/src/virtualkeyboard/inputcontext.cpp b/src/virtualkeyboard/inputcontext.cpp
index 070e2908..b5afe780 100644
--- a/src/virtualkeyboard/inputcontext.cpp
+++ b/src/virtualkeyboard/inputcontext.cpp
@@ -54,22 +54,8 @@ bool operator==(const QInputMethodEvent::Attribute &attribute1, const QInputMeth
 QT_END_NAMESPACE
 
 /*!
-    \qmlmodule QtQuick.VirtualKeyboard 2.0
-
-    This module provides a collection of QML components for Qt Virtual Keyboard.
-*/
-
-/*!
-    \module InputFramework
-
-    \title Input Framework
-
-    \brief Contains classes for integrating input methods.
-*/
-
-/*!
     \namespace QtVirtualKeyboard
-    \inmodule InputFramework
+    \inmodule QtVirtualKeyboard
 
     \brief Namespace for the Qt Virtual Keyboard C++ API.
 */
@@ -158,7 +144,7 @@ Q_DECLARE_OPERATORS_FOR_FLAGS(InputContextPrivate::StateFlags)
 
 /*!
     \class QtVirtualKeyboard::InputContext
-    \inmodule InputFramework
+    \inmodule QtVirtualKeyboard
     \brief Provides access to an input context.
 */
 
diff --git a/src/virtualkeyboard/inputengine.cpp b/src/virtualkeyboard/inputengine.cpp
index 9b6b3a5f..c6ae052b 100644
--- a/src/virtualkeyboard/inputengine.cpp
+++ b/src/virtualkeyboard/inputengine.cpp
@@ -131,7 +131,7 @@ private:
 
 /*!
     \class QtVirtualKeyboard::InputEngine
-    \inmodule InputFramework
+    \inmodule QtVirtualKeyboard
     \brief The InputEngine class provides an input engine
     that supports C++ and QML integration.
 
diff --git a/src/virtualkeyboard/selectionlistmodel.cpp b/src/virtualkeyboard/selectionlistmodel.cpp
index 32e6096f..4db1c7f1 100644
--- a/src/virtualkeyboard/selectionlistmodel.cpp
+++ b/src/virtualkeyboard/selectionlistmodel.cpp
@@ -83,7 +83,7 @@ public:
 /*!
     \class QtVirtualKeyboard::SelectionListModel
 
-    \inmodule InputFramework
+    \inmodule QtVirtualKeyboard
 
     \brief List model for selection lists.
 
diff --git a/src/virtualkeyboard/shifthandler.cpp b/src/virtualkeyboard/shifthandler.cpp
index cdb6baa9..6d5d1220 100644
--- a/src/virtualkeyboard/shifthandler.cpp
+++ b/src/virtualkeyboard/shifthandler.cpp
@@ -74,7 +74,7 @@ public:
 
 /*!
     \class QtVirtualKeyboard::ShiftHandler
-    \inmodule InputFramework
+    \inmodule QtVirtualKeyboard
     \brief Manages the shift state.
 */
 
diff --git a/src/virtualkeyboard/styles/styles_plugin.cpp b/src/virtualkeyboard/styles/styles_plugin.cpp
index e5915b87..975ab401 100644
--- a/src/virtualkeyboard/styles/styles_plugin.cpp
+++ b/src/virtualkeyboard/styles/styles_plugin.cpp
@@ -35,8 +35,17 @@
 
 /*!
     \qmlmodule QtQuick.VirtualKeyboard.Styles 2.0
+    \title Qt Quick Virtual Keyboard Styles QML Types
+    \ingroup qmlmodules
 
-    This module provides styling components for the Qt Virtual Keyboard.
+    \brief Provides styling for Qt Virtual Keyboard.
+
+    The QML types can be imported into your application using the following
+    import statements in your .qml file:
+
+    \badcode
+    import QtQuick.VirtualKeyboard.Styles 2.0
+    \endcode
 */
 
 void QtVirtualKeyboardStylesPlugin::registerTypes(const char *uri)
diff --git a/src/virtualkeyboard/virtualkeyboardsettings.cpp b/src/virtualkeyboard/virtualkeyboardsettings.cpp
index 2fcbd23a..bbb16092 100644
--- a/src/virtualkeyboard/virtualkeyboardsettings.cpp
+++ b/src/virtualkeyboard/virtualkeyboardsettings.cpp
@@ -97,8 +97,17 @@ public:
 
 /*!
     \qmlmodule QtQuick.VirtualKeyboard.Settings 2.0
+    \title Qt Quick Virtual Keyboard Settings QML Types
+    \ingroup qmlmodules
 
-    This module provides settings components for Qt Virtual Keyboard.
+    \brief Provides settings for Qt Virtual Keyboard.
+
+    The QML types can be imported into your application using the following
+    import statements in your .qml file:
+
+    \badcode
+    import QtQuick.VirtualKeyboard.Settings 2.0
+    \endcode
 */
 
 /*!