diff options
author | Michael Goddard <michael.goddard@nokia.com> | 2012-06-06 12:28:34 +1000 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-06-07 07:05:57 +0200 |
commit | f53788ae42175bd3b7cda1a18366086b285f6f1d (patch) | |
tree | ff0581a23c7ee28e4ada783867ab5e8685d6fa4e /src/multimedia | |
parent | a8ec84e3ca3abec75f99801db9128bf9ea490e31 (diff) |
A number of documentation fixes.
* Remove references to private QMediaServiceProvider class and point
new backend writers to irc/mailing lists
* Wrong or missing parameter names
* Fix a few links
* Correct a few property data types
* Various other things to keep qdoc happier
Change-Id: I5c8800d65c00f0783541afef35990bd3918acab7
Reviewed-by: Angus Cummings <angus.cummings@nokia.com>
Reviewed-by: Ling Hu <ling.hu@nokia.com>
Reviewed-by: Daniel Kovacic <daniel.kovacic@nokia.com>
Diffstat (limited to 'src/multimedia')
-rw-r--r-- | src/multimedia/audio/qaudiooutput.cpp | 2 | ||||
-rw-r--r-- | src/multimedia/controls/qmediarecordercontrol.cpp | 12 | ||||
-rw-r--r-- | src/multimedia/playback/qmediaplayer.cpp | 2 | ||||
-rw-r--r-- | src/multimedia/qmediaservice.cpp | 6 | ||||
-rw-r--r-- | src/multimedia/recording/qmediaencodersettings.cpp | 14 |
5 files changed, 19 insertions, 17 deletions
diff --git a/src/multimedia/audio/qaudiooutput.cpp b/src/multimedia/audio/qaudiooutput.cpp index 685667ee5..4150e8c23 100644 --- a/src/multimedia/audio/qaudiooutput.cpp +++ b/src/multimedia/audio/qaudiooutput.cpp @@ -379,7 +379,7 @@ QString QAudioOutput::category() const } /*! - Sets the audio category of this audio stream. + Sets the audio category of this audio stream to \a category. Some platforms can group audio streams into categories and manage their volumes independently, or display them diff --git a/src/multimedia/controls/qmediarecordercontrol.cpp b/src/multimedia/controls/qmediarecordercontrol.cpp index f7a486cfb..60414db60 100644 --- a/src/multimedia/controls/qmediarecordercontrol.cpp +++ b/src/multimedia/controls/qmediarecordercontrol.cpp @@ -54,14 +54,14 @@ QT_BEGIN_NAMESPACE \brief The QMediaRecorderControl class provides access to the recording functionality of a QMediaService. + Generally you will use the QMediaRecorder class in application code - this + class is mostly used when implementing a new QMediaService or if there is + access to specific low level functionality not otherwise present in QMediaRecorder. + If a QMediaService can record media it will implement QMediaRecorderControl. This control provides a means to set the \l {outputLocation()}{output location}, - and \l {record()}{start}, \l {pause()}{pause} and \l {stop()}{stop} - recording. It also provides feedback on the \l {duration()}{duration} - of the recording. - - The functionality provided by this control is exposed to application - code through the QMediaRecorder class. + and record, pause and stop recording via the \l setState() method. It also + provides feedback on the \l {duration()}{duration} of the recording. The interface name of QMediaRecorderControl is \c org.qt-project.qt.mediarecordercontrol/5.0 as defined in QMediaRecorderControl_iid. diff --git a/src/multimedia/playback/qmediaplayer.cpp b/src/multimedia/playback/qmediaplayer.cpp index 3b1b06b3b..067893ef1 100644 --- a/src/multimedia/playback/qmediaplayer.cpp +++ b/src/multimedia/playback/qmediaplayer.cpp @@ -83,7 +83,7 @@ QT_BEGIN_NAMESPACE functions for things like: \list - \li Accessing the currently playing media's metadata (\l {QMediaObject::metaData()} and \l predefined \l {QtMultimedia::MetaData}{meta-data keys}) + \li Accessing the currently playing media's metadata (\l {QMediaObject::metaData()} and \l {QtMultimedia::MetaData}{predefined meta-data keys}) \li Checking to see if the media playback service is currently available (\l {QMediaObject::availabilityError()}) \endlist diff --git a/src/multimedia/qmediaservice.cpp b/src/multimedia/qmediaservice.cpp index 8ab2cb8a5..3488d082b 100644 --- a/src/multimedia/qmediaservice.cpp +++ b/src/multimedia/qmediaservice.cpp @@ -76,9 +76,11 @@ QT_BEGIN_NAMESPACE Media objects can use services loaded dynamically from plug-ins or implemented statically within an applications. Plug-in based services should also implement the QMediaServiceProviderPlugin interface. Static - services should implement the QMediaServiceProvider interface. + services should implement the QMediaServiceProvider interface. In general, + implementing a QMediaService is outside of the scope of this documentation + and support on the relevant mailing lists or IRC channels should be sought. - \sa QMediaObject, QMediaControl, QMediaServiceProvider, QMediaServiceProviderPlugin + \sa QMediaObject, QMediaControl */ /*! diff --git a/src/multimedia/recording/qmediaencodersettings.cpp b/src/multimedia/recording/qmediaencodersettings.cpp index edb72b511..fa79e5133 100644 --- a/src/multimedia/recording/qmediaencodersettings.cpp +++ b/src/multimedia/recording/qmediaencodersettings.cpp @@ -342,7 +342,7 @@ QVariantMap QAudioEncoderSettings::encodingOptions() const } /*! - Set the encoding \a option \a value. + Set the encoding \a option to \a value. The supported set and meaning of encoding options are system and selected codec specific. @@ -359,12 +359,12 @@ void QAudioEncoderSettings::setEncodingOption(const QString &option, const QVari } /*! - Replace all the \a encoding options. + Replace all the encoding options with \a options. The supported set and meaning of encoding options are system and selected codec specific. - \sa encodingOption(), setEncodingOptions() + \sa encodingOption(), setEncodingOption() */ void QAudioEncoderSettings::setEncodingOptions(const QVariantMap &options) { @@ -687,12 +687,12 @@ void QVideoEncoderSettings::setEncodingOption(const QString &option, const QVari } /*! - Replace all the \a encoding options. + Replace all the encoding options with \a options. The supported set and meaning of encoding options are system and selected codec specific. - \sa encodingOption(), setEncodingOptions() + \sa encodingOption(), setEncodingOption() */ void QVideoEncoderSettings::setEncodingOptions(const QVariantMap &options) { @@ -932,12 +932,12 @@ void QImageEncoderSettings::setEncodingOption(const QString &option, const QVari } /*! - Replace all the \a encoding options. + Replace all the encoding options with \a options. The supported set and meaning of encoding options are system and selected codec specific. - \sa encodingOption(), setEncodingOptions() + \sa encodingOption(), setEncodingOption() */ void QImageEncoderSettings::setEncodingOptions(const QVariantMap &options) { |