summaryrefslogtreecommitdiffstats
path: root/examples/multimedia/audiooutput
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2014-04-09 17:02:25 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-04-14 06:45:43 +0200
commitaf73d55efffa1dca928038cd4f392eb7def7c7e1 (patch)
treea11e18d075a2cc9f4dbf0e14612b7a2118b3cedc /examples/multimedia/audiooutput
parentb33e6d46726ee275eaa00be8800339f1fce4585e (diff)
Doc: Improved example documentation
-added instructions on how to run the example (using \include to insert a section from qtbase/doc/global/) -updated copyright year -removed links to Qt 4 API -rearranged some of the sections -created links from the example pages to Qt Multimedia -fixed QDoc warnings related to the example pages Task-number: QTBUG-33597 Change-Id: Id45ce5cbd40dbfa384abd7260a316f6f6837c186 Reviewed-by: Yoann Lopes <yoann.lopes@digia.com> Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com>
Diffstat (limited to 'examples/multimedia/audiooutput')
-rw-r--r--examples/multimedia/audiooutput/doc/src/audiooutput.qdoc9
1 files changed, 5 insertions, 4 deletions
diff --git a/examples/multimedia/audiooutput/doc/src/audiooutput.qdoc b/examples/multimedia/audiooutput/doc/src/audiooutput.qdoc
index bc79e6a5d..60c9d00d4 100644
--- a/examples/multimedia/audiooutput/doc/src/audiooutput.qdoc
+++ b/examples/multimedia/audiooutput/doc/src/audiooutput.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt Toolkit.
@@ -31,13 +31,14 @@
\ingroup multimedia_examples
\brief The Audio Output Example show the use of the QAudioOutput API.
- The example demonstrates the basic use cases of the QAudioOutput class.
+ The example demonstrates the basic use cases of the QAudioOutput class from
+ \l{Qt Multimedia}.
\image audiooutput-example.png
This example provides a tone generator to supply continuous audio playback.
The first button allows pause and resume of the playback, and the second
button allows toggling between push and pull modes of operation.
-*/
-
+ \include examples-run.qdocinc
+*/