Doc: Fix a number of documentation issues

    - Separate TTS, Speech Recognition as their own C++ modules
    - Create a top-level Qt Speech C++ Classes page
    - Add missing example file type to .qdocconf
    - Use a table for speech recog. plugins
    - Fix QDoc warning:
      src/asr/qspeechrecognition.cpp:125: warning: Can't link to 'stateChanged()'

Change-Id: I7da40273c2878a18924705f331a998730a06c7c4
Reviewed-by: Tuomas Tuononen <tuomas.tuononen@code-q.fi>
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>

11 files changed, 38 insertions, 18 deletions

diff --git a/src/asr/qspeechrecognition.cpp b/src/asr/qspeechrecognition.cpp
index 01f6b88..e827c62 100755
--- a/src/asr/qspeechrecognition.cpp
+++ b/src/asr/qspeechrecognition.cpp
@@ -109,7 +109,7 @@ Q_DEFINE_ASR_RESULT_PARAMETER(Transcription);
 
 /*!
   \class QSpeechRecognition
-  \inmodule QtSpeech
+  \inmodule QtSpeechRecognition
   \brief The QSpeechRecognition class provides access to speech recognition engines
 
   \reentrant
@@ -187,7 +187,7 @@ Q_DEFINE_ASR_RESULT_PARAMETER(Transcription);
   \property QSpeechRecognition::state
   The current state of the speech recognizer.
 
-  The notification signal \l stateChanged() is always emitted asynchronously (through
+  The notification signal stateChanged() is always emitted asynchronously (through
   queued connection).
 */
 
