Remove antiquated \since lines in docs.
They aren't useful in the case of QtMultimedia{Kit}
Change-Id: If1b0b6625763c85907fb05beb9c440046472ddef
Reviewed-by: Jonas Rabbe <jonas.rabbe@nokia.com>
This commit is contained in:
committed by
Qt by Nokia
parent
b228ff95d7
commit
a6268601c9
@@ -79,7 +79,6 @@ namespace
|
||||
\class QMediaPlaylist
|
||||
\inmodule QtMultimedia
|
||||
\ingroup multimedia
|
||||
\since 1.0
|
||||
|
||||
|
||||
\brief The QMediaPlaylist class provides a list of media content to play.
|
||||
@@ -151,7 +150,6 @@ QMediaPlaylist::~QMediaPlaylist()
|
||||
/*!
|
||||
Returns the QMediaObject instance that this QMediaPlaylist is bound too,
|
||||
or 0 otherwise.
|
||||
\since 1.0
|
||||
*/
|
||||
QMediaObject *QMediaPlaylist::mediaObject() const
|
||||
{
|
||||
@@ -162,7 +160,6 @@ QMediaObject *QMediaPlaylist::mediaObject() const
|
||||
\internal
|
||||
If \a mediaObject is null or doesn't have an intrinsic playlist,
|
||||
internal local memory playlist source will be created.
|
||||
\since 1.0
|
||||
*/
|
||||
bool QMediaPlaylist::setMediaObject(QMediaObject *mediaObject)
|
||||
{
|
||||
@@ -248,7 +245,6 @@ bool QMediaPlaylist::setMediaObject(QMediaObject *mediaObject)
|
||||
|
||||
This property defines the order, items in playlist are played.
|
||||
|
||||
\since 1.0
|
||||
\sa QMediaPlaylist::PlaybackMode
|
||||
*/
|
||||
|
||||
@@ -265,7 +261,6 @@ void QMediaPlaylist::setPlaybackMode(QMediaPlaylist::PlaybackMode mode)
|
||||
|
||||
/*!
|
||||
Returns position of the current media content in the playlist.
|
||||
\since 1.0
|
||||
*/
|
||||
int QMediaPlaylist::currentIndex() const
|
||||
{
|
||||
@@ -274,7 +269,6 @@ int QMediaPlaylist::currentIndex() const
|
||||
|
||||
/*!
|
||||
Returns the current media content.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
QMediaContent QMediaPlaylist::currentMedia() const
|
||||
@@ -289,7 +283,6 @@ QMediaContent QMediaPlaylist::currentMedia() const
|
||||
Returned value depends on the size of playlist, current position
|
||||
and playback mode.
|
||||
|
||||
\since 1.0
|
||||
\sa QMediaPlaylist::playbackMode
|
||||
*/
|
||||
int QMediaPlaylist::nextIndex(int steps) const
|
||||
@@ -301,7 +294,6 @@ int QMediaPlaylist::nextIndex(int steps) const
|
||||
Returns the index of the item, which would be current after calling previous()
|
||||
\a steps times.
|
||||
|
||||
\since 1.0
|
||||
\sa QMediaPlaylist::playbackMode
|
||||
*/
|
||||
|
||||
@@ -314,7 +306,6 @@ int QMediaPlaylist::previousIndex(int steps) const
|
||||
/*!
|
||||
Returns the number of items in the playlist.
|
||||
|
||||
\since 1.0
|
||||
\sa isEmpty()
|
||||
*/
|
||||
int QMediaPlaylist::mediaCount() const
|
||||
@@ -325,7 +316,6 @@ int QMediaPlaylist::mediaCount() const
|
||||
/*!
|
||||
Returns true if the playlist contains no items; otherwise returns false.
|
||||
|
||||
\since 1.0
|
||||
\sa mediaCount()
|
||||
*/
|
||||
bool QMediaPlaylist::isEmpty() const
|
||||
@@ -336,7 +326,6 @@ bool QMediaPlaylist::isEmpty() const
|
||||
/*!
|
||||
Returns true if the playlist can be modified; otherwise returns false.
|
||||
|
||||
\since 1.0
|
||||
\sa mediaCount()
|
||||
*/
|
||||
bool QMediaPlaylist::isReadOnly() const
|
||||
@@ -346,7 +335,6 @@ bool QMediaPlaylist::isReadOnly() const
|
||||
|
||||
/*!
|
||||
Returns the media content at \a index in the playlist.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
QMediaContent QMediaPlaylist::media(int index) const
|
||||
@@ -358,7 +346,6 @@ QMediaContent QMediaPlaylist::media(int index) const
|
||||
Append the media \a content to the playlist.
|
||||
|
||||
Returns true if the operation is successful, otherwise return false.
|
||||
\since 1.0
|
||||
*/
|
||||
bool QMediaPlaylist::addMedia(const QMediaContent &content)
|
||||
{
|
||||
@@ -369,7 +356,6 @@ bool QMediaPlaylist::addMedia(const QMediaContent &content)
|
||||
Append multiple media content \a items to the playlist.
|
||||
|
||||
Returns true if the operation is successful, otherwise return false.
|
||||
\since 1.0
|
||||
*/
|
||||
bool QMediaPlaylist::addMedia(const QList<QMediaContent> &items)
|
||||
{
|
||||
@@ -380,7 +366,6 @@ bool QMediaPlaylist::addMedia(const QList<QMediaContent> &items)
|
||||
Insert the media \a content to the playlist at position \a pos.
|
||||
|
||||
Returns true if the operation is successful, otherwise false.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
bool QMediaPlaylist::insertMedia(int pos, const QMediaContent &content)
|
||||
@@ -392,7 +377,6 @@ bool QMediaPlaylist::insertMedia(int pos, const QMediaContent &content)
|
||||
Insert multiple media content \a items to the playlist at position \a pos.
|
||||
|
||||
Returns true if the operation is successful, otherwise false.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
bool QMediaPlaylist::insertMedia(int pos, const QList<QMediaContent> &items)
|
||||
@@ -404,7 +388,6 @@ bool QMediaPlaylist::insertMedia(int pos, const QList<QMediaContent> &items)
|
||||
Remove the item from the playlist at position \a pos.
|
||||
|
||||
Returns true if the operation is successful, otherwise return false.
|
||||
\since 1.0
|
||||
*/
|
||||
bool QMediaPlaylist::removeMedia(int pos)
|
||||
{
|
||||
@@ -416,7 +399,6 @@ bool QMediaPlaylist::removeMedia(int pos)
|
||||
Remove items in the playlist from \a start to \a end inclusive.
|
||||
|
||||
Returns true if the operation is successful, otherwise return false.
|
||||
\since 1.0
|
||||
*/
|
||||
bool QMediaPlaylist::removeMedia(int start, int end)
|
||||
{
|
||||
@@ -428,7 +410,6 @@ bool QMediaPlaylist::removeMedia(int start, int end)
|
||||
Remove all the items from the playlist.
|
||||
|
||||
Returns true if the operation is successful, otherwise return false.
|
||||
\since 1.0
|
||||
*/
|
||||
bool QMediaPlaylist::clear()
|
||||
{
|
||||
@@ -462,7 +443,6 @@ bool QMediaPlaylistPrivate::writeItems(QMediaPlaylistWriter *writer)
|
||||
|
||||
QMediaPlaylist::loaded() signal is emitted if playlist was loaded successfully,
|
||||
otherwise the playlist emits loadFailed().
|
||||
\since 1.0
|
||||
*/
|
||||
void QMediaPlaylist::load(const QUrl &location, const char *format)
|
||||
{
|
||||
@@ -509,7 +489,6 @@ void QMediaPlaylist::load(const QUrl &location, const char *format)
|
||||
|
||||
QMediaPlaylist::loaded() signal is emitted if playlist was loaded successfully,
|
||||
otherwise the playlist emits loadFailed().
|
||||
\since 1.0
|
||||
*/
|
||||
void QMediaPlaylist::load(QIODevice * device, const char *format)
|
||||
{
|
||||
@@ -553,7 +532,6 @@ void QMediaPlaylist::load(QIODevice * device, const char *format)
|
||||
otherwise format is guessed from location name.
|
||||
|
||||
Returns true if playlist was saved successfully, otherwise returns false.
|
||||
\since 1.0
|
||||
*/
|
||||
bool QMediaPlaylist::save(const QUrl &location, const char *format)
|
||||
{
|
||||
@@ -580,7 +558,6 @@ bool QMediaPlaylist::save(const QUrl &location, const char *format)
|
||||
Save playlist to QIODevice \a device using format \a format.
|
||||
|
||||
Returns true if playlist was saved successfully, otherwise returns false.
|
||||
\since 1.0
|
||||
*/
|
||||
bool QMediaPlaylist::save(QIODevice * device, const char *format)
|
||||
{
|
||||
@@ -612,7 +589,6 @@ bool QMediaPlaylist::save(QIODevice * device, const char *format)
|
||||
|
||||
/*!
|
||||
Returns the last error condition.
|
||||
\since 1.0
|
||||
*/
|
||||
QMediaPlaylist::Error QMediaPlaylist::error() const
|
||||
{
|
||||
@@ -621,7 +597,6 @@ QMediaPlaylist::Error QMediaPlaylist::error() const
|
||||
|
||||
/*!
|
||||
Returns the string describing the last error condition.
|
||||
\since 1.0
|
||||
*/
|
||||
QString QMediaPlaylist::errorString() const
|
||||
{
|
||||
@@ -630,7 +605,6 @@ QString QMediaPlaylist::errorString() const
|
||||
|
||||
/*!
|
||||
Shuffle items in the playlist.
|
||||
\since 1.0
|
||||
*/
|
||||
void QMediaPlaylist::shuffle()
|
||||
{
|
||||
@@ -640,7 +614,6 @@ void QMediaPlaylist::shuffle()
|
||||
|
||||
/*!
|
||||
Advance to the next media content in playlist.
|
||||
\since 1.0
|
||||
*/
|
||||
void QMediaPlaylist::next()
|
||||
{
|
||||
@@ -649,7 +622,6 @@ void QMediaPlaylist::next()
|
||||
|
||||
/*!
|
||||
Return to the previous media content in playlist.
|
||||
\since 1.0
|
||||
*/
|
||||
void QMediaPlaylist::previous()
|
||||
{
|
||||
@@ -658,7 +630,6 @@ void QMediaPlaylist::previous()
|
||||
|
||||
/*!
|
||||
Activate media content from playlist at position \a playlistPosition.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
void QMediaPlaylist::setCurrentIndex(int playlistPosition)
|
||||
@@ -671,7 +642,6 @@ void QMediaPlaylist::setCurrentIndex(int playlistPosition)
|
||||
|
||||
This signal is emitted after media has been inserted into the playlist.
|
||||
The new items are those between \a start and \a end inclusive.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
@@ -679,7 +649,6 @@ void QMediaPlaylist::setCurrentIndex(int playlistPosition)
|
||||
|
||||
This signal is emitted after media has been removed from the playlist.
|
||||
The removed items are those between \a start and \a end inclusive.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
@@ -687,68 +656,58 @@ void QMediaPlaylist::setCurrentIndex(int playlistPosition)
|
||||
|
||||
This signal is emitted after media has been changed in the playlist
|
||||
between \a start and \a end positions inclusive.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void QMediaPlaylist::currentIndexChanged(int position)
|
||||
|
||||
Signal emitted when playlist position changed to \a position.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void QMediaPlaylist::playbackModeChanged(QMediaPlaylist::PlaybackMode mode)
|
||||
|
||||
Signal emitted when playback mode changed to \a mode.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void QMediaPlaylist::mediaAboutToBeInserted(int start, int end)
|
||||
|
||||
Signal emitted when items are to be inserted at \a start and ending at \a end.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void QMediaPlaylist::mediaAboutToBeRemoved(int start, int end)
|
||||
|
||||
Signal emitted when item are to be deleted at \a start and ending at \a end.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void QMediaPlaylist::currentMediaChanged(const QMediaContent &content)
|
||||
|
||||
Signal emitted when current media changes to \a content.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\property QMediaPlaylist::currentIndex
|
||||
\brief Current position.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\property QMediaPlaylist::currentMedia
|
||||
\brief Current media content.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn QMediaPlaylist::loaded()
|
||||
|
||||
Signal emitted when playlist finished loading.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn QMediaPlaylist::loadFailed()
|
||||
|
||||
Signal emitted if failed to load playlist.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
|
||||
Reference in New Issue
Block a user