diff options
author | Volker Hilsheimer <volker.hilsheimer@qt.io> | 2022-05-16 17:12:27 +0200 |
---|---|---|
committer | Volker Hilsheimer <volker.hilsheimer@qt.io> | 2022-05-21 11:51:17 +0200 |
commit | 07ce95a6094ced5c2a718255d663a6c67d0f26b7 (patch) | |
tree | 023108aa4075280ac2511c98cbc1446ea68f6bde /examples/speech/quickspeech/doc | |
parent | 9b60e7bd06c26507141a8e1de156638bc7dd9252 (diff) |
Documentation fixes
The name of the module is QtTextToSpeech, not Qt Speech, rename things
accordingly, esp the QML import URI, and adjust examples.
Update the module's index page to use the global macro for generating
the "Using the module" section, and add a changes file with some first
bits about porting to Qt 6.
Add an examples page and a documentation page for the Qt Quick example,
which also needs a qmake project file to prevent a qdoc warning (even
though there is no project that needs to be built).
Change-Id: I29d9126f52dc0f3a0294a27a34af89daa249db5d
Reviewed-by: Axel Spoerl <axel.spoerl@qt.io>
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
Reviewed-by: Jarkko Koivikko <jarkko.koivikko@code-q.fi>
Diffstat (limited to 'examples/speech/quickspeech/doc')
-rw-r--r-- | examples/speech/quickspeech/doc/images/quickspeech-example.png | bin | 0 -> 34979 bytes | |||
-rw-r--r-- | examples/speech/quickspeech/doc/src/quickspeech.qdoc | 42 |
2 files changed, 42 insertions, 0 deletions
diff --git a/examples/speech/quickspeech/doc/images/quickspeech-example.png b/examples/speech/quickspeech/doc/images/quickspeech-example.png Binary files differnew file mode 100644 index 0000000..03a2f60 --- /dev/null +++ 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 new file mode 100644 index 0000000..fd37130 --- /dev/null +++ b/examples/speech/quickspeech/doc/src/quickspeech.qdoc @@ -0,0 +1,42 @@ +/**************************************************************************** +** +** Copyright (C) 2022 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \example speech/quickspeech + \title Quick Speech Example + \ingroup texttospeech_examples + \brief Using text-to-speech in a Qt Quick application. + + \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. + + \image hellospeak-example.png + + \include examples-run.qdocinc +*/ |