diff --git a/src/asr/qspeechrecognitionaudiobuffer.cpp b/src/asr/qspeechrecognitionaudiobuffer.cpp
index 1afd840..08d1ebf 100755
--- a/src/asr/qspeechrecognitionaudiobuffer.cpp
+++ b/src/asr/qspeechrecognitionaudiobuffer.cpp
@@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE
 
 /*!
   \class QSpeechRecognitionAudioBuffer
-  \inmodule QtSpeech
+  \inmodule QtSpeechRecognition
   \brief The QSpeechRecognitionAudioBuffer class can be used to implement audio buffering
   for speech recognition engines.
 
diff --git a/src/asr/qspeechrecognitionengine.cpp b/src/asr/qspeechrecognitionengine.cpp
index b301d83..de1a06b 100755
--- a/src/asr/qspeechrecognitionengine.cpp
+++ b/src/asr/qspeechrecognitionengine.cpp
@@ -121,7 +121,7 @@ Q_DEFINE_ASR_ENGINE_PARAMETER(AudioInputDevices);
 
 /*!
   \class QSpeechRecognitionEngine
-  \inmodule QtSpeech
+  \inmodule QtSpeechRecognition
   \brief The QSpeechRecognitionEngine class is a handle to a speech recognition engine.
 
   A speech recognition engine can be created with \l QSpeechRecognition::createEngine().
diff --git a/src/asr/qspeechrecognitiongrammar.cpp b/src/asr/qspeechrecognitiongrammar.cpp
index d353214..3a9d828 100755
--- a/src/asr/qspeechrecognitiongrammar.cpp
+++ b/src/asr/qspeechrecognitiongrammar.cpp
@@ -40,7 +40,7 @@ QT_BEGIN_NAMESPACE
 
 /*!
   \class QSpeechRecognitionGrammar
-  \inmodule QtSpeech
+  \inmodule QtSpeechRecognition
   \brief The QSpeechRecognitionGrammar class is a handle to a speech recognition grammar.
 
   A speech recognition grammar can be created with \l QSpeechRecognition::createGrammar()
diff --git a/src/asr/qspeechrecognitionplugin.cpp b/src/asr/qspeechrecognitionplugin.cpp
index 0d6f967..a1398fb 100755
--- a/src/asr/qspeechrecognitionplugin.cpp
+++ b/src/asr/qspeechrecognitionplugin.cpp
@@ -40,7 +40,7 @@ QT_BEGIN_NAMESPACE
 
 /*!
   \class QSpeechRecognitionPlugin
-  \inmodule QtSpeech
+  \inmodule QtSpeechRecognition
   \brief The QSpeechRecognitionPlugin class is the base for all speech recognition plug-ins.
 
   A plug-in implementation should derive from QSpeechRecognitionPlugin and re-implement
diff --git a/src/asr/qspeechrecognitionpluginengine.cpp b/src/asr/qspeechrecognitionpluginengine.cpp
index bee840e..5cdb30b 100755
--- a/src/asr/qspeechrecognitionpluginengine.cpp
+++ b/src/asr/qspeechrecognitionpluginengine.cpp
@@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE
 
 /*!
   \class QSpeechRecognitionPluginEngine
-  \inmodule QtSpeech
+  \inmodule QtSpeechRecognition
   \brief The QSpeechRecognitionPluginEngine class is the base for all speech recognition engine integrations.
 
   An engine implementation should derive from QSpeechRecognitionPluginEngine and implement all
diff --git a/src/asr/qspeechrecognitionplugingrammar.cpp b/src/asr/qspeechrecognitionplugingrammar.cpp
index 41aab9e..a2cb0ef 100755
--- a/src/asr/qspeechrecognitionplugingrammar.cpp
+++ b/src/asr/qspeechrecognitionplugingrammar.cpp
@@ -41,7 +41,7 @@ QT_BEGIN_NAMESPACE
 
 /*!
   \class QSpeechRecognitionPluginGrammar
-  \inmodule QtSpeech
+  \inmodule QtSpeechRecognition
   \brief The QSpeechRecognitionPluginGrammar class is the base for all speech recognition grammar integrations.
 
   A grammar implementation should derive from QSpeechRecognitionPluginGrammar. The grammar instance is
diff --git a/src/doc/qtspeech.qdocconf b/src/doc/qtspeech.qdocconf
index 1a246bc..6d7f3ee 100644
--- a/src/doc/qtspeech.qdocconf
+++ b/src/doc/qtspeech.qdocconf
@@ -1,7 +1,7 @@
 include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
 
 project = QtSpeech
-description = Qt Text-To-Speech library
+description = Qt Speech Documentation
 version = $QT_VERSION
 
 sourcedirs += ..
@@ -16,6 +16,7 @@ exampledirs += \
 excludedirs += snippets
 
 examplesinstallpath = speech
+examples.fileextensions += "*.jsgf"
 
 depends += qtcore qtdoc
 
diff --git a/src/doc/src/qtspeech-index.qdoc b/src/doc/src/qtspeech-index.qdoc
index dc527cc..5be70e1 100644
--- a/src/doc/src/qtspeech-index.qdoc
+++ b/src/doc/src/qtspeech-index.qdoc
@@ -81,10 +81,10 @@
 
    \section2 Available Plugins
 
-   \list
-    \li \l {PocketSphinx Speech Recognition Plugin}
-    \li Nuance VoCon Hybrid Plugin is available. Please contact The Qt Company for details.
-   \endlist
+   \table
+    \row \li \e {PocketSphinx} \li PocketSphinx Speech Recognition Plugin
+    \row \li \e {Nuance VoCon® Hybrid} \li Contact The Qt Company for details
+   \endtable
 
    \section2 Examples
 
diff --git a/src/doc/src/qtspeech.qdoc b/src/doc/src/qtspeech.qdoc
index caced22..81eb019 100644
--- a/src/doc/src/qtspeech.qdoc
+++ b/src/doc/src/qtspeech.qdoc
@@ -26,8 +26,27 @@
 ****************************************************************************/
 
 /*!
-   \module QtSpeech
-   \title Qt Speech C++ Classes
-   \brief Provides C++ API to access text-to-speech and speech recognition engines
-   \qtvariable texttospeech
+    \module QtTextToSpeech
+    \title Qt Text-to-speech C++ Classes
+    \brief Provides C++ API to access text-to-speech engines.
+    \qtvariable texttospeech
+*/
+
+/*!
+    \module QtSpeechRecognition
+    \title Qt Speech Recognition C++ Classes
+    \brief Provides C++ API to access speech recognition engines.
+    \qtvariable speechrecognition
+*/
+
+/*!
+    \page qtspeech-modules.html
+    \title Qt Speech C++ Classes
+    \ingroup modules
+
+    \section1 Qt Text-to-speech
+    \generatelist classesbymodule QtTextToSpeech
+
+    \section1 Qt Speech Recognition
+    \generatelist classesbymodule QtSpeechRecognition
 */
diff --git a/src/tts/qtexttospeech.cpp b/src/tts/qtexttospeech.cpp
index 0d381a1..efd07a1 100644
--- a/src/tts/qtexttospeech.cpp
+++ b/src/tts/qtexttospeech.cpp
@@ -160,7 +160,7 @@ void QTextToSpeechPrivate::loadPluginMetadata(QHash<QString, QJsonObject> &list)
 /*!
   \class QTextToSpeech
   \brief The QTextToSpeech class provides a convenient access to text-to-speech engines
-  \inmodule QtSpeech
+  \inmodule QtTextToSpeech
 
   Use \l say() to start synthesizing text.
   It is possible to specify the language with \l setLocale().