diff options
| author | Kai Köhne <kai.koehne@qt.io> | 2022-08-10 12:22:33 +0200 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2022-08-16 06:47:11 +0000 |
| commit | dc693a04c3927427a7ec1d9a0f3f897195efc051 (patch) | |
| tree | d8fc001a2b98b152340b653f1ed64803d1e7b2e4 | |
| parent | c339ed9908b73f255878541b08fb828dc2216ce3 (diff) | |
Doc: Qualify TextToSpeech links
Without further qualification, TextToSpeech does automatically link
to the QML type. Make an explicit link to "Qt TextToSpeech" landing
page where appropriate.
Fixes: QTBUG-105477
Change-Id: Idcc1ea9a1bf3fd984754e38f1c07b3aa96e582c3
Reviewed-by: Axel Spoerl <axel.spoerl@qt.io>
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
(cherry picked from commit ea1a7b7f3bff42df0aaeab19cea633429da8bdbf)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
| -rw-r--r-- | examples/speech/quickspeech/doc/src/quickspeech.qdoc | 2 | ||||
| -rw-r--r-- | src/tts/doc/src/qt6-changes.qdoc | 4 | ||||
| -rw-r--r-- | src/tts/doc/src/qttexttospeech-engines.qdoc | 2 |
3 files changed, 4 insertions, 4 deletions
diff --git a/examples/speech/quickspeech/doc/src/quickspeech.qdoc b/examples/speech/quickspeech/doc/src/quickspeech.qdoc index a7e542b..e690ad7 100644 --- a/examples/speech/quickspeech/doc/src/quickspeech.qdoc +++ b/examples/speech/quickspeech/doc/src/quickspeech.qdoc @@ -7,7 +7,7 @@ \ingroup qttexttospeech_examples \brief The Quick Speech example reads out user-provided text. - The \e{Quick Speech} example demonstrates how the TextToSpeech type can be used + The \e{Quick Speech} example demonstrates how the \l[QML]{TextToSpeech} type can be used in a \l{Qt Quick} application to read out text, and to control the speech. The example uses \l{Qt Quick Controls} to provide controls for the pitch, volume, and diff --git a/src/tts/doc/src/qt6-changes.qdoc b/src/tts/doc/src/qt6-changes.qdoc index b7dcddd..efeb565 100644 --- a/src/tts/doc/src/qt6-changes.qdoc +++ b/src/tts/doc/src/qt6-changes.qdoc @@ -14,7 +14,7 @@ APIs in each release. But some changes were inevitable in an effort to make Qt a better framework. - In this topic we summarize those changes in Qt TextToSpeech, and provide + In this topic we summarize those changes in \l{Qt TextToSpeech}, and provide guidance to handle them. \section1 Available Engines @@ -28,7 +28,7 @@ \section1 API changes - The Qt TextToSpeech module has undergone some basic consolidation and + The \l{Qt TextToSpeech} module has undergone some basic consolidation and cleanup. There should be minimal porting effort to be able to switch to Qt6. \section2 The QTextToSpeech class diff --git a/src/tts/doc/src/qttexttospeech-engines.qdoc b/src/tts/doc/src/qttexttospeech-engines.qdoc index 87a9bf2..0fc2745 100644 --- a/src/tts/doc/src/qttexttospeech-engines.qdoc +++ b/src/tts/doc/src/qttexttospeech-engines.qdoc @@ -6,7 +6,7 @@ \title Qt TextToSpeech Engines \brief Engine specific documentation - Qt TextToSpeech supports several engine implementations for different platforms, and + \l{Qt TextToSpeech} supports several engine implementations for different platforms, and with different tradeoffs between capabilities, availability, and runtime cost. An engine can be selected when a QTextToSpeech instance is constructed, or on an already |