diff options
| author | Michael Goddard <michael.goddard@nokia.com> | 2012-02-06 15:49:54 +1000 |
|---|---|---|
| committer | Qt by Nokia <qt-info@nokia.com> | 2012-02-06 07:45:05 +0100 |
| commit | c0fd63d143e798203f1108824e7a7c6a3ea6e0e2 (patch) | |
| tree | d6e2d1298e5bdbd535ef9f475a856a70a19e4707 /src/multimedia | |
| parent | 51ca5582c2475ea91fe2d86793f000f7bed41f51 (diff) | |
Documentation tweaks.
Mostly move widgets classes into the QtMultimediaWidgets module, but
also mark a few mostly internal playlist classes as \internal. A few other
tweaks.
Change-Id: If0e376410bf2187cafb24f583108c6beb7b910a9
Reviewed-by: Dmytro Poplavskiy <dmytro.poplavskiy@nokia.com>
Diffstat (limited to 'src/multimedia')
| -rw-r--r-- | src/multimedia/audio/qsound.cpp | 6 | ||||
| -rw-r--r-- | src/multimedia/playback/qmediaplaylistioplugin.cpp | 2 | ||||
| -rw-r--r-- | src/multimedia/playback/qmediaplaylistnavigator.cpp | 1 | ||||
| -rw-r--r-- | src/multimedia/playback/qmediaplaylistprovider.cpp | 1 | ||||
| -rw-r--r-- | src/multimedia/radio/qradiotuner.cpp | 2 |
5 files changed, 10 insertions, 2 deletions
diff --git a/src/multimedia/audio/qsound.cpp b/src/multimedia/audio/qsound.cpp index 5312a3e8c..dc07c08b4 100644 --- a/src/multimedia/audio/qsound.cpp +++ b/src/multimedia/audio/qsound.cpp @@ -46,7 +46,7 @@ /*! \class QSound - \brief The QSound class provides a way to play .wav sound files. + \brief The QSound class provides a method to play .wav sound files. \ingroup multimedia \ingroup multimedia_audio @@ -74,6 +74,10 @@ static play() function, but it may also play more immediately (depending on the underlying platform audio facilities). + If you require finer control over playing sounds, consider the + \l QSoundEffect or \l QAudioOutput classes. + + \sa QSoundEffect */ diff --git a/src/multimedia/playback/qmediaplaylistioplugin.cpp b/src/multimedia/playback/qmediaplaylistioplugin.cpp index 0d1e57840..084c55d65 100644 --- a/src/multimedia/playback/qmediaplaylistioplugin.cpp +++ b/src/multimedia/playback/qmediaplaylistioplugin.cpp @@ -45,6 +45,7 @@ QT_BEGIN_NAMESPACE /*! \class QMediaPlaylistReader + \internal \brief The QMediaPlaylistReader class provides an interface for reading a playlist file. \inmodule QtMultimedia @@ -86,6 +87,7 @@ QMediaPlaylistReader::~QMediaPlaylistReader() /*! \class QMediaPlaylistWriter + \internal \brief The QMediaPlaylistWriter class provides an interface for writing a playlist file. diff --git a/src/multimedia/playback/qmediaplaylistnavigator.cpp b/src/multimedia/playback/qmediaplaylistnavigator.cpp index 8cce09a6f..414f735db 100644 --- a/src/multimedia/playback/qmediaplaylistnavigator.cpp +++ b/src/multimedia/playback/qmediaplaylistnavigator.cpp @@ -192,6 +192,7 @@ int QMediaPlaylistNavigatorPrivate::previousItemPos(int steps) const /*! \class QMediaPlaylistNavigator + \internal \brief The QMediaPlaylistNavigator class provides navigation for a media playlist. \inmodule QtMultimedia diff --git a/src/multimedia/playback/qmediaplaylistprovider.cpp b/src/multimedia/playback/qmediaplaylistprovider.cpp index 9324b26f7..c3e62a1dd 100644 --- a/src/multimedia/playback/qmediaplaylistprovider.cpp +++ b/src/multimedia/playback/qmediaplaylistprovider.cpp @@ -48,6 +48,7 @@ QT_BEGIN_NAMESPACE /*! \class QMediaPlaylistProvider + \internal \brief The QMediaPlaylistProvider class provides an abstract list of media. \inmodule QtMultimedia diff --git a/src/multimedia/radio/qradiotuner.cpp b/src/multimedia/radio/qradiotuner.cpp index e0aeaa2c5..69129a79b 100644 --- a/src/multimedia/radio/qradiotuner.cpp +++ b/src/multimedia/radio/qradiotuner.cpp @@ -87,7 +87,7 @@ namespace You can change between the frequency bands using setBand() however it is recommended that you check to make sure the band is available first using isBandSupported(). - \sa {Radio Overview} + \sa QRadioData, {Radio Overview} */ |