summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJustin McPherson <justin.mcpherson@nokia.com>2010-02-22 05:04:43 (GMT)
committerJustin McPherson <justin.mcpherson@nokia.com>2010-02-22 05:04:43 (GMT)
commit129b6b9b5c6502058c7701367119bfe6607fbff5 (patch)
treec37f0c7fc9452e43735b43ae862964bf0f25d499
parent5742539904bb7feb0b21d465d7d71f6deb70b238 (diff)
downloadQt-129b6b9b5c6502058c7701367119bfe6607fbff5.zip
Qt-129b6b9b5c6502058c7701367119bfe6607fbff5.tar.gz
Qt-129b6b9b5c6502058c7701367119bfe6607fbff5.tar.bz2
Documentation fixes.
Reviewed-by: Nicholas Young
-rw-r--r--src/multimedia/base/qmediaplaylist.cpp8
-rw-r--r--src/multimedia/base/qtmedianamespace.qdoc16
-rw-r--r--src/multimedia/qml/qmlaudio.cpp4
-rw-r--r--src/multimedia/qml/qmlgraphicsvideo.cpp4
-rw-r--r--src/multimedia/qml/qsoundeffect.cpp4
-rw-r--r--src/plugins/mediaservices/gstreamer/qgstreamerbushelper.cpp2
-rw-r--r--src/plugins/mediaservices/gstreamer/qgstreamermessage.cpp2
7 files changed, 22 insertions, 18 deletions
diff --git a/src/multimedia/base/qmediaplaylist.cpp b/src/multimedia/base/qmediaplaylist.cpp
index 8a0de80..ab91fd7 100644
--- a/src/multimedia/base/qmediaplaylist.cpp
+++ b/src/multimedia/base/qmediaplaylist.cpp
@@ -145,6 +145,10 @@ QMediaPlaylist::~QMediaPlaylist()
delete d_ptr;
}
+/*!
+ Returns the QMediaObject that is being used to play the contents of this playlist.
+*/
+
QMediaObject *QMediaPlaylist::mediaObject() const
{
return d_func()->mediaObject;
@@ -308,7 +312,7 @@ int QMediaPlaylist::mediaCount() const
/*!
Returns true if the playlist contains no items; otherwise returns false.
- \sa size()
+ \sa mediaCount()
*/
bool QMediaPlaylist::isEmpty() const
{
@@ -317,7 +321,7 @@ bool QMediaPlaylist::isEmpty() const
/*!
Returns true if the playlist can be modified; otherwise returns false.
- \sa size()
+ \sa mediaCount()
*/
bool QMediaPlaylist::isReadOnly() const
{
diff --git a/src/multimedia/base/qtmedianamespace.qdoc b/src/multimedia/base/qtmedianamespace.qdoc
index 0fb39f5..270c7d6 100644
--- a/src/multimedia/base/qtmedianamespace.qdoc
+++ b/src/multimedia/base/qtmedianamespace.qdoc
@@ -40,15 +40,15 @@
****************************************************************************/
/*!
- \namespace QtMedia
+ \namespace QtMultimedia
\ingroup multimedia
- \brief The QtMedia namespace contains miscellaneous identifiers used throughout the Qt Media
- library.
+ \brief The QtMultimedia namespace contains miscellaneous identifiers used
+ throughout the Qt Multimedia library.
*/
/*!
- \enum QtMedia::MetaData
+ \enum QtMultimedia::MetaData
This enum provides identifiers for meta-data attributes.
@@ -165,7 +165,7 @@
*/
/*!
- \enum QtMedia::SupportEstimate
+ \enum QtMultimedia::SupportEstimate
Enumerates the levels of support a media service provider may have for a feature.
@@ -176,7 +176,7 @@
*/
/*!
- \enum QtMedia::EncodingQuality
+ \enum QtMultimedia::EncodingQuality
Enumerates quality encoding levels.
@@ -188,7 +188,7 @@
*/
/*!
- \enum QtMedia::EncodingMode
+ \enum QtMultimedia::EncodingMode
Enumerates encoding modes.
@@ -199,7 +199,7 @@
*/
/*!
- \enum QtMedia::AvailabilityError
+ \enum QtMultimedia::AvailabilityError
Enumerates Service status errors.
diff --git a/src/multimedia/qml/qmlaudio.cpp b/src/multimedia/qml/qmlaudio.cpp
index 5719050..b54d644 100644
--- a/src/multimedia/qml/qmlaudio.cpp
+++ b/src/multimedia/qml/qmlaudio.cpp
@@ -280,7 +280,7 @@ QmlAudio::Status QmlAudio::status() const
*/
/*!
- \qmlproperty qreal playbackRate
+ \qmlproperty qreal Audio::playbackRate
This property holds the rate at which audio is played at as a multiple of the normal rate.
*/
@@ -313,7 +313,7 @@ QmlAudio::Error QmlAudio::error() const
*/
/*!
- \qmlproperty Audio::onError(error, errorString)
+ \qmlsignal Audio::onError(error, errorString)
This property is called when an \l {Error}{error} has occurred. The errorString parameter
may contain more detailed information about the error.
diff --git a/src/multimedia/qml/qmlgraphicsvideo.cpp b/src/multimedia/qml/qmlgraphicsvideo.cpp
index fde505d..9e30774 100644
--- a/src/multimedia/qml/qmlgraphicsvideo.cpp
+++ b/src/multimedia/qml/qmlgraphicsvideo.cpp
@@ -280,7 +280,7 @@ bool QmlGraphicsVideo::hasVideo() const
*/
/*!
- \qmlproperty qreal playbackRate
+ \qmlproperty qreal Video::playbackRate
This property holds the rate at which video is played at as a multiple of the normal rate.
*/
@@ -314,7 +314,7 @@ QmlGraphicsVideo::Error QmlGraphicsVideo::error() const
*/
/*!
- \qmlproperty Video::onError(error, errorString)
+ \qmlsignal Video::onError(error, errorString)
This property is called when an \l {Error}{error} has occurred. The errorString parameter
may contain more detailed information about the error.
diff --git a/src/multimedia/qml/qsoundeffect.cpp b/src/multimedia/qml/qsoundeffect.cpp
index 1a67414..f0c9659 100644
--- a/src/multimedia/qml/qsoundeffect.cpp
+++ b/src/multimedia/qml/qsoundeffect.cpp
@@ -54,7 +54,7 @@
/*!
- \qmlclass QSoundEffect
+ \qmlclass SoundEffect QSoundEffect
\brief The SoundEffect element provides a way to play sound effects in qml.
The following example plays a wav file on mouse click.
@@ -71,7 +71,7 @@
playSound.play()
}
}
- \endeml
+ \endqml
\sa SoundEffect
*/
diff --git a/src/plugins/mediaservices/gstreamer/qgstreamerbushelper.cpp b/src/plugins/mediaservices/gstreamer/qgstreamerbushelper.cpp
index 4649c21..59ae5be 100644
--- a/src/plugins/mediaservices/gstreamer/qgstreamerbushelper.cpp
+++ b/src/plugins/mediaservices/gstreamer/qgstreamerbushelper.cpp
@@ -174,7 +174,7 @@ static GstBusSyncReply syncGstBusFilter(GstBus* bus, GstMessage* message, QGstre
/*!
- \class gstreamer::QGstreamerBusHelper
+ \class QGstreamerBusHelper
\internal
*/
diff --git a/src/plugins/mediaservices/gstreamer/qgstreamermessage.cpp b/src/plugins/mediaservices/gstreamer/qgstreamermessage.cpp
index 13a2454..0a689d9 100644
--- a/src/plugins/mediaservices/gstreamer/qgstreamermessage.cpp
+++ b/src/plugins/mediaservices/gstreamer/qgstreamermessage.cpp
@@ -48,7 +48,7 @@ static int wuchi = qRegisterMetaType<QGstreamerMessage>();
/*!
- \class gstreamer::QGstreamerMessage
+ \class QGstreamerMessage
\internal
*/