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/hello_speak/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/hello_speak/doc')
| -rw-r--r-- | examples/speech/hello_speak/doc/images/hellospeak-example.png | bin | 34979 -> 71273 bytes | |||
| -rw-r--r-- | examples/speech/hello_speak/doc/src/hellospeakex.qdoc | 16 |
2 files changed, 9 insertions, 7 deletions
diff --git a/examples/speech/hello_speak/doc/images/hellospeak-example.png b/examples/speech/hello_speak/doc/images/hellospeak-example.png Binary files differindex 03a2f60..0625595 100644 --- a/examples/speech/hello_speak/doc/images/hellospeak-example.png +++ b/examples/speech/hello_speak/doc/images/hellospeak-example.png diff --git a/examples/speech/hello_speak/doc/src/hellospeakex.qdoc b/examples/speech/hello_speak/doc/src/hellospeakex.qdoc index 15a0b23..81d05e8 100644 --- a/examples/speech/hello_speak/doc/src/hellospeakex.qdoc +++ b/examples/speech/hello_speak/doc/src/hellospeakex.qdoc @@ -1,17 +1,19 @@ -// Copyright (C) 2017 The Qt Company Ltd. +// Copyright (C) 2022 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! - \example speech/hello_speak + \example hello_speak \title Hello Speak Example \ingroup texttospeech_examples - \brief The Hello Speak example reads out a small piece of text. + \brief The Hello Speak example reads out user-provided text. - \e{Hello Speak} example demonstrates how QTextToSpeech can be used 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{Hello Speak} example demonstrates how QTextToSpeech can be used in + a Qt C++ application to read out text, and to control the speech. + + The example uses a \l{Qt Widgets}{widget UI} 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 hellospeak-example.png */ |
