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>
This commit is contained in:
Michael Goddard
2012-02-06 15:49:54 +10:00
committed by Qt by Nokia
parent 51ca5582c2
commit c0fd63d143
11 changed files with 72 additions and 9 deletions

View File

@@ -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
*/

View File

@@ -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.

View File

@@ -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

View File

@@ -48,6 +48,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QMediaPlaylistProvider
\internal
\brief The QMediaPlaylistProvider class provides an abstract list of media.
\inmodule QtMultimedia

View File

@@ -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}
*/