diff options
| author | Lars Knoll <lars.knoll@qt.io> | 2021-09-22 11:43:09 +0200 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2021-09-22 18:08:46 +0000 |
| commit | 36aaf5c58e016d858d93558eb15015f0b712cbe4 (patch) | |
| tree | fc4fd154c7d52d92432397dbacf9a22edaea60d4 /src/multimedia/qmediametadata.cpp | |
| parent | 0e8bc5f655c65adb2726a13852c8893e95e469d8 (diff) | |
Doc fixes for mediaMetaData
Use \qmlbasictype for value types, otherwise they are not
visible in the generated documentation.
Use lower case name as it is a value type and exported
that way.
Fix some signatures to be QML/JS compatible and not show
the C++ types.
Change-Id: I47270e95f865acb6c6da6f82bea85dabcc8d1c56
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Reviewed-by: Piotr Srebrny <piotr.srebrny@qt.io>
(cherry picked from commit 302c31f27812d6adecdb291797bef8cf771f08d0)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'src/multimedia/qmediametadata.cpp')
| -rw-r--r-- | src/multimedia/qmediametadata.cpp | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/src/multimedia/qmediametadata.cpp b/src/multimedia/qmediametadata.cpp index 7c81f3610..bee821fbd 100644 --- a/src/multimedia/qmediametadata.cpp +++ b/src/multimedia/qmediametadata.cpp @@ -108,7 +108,7 @@ QT_BEGIN_NAMESPACE */ /*! - \qmltype MediaMetaData + \qmlbasictype mediaMetaData \inqmlmodule QtMultimedia \since 6.2 \instantiates QMediaMetaData @@ -216,21 +216,21 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlmethod QVariant QtMultimedia::MediaMetaData::value(QMediaMetaData::Key key) + \qmlmethod variant QtMultimedia::mediaMetaData::value(QMediaMetaData::Key key) Returns the meta data value for Key \a key, or a null QVariant if no meta-data for the key is available. */ /*! - \fn QVariant QMediaMetaData::value(QMediaMetaData::Key key) const + \fn variant QMediaMetaData::value(QMediaMetaData::Key key) const Returns the meta data value for Key \a key, or a null QVariant is not meta data for the key is available. */ /*! - \qmlmethod bool QtMultimedia::MediaMetaData::isEmpty() + \qmlmethod bool QtMultimedia::mediaMetaData::isEmpty() Returns \c true if the meta data contains no items: otherwise returns \c{false}. */ @@ -240,7 +240,7 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlmethod void QtMultimedia::MediaMetaData::clear() + \qmlmethod void QtMultimedia::mediaMetaData::clear() Removes all data from the MediaMetaData object. */ @@ -250,7 +250,7 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlmethod void QtMultimedia::MediaMetaData::insert(QMediaMetaData::Key k, const QVariant &value) + \qmlmethod void QtMultimedia::mediaMetaData::insert(Key k, variant value) Inserts a \a value into a Key: \a{k}. */ @@ -259,7 +259,7 @@ QT_BEGIN_NAMESPACE Inserts a \a value into a Key: \a{k}. */ /*! - \qmlmethod void QtMultimedia::MediaMetaData::remove(QMediaMetaData::Key k) + \qmlmethod void QtMultimedia::mediaMetaData::remove(Key k) Removes meta data from a Key: \a{k}. */ @@ -269,8 +269,8 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlmethod QList QtMultimedia::MediaMetaData::keys() - Returns a QList of MediaMetaData.Keys. + \qmlmethod list<Key> QtMultimedia::mediaMetaData::keys() + Returns a list of MediaMetaData.Keys. */ /*! @@ -279,7 +279,7 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlmethod QString QtMultimedia::MediaMetaData::stringValue(QMediaMetaData::Key key) + \qmlmethod string QtMultimedia::mediaMetaData::stringValue(Key key) Returns the meta data for key \a key as a QString. This is mainly meant to simplify presenting the meta data to a user. @@ -343,7 +343,7 @@ QString QMediaMetaData::stringValue(QMediaMetaData::Key key) const return QString(); } /*! - \qmlmethod QString QtMultimedia::MediaMetaData::metaDataKeyToString(QMediaMetaData::Key key) + \qmlmethod string QtMultimedia::mediaMetaData::metaDataKeyToString(Key key) returns a string representation of \a key that can be used when presenting meta data to users. */ |