SpeechRecognition: Add a couple of code example snippets

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

1 files changed, 23 insertions, 0 deletions

diff --git a/src/asr/qspeechrecognition.cpp b/src/asr/qspeechrecognition.cpp
index 7c7568c..d7a8790 100755
--- a/src/asr/qspeechrecognition.cpp
+++ b/src/asr/qspeechrecognition.cpp
@@ -61,6 +61,29 @@ Q_LOGGING_CATEGORY(lcSpeechAsr, "qt.speech.asr")
 
   Unless otherwise mentioned, all the methods in this API return immediately and are handled
   asynchronously (in the call order).
+
+  \section1 Initialization
+
+  The following example creates a QSpeechRecognition instance with PocketSphinx engine
+  and creates one grammar. The acoustic model and dictionary for the given locale are
+  assumed to be found in the default resource directory for the engine.
+
+  \snippet asr/speechrecognition.cpp Init
+
+  \section1 Basic Control
+
+  The following example method starts and stops speech recognition for the grammar that
+  was created above:
+
+  \snippet asr/speechrecognition.cpp Start and stop
+
+  After calling \l {QSpeechRecognition::}{startListening()}, the application receives a
+  \l {QSpeechRecognition::}{listeningStarted()} signal as soon as audio recording has been
+  started.
+
+  After calling \l {QSpeechRecognition::}{stopListening()}, the application first receives a
+  \l {QSpeechRecognition::}{listeningStopped()} signal. Later, if a recognition result is
+  available, a \l {QSpeechRecognition::}{result()} signal is received.
 */
 
 /*!