diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2018-04-17 11:55:41 +0200 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@qt.io> | 2018-04-19 09:37:51 +0000 |
| commit | 700e1aa69744565b5327f6a5b185cffb9c9c149f (patch) | |
| tree | f8168c29b6fe0ce34514c5b242e25638c095d653 /src/multimedia/controls/qmediastreamscontrol.cpp | |
| parent | 6d56f614065e7b006a4958c848e13cabb0a68adb (diff) | |
Doc: Fix documentation warnings
Add a custom module header, used only for documentation builds, that
pulls in also the QtMultimediaWidgets module.
Several documentation fixes to clean up warnings from clang.
Task-number: QTBUG-67790
Change-Id: I6c1013798a648250c8555eb92684ec3b33ff7531
Reviewed-by: Martin Smith <martin.smith@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Diffstat (limited to 'src/multimedia/controls/qmediastreamscontrol.cpp')
| -rw-r--r-- | src/multimedia/controls/qmediastreamscontrol.cpp | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/src/multimedia/controls/qmediastreamscontrol.cpp b/src/multimedia/controls/qmediastreamscontrol.cpp index ad1c62f15..2daf50de8 100644 --- a/src/multimedia/controls/qmediastreamscontrol.cpp +++ b/src/multimedia/controls/qmediastreamscontrol.cpp @@ -113,30 +113,30 @@ QMediaStreamsControl::~QMediaStreamsControl() */ /*! - \fn QMediaStreamsControl::streamType(int stream) + \fn QMediaStreamsControl::streamType(int streamNumber) - Return the type of a media \a stream. + Return the type of media stream \a streamNumber. */ /*! - \fn QMediaStreamsControl::metaData(int stream, const QString &key) + \fn QMediaStreamsControl::metaData(int streamNumber, const QString &key) - Returns the meta-data value of \a key for a given \a stream. + Returns the meta-data value of \a key for the given \a streamNumber. Useful metadata keys are QMediaMetaData::Title, QMediaMetaData::Description and QMediaMetaData::Language. */ /*! - \fn QMediaStreamsControl::isActive(int stream) + \fn QMediaStreamsControl::isActive(int streamNumber) - Returns true if the media \a stream is active. + Returns true if the media stream \a streamNumber is active. */ /*! - \fn QMediaStreamsControl::setActive(int stream, bool state) + \fn QMediaStreamsControl::setActive(int streamNumber, bool state) - Sets the active \a state of a media \a stream. + Sets the active \a state of media stream \a streamNumber. Setting the active state of a media stream to true will activate it. If any other stream of the same type was previously active it will be deactivated. Setting the active state fo a |