diff options
| author | Volker Hilsheimer <volker.hilsheimer@qt.io> | 2022-07-10 16:14:18 +0200 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2022-07-13 09:45:10 +0000 |
| commit | c830c56995efc14413fe1914e01f55743aab60d9 (patch) | |
| tree | 0455cbc1ca1a3372ed44470272a7986fcdb68bb8 /examples/speech/quickspeech/doc | |
| parent | 3177713c7d8a4b5fbbbde55ccfe63f7a45f163da (diff) | |
Fix and edit the example documentation
If the exampledirs variable in qdocconf doesn't include the /speech
subdirectory, but each example page does, then the link generated to
code.qt.io is incorrect. Since the qdocconf is for the texttospeech
module, all examples will live in the same tree anyway.
Link to Qt Widgets and Qt Quick Controls from the respective examples,
which requires that those modules are added as dependencies.
Improve the phrasing of the text, and update and optimize the
screenshots of the examples.
Change-Id: I3de4e707c2aeed40735a714934adea59afdea1e8
Reviewed-by: Axel Spoerl <axel.spoerl@qt.io>
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
(cherry picked from commit 86b86e5c48481f81fa43d3da49fd5177bc9925ef)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'examples/speech/quickspeech/doc')
| -rw-r--r-- | examples/speech/quickspeech/doc/images/quickspeech-example.png | bin | 34979 -> 62879 bytes | |||
| -rw-r--r-- | examples/speech/quickspeech/doc/src/quickspeech.qdoc | 16 |
2 files changed, 9 insertions, 7 deletions
diff --git a/examples/speech/quickspeech/doc/images/quickspeech-example.png b/examples/speech/quickspeech/doc/images/quickspeech-example.png Binary files differindex 03a2f60..68d8352 100644 --- a/examples/speech/quickspeech/doc/images/quickspeech-example.png +++ b/examples/speech/quickspeech/doc/images/quickspeech-example.png diff --git a/examples/speech/quickspeech/doc/src/quickspeech.qdoc b/examples/speech/quickspeech/doc/src/quickspeech.qdoc index b22d909..dda3539 100644 --- a/examples/speech/quickspeech/doc/src/quickspeech.qdoc +++ b/examples/speech/quickspeech/doc/src/quickspeech.qdoc @@ -2,17 +2,19 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! - \example speech/quickspeech + \example quickspeech \title Quick Speech Example \ingroup texttospeech_examples - \brief Using text-to-speech in a Qt Quick application. + \brief The Quick Speech example reads out user-provided text. - \e{Quick Speech} example demonstrates how the TextToSpeech type can be used - from QML to read out text, as well as control the pitch, volume, and rate - of the speech. It also lets you select a language and voice, if additional - languages and voices are found. + The \e{Quick Speech} example demonstrates how the TextToSpeech type can be used + in a \l{Qt Quick} application to read out text, and to control the speech. - \image hellospeak-example.png + The example uses \l{Qt Quick Controls} to provide controls for the pitch, volume, and + rate of the speech. It also lets the user select an engine, the language, and a + voice. + + \image quickspeech-example.png \include examples-run.qdocinc */ |
