diff options
| author | Kai Köhne <kai.koehne@qt.io> | 2022-08-19 09:09:49 +0200 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2022-09-23 11:32:16 +0000 |
| commit | b6abffde0fb10549357847c333df5997fbc84966 (patch) | |
| tree | 2498f5bf6bbe95a83c5761950f96d86fb9f6f359 | |
| parent | fde62c124830280f613bce9f738fe1232b74486f (diff) | |
Doc: Rewrite intro to module
For screenreaders, you don't need TextToSpeech. So the reference
to Accessibility was misleading. Also, leave details of the various
engines to the sub-page.
Change-Id: I69843f864d4eae24c3738995d6bc93367ea54e2d
Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
(cherry picked from commit b324e108c0b4091acc4635a3cf448664b1fe30eb)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
| -rw-r--r-- | src/tts/doc/src/qttexttospeech-index.qdoc | 21 |
1 files changed, 10 insertions, 11 deletions
diff --git a/src/tts/doc/src/qttexttospeech-index.qdoc b/src/tts/doc/src/qttexttospeech-index.qdoc index 51887b8..2bb5cbb 100644 --- a/src/tts/doc/src/qttexttospeech-index.qdoc +++ b/src/tts/doc/src/qttexttospeech-index.qdoc @@ -6,17 +6,16 @@ \title Qt TextToSpeech \brief The Qt TextToSpeech module enables access to text-to-speech engines - The module enables a Qt application to support accessibility features such - as text-to-speech, which is useful for end-users who cannot access the - application's visual interface. In addition to assistive technologies like - screen readers, the most common use case for text-to-speech is when the - end-user is driving or operating machinery. In such a scenario, an application - can use text-to-speech to read out incoming notifications, or to provide - turn-by-turn navigation instructions. - - On Linux, the module can use the Speech Dispatcher daemon (libspeechd), or - flite. On other platforms, it uses the native system APIs to access the - platform-specific text-to-speech engines. + The Qt \TextToSpeech module enables a Qt application to read out text by + using speech synthesis. This is especially useful in scenarios where the + end-user cannot access the application's visual interface, for example, when + driving or operating machinery. In such setups, the module can be used to + read out incoming notifications or to provide turn-by-turn navigation + instructions. + + The module does not provide a text-to-speech engine itself. Instead, it + uses engines native to the operating system. See \l{Qt TextToSpeech Engines} + for more details about this. \section1 Using the Module |