summaryrefslogtreecommitdiffstats
path: root/src/imports
diff options
context:
space:
mode:
authorAngus Cummings <angus.cummings@nokia.com>2012-04-30 16:49:23 +1000
committerQt by Nokia <qt-info@nokia.com>2012-05-16 05:21:25 +0200
commit9e6d03584a097964e5f08c46cd02338b0b043080 (patch)
treed00b2c09412236e387337890bb2260dc2d3741d6 /src/imports
parentfdb5c419c4fb7b1ae0268e496ccdd0ffa03b74ce (diff)
Minor doc fixes for QML
renaming QML element to QML type removing some \fn tags that were making the docs not build some rewording some new signal docs Change-Id: I9b350dad1780276959aef4105e53b91082a6083e Reviewed-by: Dmytro Poplavskiy <dmytro.poplavskiy@nokia.com>
Diffstat (limited to 'src/imports')
-rw-r--r--src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp12
-rw-r--r--src/imports/audioengine/qdeclarative_audiocategory_p.cpp16
-rw-r--r--src/imports/audioengine/qdeclarative_audioengine_p.cpp56
-rw-r--r--src/imports/audioengine/qdeclarative_audiolistener_p.cpp8
-rw-r--r--src/imports/audioengine/qdeclarative_audiosample_p.cpp10
-rw-r--r--src/imports/audioengine/qdeclarative_playvariation_p.cpp6
-rw-r--r--src/imports/audioengine/qdeclarative_sound_p.cpp8
-rw-r--r--src/imports/audioengine/qdeclarative_soundinstance_p.cpp28
-rw-r--r--src/imports/multimedia/Video.qml24
-rw-r--r--src/imports/multimedia/multimedia.cpp24
-rw-r--r--src/imports/multimedia/qdeclarativeaudio.cpp49
-rw-r--r--src/imports/multimedia/qdeclarativecamera.cpp35
-rw-r--r--src/imports/multimedia/qdeclarativecameracapture.cpp31
-rw-r--r--src/imports/multimedia/qdeclarativecameraexposure.cpp12
-rw-r--r--src/imports/multimedia/qdeclarativecameraflash.cpp19
-rw-r--r--src/imports/multimedia/qdeclarativecamerafocus.cpp16
-rw-r--r--src/imports/multimedia/qdeclarativecameraimageprocessing.cpp12
-rw-r--r--src/imports/multimedia/qdeclarativecamerarecorder.cpp10
-rw-r--r--src/imports/multimedia/qdeclarativeradio.cpp16
-rw-r--r--src/imports/multimedia/qdeclarativeradiodata.cpp20
-rw-r--r--src/imports/multimedia/qdeclarativetorch.cpp4
-rw-r--r--src/imports/multimedia/qdeclarativevideooutput.cpp10
22 files changed, 231 insertions, 195 deletions
diff --git a/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp b/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp
index 4d2fca3a3..e1a4ac004 100644
--- a/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp
+++ b/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp
@@ -92,16 +92,15 @@ void QDeclarativeAttenuationModel::setName(const QString& name)
/*!
\qmlclass AttenuationModelLinear QDeclarativeAttenuationModelLinear
\since 5.0
- \brief The AttenuationModelLinear element allows you to define a linear attenuation curve for
- Sound element.
+ \brief Defines a linear attenuation curve for a \l Sound.
\inqmlmodule QtAudioEngine 1
\ingroup multimedia_audioengine
\inherits Item
\preliminary
- This element is part of the \b{QtAudioEngine 1.0} module.
+ This type is part of the \b{QtAudioEngine 1.0} module.
- AttenuationModelLinear must be defined inside AudioEngine.
+ AttenuationModelLinear must be defined inside \l AudioEngine.
\qml
import QtQuick 2.0
@@ -224,14 +223,13 @@ qreal QDeclarativeAttenuationModelLinear::calculateGain(const QVector3D &listene
/*!
\qmlclass AttenuationModelInverse QDeclarativeAttenuationModelInverse
\since 5.0
- \brief The AttenuationModelInverse element allows you to define a non-linear attenuation curve
- for Sound element.
+ \brief Defines a non-linear attenuation curve for a \l Sound.
\inmodule QtMultimedia
\ingroup multimedia_audioengine
\inherits Item
\preliminary
- This element is part of the \b{QtAudioEngine 1.0} module.
+ This type is part of the \b{QtAudioEngine 1.0} module.
AttenuationModelInverse must be defined inside AudioEngine.
diff --git a/src/imports/audioengine/qdeclarative_audiocategory_p.cpp b/src/imports/audioengine/qdeclarative_audiocategory_p.cpp
index e34541728..1c78bd8bd 100644
--- a/src/imports/audioengine/qdeclarative_audiocategory_p.cpp
+++ b/src/imports/audioengine/qdeclarative_audiocategory_p.cpp
@@ -49,15 +49,15 @@ QT_USE_NAMESPACE
/*!
\qmlclass AudioCategory QDeclarativeAudioCategory
\since 5.0
- \brief The AudioCategory element allows you to control all active sound instances by group
+ \brief Control all active sound instances by group.
\inqmlmodule QtAudioEngine 1
\ingroup multimedia_audioengine
\inherits Item
\preliminary
- This element is part of the \b{QtAudioEngine 1.0} module.
+ This type is part of the \b{QtAudioEngine 1.0} module.
- AudioCategory element can be accessed through QtAudioEngine1::AudioEngine::categories with its
+ An instance of AudioCategory can be accessed through QtAudioEngine1::AudioEngine::categories with its
unique name and must be defined inside AudioEngine.
\qml
@@ -100,11 +100,11 @@ QT_USE_NAMESPACE
}
\endqml
- Sound elements can be grouped togather by specifying the category property. When you change the
- volume of a category, all audio output from related elements will be affected as well.
+ \l Sound instances can be grouped together by specifying the category property. When you change the
+ volume of a category, all audio output from related instances will be affected as well.
Note: there will always be an AudioCategory named \c default whether you explicitly define it or
- not. If you do not specify any category for a Sound element, it will be grouped into the \c default
+ not. If you do not specify any category for a \l Sound, it will be grouped into the \c default
category.
*/
@@ -140,7 +140,7 @@ void QDeclarativeAudioCategory::componentComplete()
\qmlproperty real QtAudioEngine1::AudioCategory::volume
This property holds the volume of the category and will modulate all audio output from the
- element which belongs to this category.
+ instances which belong to this category.
*/
qreal QDeclarativeAudioCategory::volume() const
{
@@ -162,7 +162,7 @@ void QDeclarativeAudioCategory::setVolume(qreal volume)
\qmlproperty string QtAudioEngine1::AudioCategory::name
This property holds the name of AudioCategory. The name must be unique among all categories and only
- defined once.
+ defined once. The name cannot be changed after the instance has been initialized.
*/
void QDeclarativeAudioCategory::setName(const QString& name)
{
diff --git a/src/imports/audioengine/qdeclarative_audioengine_p.cpp b/src/imports/audioengine/qdeclarative_audioengine_p.cpp
index dce97f87e..fa7c1919c 100644
--- a/src/imports/audioengine/qdeclarative_audioengine_p.cpp
+++ b/src/imports/audioengine/qdeclarative_audioengine_p.cpp
@@ -58,13 +58,13 @@ QT_USE_NAMESPACE
/*!
\qmlclass AudioEngine QDeclarativeAudioEngine
\since 5.0
- \brief The AudioEngine element allows you to organize all your 3d audio content in one place.
+ \brief The AudioEngine type allows you to organize all your 3d audio content in one place.
\inqmlmodule QtAudioEngine 1
\ingroup multimedia_audioengine
\inherits Item
\preliminary
- This element is part of the \b{QtAudioEngine 1.0} module.
+ \c AudioEngine is part of the \b{QtAudioEngine 1.0} module.
\qml
import QtQuick 2.0
@@ -91,7 +91,7 @@ QT_USE_NAMESPACE
}
dopplerFactor: 1
- speedOfSound: 343.33
+ speedOfSound: 343.33 // Approximate speed of sound in air at 20 degrees Celsius
listener.up:"0,0,1"
listener.position:"0,0,0"
@@ -108,10 +108,10 @@ QT_USE_NAMESPACE
}
\endqml
- The \c AudioEngine element acts as a central library for configuring all 3d audio content in an
- app, so you should define only one such element in your app.
+ \c AudioEngine acts as a central library for configuring all 3d audio content in an
+ app, so you should define only one in your app.
- It is mostly used as a container to access other elements such as AudioCategory, AudioSample and
+ It is mostly used as a container to access other types such as AudioCategory, AudioSample and
Sound.
\sa AudioCategory, AudioSample, Sound, SoundInstance, AttenuationModelLinear, AttenuationModelInverse
@@ -409,7 +409,7 @@ QQmlListProperty<QObject> QDeclarativeAudioEngine::bank()
/*!
\qmlproperty map QtAudioEngine1::AudioEngine::categories
- Container of all AudioCategory elements.
+ Container of all AudioCategory instances.
*/
QObject* QDeclarativeAudioEngine::categories()
{
@@ -419,7 +419,7 @@ QObject* QDeclarativeAudioEngine::categories()
/*!
\qmlproperty map QtAudioEngine1::AudioEngine::samples
- Container of all AudioSample elements.
+ Container of all AudioSample instances.
*/
QObject* QDeclarativeAudioEngine::samples()
{
@@ -429,7 +429,7 @@ QObject* QDeclarativeAudioEngine::samples()
/*!
\qmlproperty map QtAudioEngine1::AudioEngine::sounds
- Container of all Sound elements.
+ Container of all Sound instances.
*/
QObject* QDeclarativeAudioEngine::sounds()
{
@@ -467,8 +467,11 @@ void QDeclarativeAudioEngine::setDopplerFactor(qreal dopplerFactor)
/*!
\qmlproperty real QtAudioEngine1::AudioEngine::speedOfSound
- This property holds the reference value of the sound speed which will be used in doppler shift
- calculation.
+ This property holds the reference value of the sound speed (in meters per second)
+ which will be used in doppler shift calculation. The doppler shift calculation is
+ used to emulate the change in frequency in sound that is perceived by an observer when
+ the sound source is travelling towards or away from the observer. The speed of sound
+ depends on the medium the sound is propagating through.
*/
qreal QDeclarativeAudioEngine::speedOfSound() const
{
@@ -481,7 +484,7 @@ void QDeclarativeAudioEngine::setSpeedOfSound(qreal speedOfSound)
}
/*!
- \qmlproperty real QtAudioEngine1::AudioEngine::loading
+ \qmlproperty bool QtAudioEngine1::AudioEngine::loading
This property indicates if the audio engine is loading any audio sample at the moment. This may
be useful if you specified the preloaded property in AudioSample and would like to show a loading screen
@@ -501,21 +504,38 @@ void QDeclarativeAudioEngine::handleLoadingChanged()
}
/*!
- \qmlsignal QtAudioEngine1::AudioEngine::onLiveInstancesChanged()
+ \qmlsignal QtAudioEngine1::AudioEngine::finishedLoading()
+
+ This signal is emitted when \l loading has completed.
- This handler is called when \l liveInstances is changed
+ The corresponding handler is \c onFinishedLoading.
*/
/*!
- \qmlsignal QtAudioEngine1::AudioEngine::onLoadingChanged()
+ \qmlsignal QtAudioEngine1::AudioEngine::ready()
+
+ This signal is emitted when the AudioEngine is ready to use.
- This handler is called when \l loading is changed
+ The corresponding handler is \c onReady.
*/
/*!
- \qmlsignal QtAudioEngine1::AudioEngine::finishedLoading()
+ \qmlsignal QtAudioEngine1::AudioEngine::liveInstanceCountChanged()
+
+ This signal is emitted when the number of live instances managed by the
+ AudioEngine is changed.
+
+ The corresponding handler is \c onLiveInstanceCountChanged.
+*/
+
+/*!
+ \qmlsignal QtAudioEngine1::AudioEngine::isLoadingChanged()
- This handler is called when \l loading is finished
+ This signal is emitted when the \l loading property changes.
+
+ The corresponding handler is \c onIsLoadingChanged.
*/
+
+
QT_END_NAMESPACE
diff --git a/src/imports/audioengine/qdeclarative_audiolistener_p.cpp b/src/imports/audioengine/qdeclarative_audiolistener_p.cpp
index ea269053a..77851332b 100644
--- a/src/imports/audioengine/qdeclarative_audiolistener_p.cpp
+++ b/src/imports/audioengine/qdeclarative_audiolistener_p.cpp
@@ -50,13 +50,13 @@ QT_USE_NAMESPACE
/*!
\qmlclass AudioListener QDeclarativeAudioListener
\since 5.0
- \brief The AudioListener element allows you to control global listener parameters.
+ \brief The AudioListener type allows you to control global listener parameters.
\inqmlmodule QtAudioEngine 1
\ingroup multimedia_audioengine
\inherits Item
\preliminary
- This element is part of the \b{QtAudioEngine 1.0} module.
+ This type is part of the \b{QtAudioEngine 1.0} module.
AudioListener will have only one global instance and you can either access it through the
listener property of AudioEngine:
@@ -97,7 +97,7 @@ QT_USE_NAMESPACE
}
\endqml
- or alternatively, by defining an AudioListener element outside AudioEngine:
+ or alternatively, by defining an AudioListener outside AudioEngine:
\qml
import QtQuick 2.0
@@ -248,7 +248,7 @@ void QDeclarativeAudioListener::setUp(const QVector3D &up)
/*!
\qmlproperty real QtAudioEngine1::AudioListener::gain
- This property will modulate all audio output from audio engine elements.
+ This property will modulate all audio output from audio engine instances.
*/
qreal QDeclarativeAudioListener::gain() const
{
diff --git a/src/imports/audioengine/qdeclarative_audiosample_p.cpp b/src/imports/audioengine/qdeclarative_audiosample_p.cpp
index 6a33e86a5..fe80989ee 100644
--- a/src/imports/audioengine/qdeclarative_audiosample_p.cpp
+++ b/src/imports/audioengine/qdeclarative_audiosample_p.cpp
@@ -52,15 +52,15 @@ QT_USE_NAMESPACE
/*!
\qmlclass AudioSample QDeclarativeAudioSample
\since 5.0
- \brief The AudioSample element allows you to load audio samples, mostly wav file.
+ \brief The AudioSample type allows you to load audio samples, mostly wav file.
\inqmlmodule QtAudioEngine 1
\ingroup multimedia_audioengine
\inherits Item
\preliminary
- This element is part of the \b{QtAudioEngine 1.0} module.
+ \c AudioSample is part of the \b{QtAudioEngine 1.0} module.
- AudioSample element can be accessed through QtAudioEngine1::AudioEngine::samples with its unique
+ It can be accessed through QtAudioEngine1::AudioEngine::samples with its unique
name and must be defined inside AudioEngine.
\qml
@@ -135,9 +135,9 @@ bool QDeclarativeAudioSample::isStreaming() const
/*!
\qmlproperty bool QtAudioEngine1::AudioSample::preloaded
- This property holds indicates whether this sample needs to be preloaded or not.
+ This property indicates whether this sample needs to be preloaded or not.
If true, the audio engine will start loading the sample file immediately when the app started,
- otherwise the sample will not be loaded untill be used by other element.
+ otherwise the sample will not be loaded until explicitly requested.
*/
bool QDeclarativeAudioSample::isPreloaded() const
diff --git a/src/imports/audioengine/qdeclarative_playvariation_p.cpp b/src/imports/audioengine/qdeclarative_playvariation_p.cpp
index f46170689..fd6456a0a 100644
--- a/src/imports/audioengine/qdeclarative_playvariation_p.cpp
+++ b/src/imports/audioengine/qdeclarative_playvariation_p.cpp
@@ -51,7 +51,7 @@ QT_USE_NAMESPACE
/*!
\qmlclass PlayVariation QDeclarativePlayVariation
\since 5.0
- \brief The PlayVariation element allows you to define a playback variation for \l Sound element.
+ \brief The PlayVariation type allows you to define a playback variation for \l {Sound} {sounds}.
So each time the playback of the same sound can be a slightly different even with the same
AudioSample.
@@ -60,9 +60,9 @@ QT_USE_NAMESPACE
\inherits Item
\preliminary
- This element is part of the \b{QtAudioEngine 1.0} module.
+ This type is part of the \b{QtAudioEngine 1.0} module.
- PlayVariation must be defined inside \l Sound element.
+ PlayVariation must be defined inside a \l Sound.
\qml
import QtQuick 2.0
diff --git a/src/imports/audioengine/qdeclarative_sound_p.cpp b/src/imports/audioengine/qdeclarative_sound_p.cpp
index 5b333c22d..e775d1dbb 100644
--- a/src/imports/audioengine/qdeclarative_sound_p.cpp
+++ b/src/imports/audioengine/qdeclarative_sound_p.cpp
@@ -140,16 +140,16 @@ void QDeclarativeSoundCone::componentComplete()
/*!
\qmlclass Sound QDeclarativeSound
\since 5.0
- \brief The Sound element allows you to define a variety of samples and parameters to be used for
+ \brief The Sound type allows you to define a variety of samples and parameters to be used for
SoundInstance.
\inqmlmodule QtAudioEngine 1
\ingroup multimedia_audioengine
\inherits Item
\preliminary
- This element is part of the \b{QtAudioEngine 1.0} module.
+ This type is part of the \b{QtAudioEngine 1.0} module.
- Sound element can be accessed through QtAudioEngine1::AudioEngine::sounds with its unique name
+ Sound can be accessed through QtAudioEngine1::AudioEngine::sounds with its unique name
and must be defined inside AudioEngine.
\qml
@@ -227,7 +227,7 @@ void QDeclarativeSound::componentComplete()
}
/*!
- \qmlproperty enueration QtAudioEngine1::Sound::playType
+ \qmlproperty enumeration QtAudioEngine1::Sound::playType
This property holds the playType. It can be one of:
diff --git a/src/imports/audioengine/qdeclarative_soundinstance_p.cpp b/src/imports/audioengine/qdeclarative_soundinstance_p.cpp
index 7b852d95d..b5763df14 100644
--- a/src/imports/audioengine/qdeclarative_soundinstance_p.cpp
+++ b/src/imports/audioengine/qdeclarative_soundinstance_p.cpp
@@ -53,16 +53,16 @@ QT_USE_NAMESPACE
/*!
\qmlclass SoundInstance QDeclarativeSoundInstance
\since 5.0
- \brief The SoundInstance element allows you to play 3d audio content.
+ \brief The SoundInstance type allows you to play 3d audio content.
\inqmlmodule QtAudioEngine 1
\ingroup multimedia_audioengine
\inherits Item
\preliminary
- This element is part of the \b{QtAudioEngine 1.0} module.
+ This type is part of the \b{QtAudioEngine 1.0} module.
There are two ways to create SoundInstance objects. You can obtain it by calling newInstance
- method of Sound element:
+ method of a \l Sound:
\qml
import QtQuick 2.0
@@ -101,7 +101,7 @@ QT_USE_NAMESPACE
}
\endqml
- Or alternatively, you can explicitly define SoundInstance element outside of AudioEngine for
+ Or alternatively, you can explicitly define SoundInstance outside of AudioEngine for
easier qml bindings:
\qml
@@ -236,7 +236,7 @@ QDeclarativeSoundInstance::~QDeclarativeSoundInstance()
\qmlproperty string QtAudioEngine1::SoundInstance::sound
This property specifies which Sound this SoundInstance will use. Unlike some properties in
- other elements, this property can be changed dynamically.
+ other types, this property can be changed dynamically.
*/
QString QDeclarativeSoundInstance::sound() const
{
@@ -258,7 +258,7 @@ void QDeclarativeSoundInstance::setSound(const QString& sound)
}
#ifdef DEBUG_AUDIOENGINE
- qDebug() << "SoundInstance Element switch sound from [" << m_sound << "] to [" << sound << "]";
+ qDebug() << "SoundInstance switch sound from [" << m_sound << "] to [" << sound << "]";
#endif
stop();
@@ -297,11 +297,17 @@ void QDeclarativeSoundInstance::dropInstance()
This property holds the current playback state. It can be one of:
- \list
- \li StopppedState
- \li PlayingState
- \li PausedState
- \endlist
+ \table
+ \header \li Value \li Description
+ \row \li StopppedState
+ \li The SoundInstance is not playing, and when playback begins next it
+ will play from position zero.
+ \row \li PlayingState
+ \li The SoundInstance is playing the media.
+ \row \li PausedState
+ \li The SoundInstance is not playing, and when playback begins next it
+ will play from the position that it was paused at.
+ \endtable
*/
QDeclarativeSoundInstance::State QDeclarativeSoundInstance::state() const
{
diff --git a/src/imports/multimedia/Video.qml b/src/imports/multimedia/Video.qml
index e3a70ed17..d8e1b8d9a 100644
--- a/src/imports/multimedia/Video.qml
+++ b/src/imports/multimedia/Video.qml
@@ -47,12 +47,12 @@ import QtMultimedia 5.0
\inherits Item
\ingroup multimedia_qml
\ingroup multimedia_video_qml
- \brief A convenience element for showing a specified video
+ \brief A convenience type for showing a specified video
- The \c Video element is a convenience element combining the functionality
- of the \l MediaPlayer and \l VideoOutput elements into one. It provides
- simple video playback functionality without having to specify multiple
- elements.
+ \c Video is a convenience type combining the functionality
+ of a \l MediaPlayer and a \l VideoOutput into one. It provides
+ simple video playback functionality without having to declare multiple
+ types.
\qml
import QtQuick 2.0
@@ -78,7 +78,7 @@ import QtMultimedia 5.0
}
\endqml
- The Video element supports untransformed, stretched, and uniformly scaled
+ \c Video supports untransformed, stretched, and uniformly scaled
video presentation. For a description of stretched uniformly scaled
presentation, see the \l fillMode property description.
@@ -87,8 +87,8 @@ import QtMultimedia 5.0
\section1 Screen Saver
If it is likely that an application will be playing video for an extended
- period of time without user interaction it may be necessary to disable
- the platform's screen saver. The \l ScreenSaver element (from \l QtSystemInfo)
+ period of time without user interaction, it may be necessary to disable
+ the platform's screen saver. The \l ScreenSaver (from \l QtSystemInfo)
may be used to disable the screensaver in this fashion:
\qml
@@ -116,8 +116,8 @@ Item {
if necessary
\endlist
- Because this element is a convenience element in QML, it does not
- support enumerations directly, so enumerations from VideoOuput are
+ Because this type is for convenience in QML, it does not
+ support enumerations directly, so enumerations from \c VideoOuput are
used to access the available fill modes.
The default fill mode is preserveAspectFit.
@@ -127,7 +127,7 @@ Item {
/*!
\qmlproperty int Video::orientation
- The orientation of the Video element in degrees. Only multiples of 90
+ The orientation of the \c Video in degrees. Only multiples of 90
degrees is supported, that is 0, 90, 180, 270, 360, etc.
*/
property alias orientation: videoOut.orientation
@@ -209,7 +209,7 @@ Item {
/*!
\qmlproperty enumeration Video::availability
- Returns the availability state of the video element.
+ Returns the availability state of the video instance.
This is one of:
\table
diff --git a/src/imports/multimedia/multimedia.cpp b/src/imports/multimedia/multimedia.cpp
index 02c0343e3..c07d1dcc3 100644
--- a/src/imports/multimedia/multimedia.cpp
+++ b/src/imports/multimedia/multimedia.cpp
@@ -82,17 +82,17 @@ public:
qmlRegisterType<QDeclarativeRadioData>(uri, 4, 0, "RadioData");
qmlRegisterType<QDeclarativeCamera>(uri, 4, 0, "Camera");
qmlRegisterUncreatableType<QDeclarativeCameraCapture>(uri, 4, 0, "CameraCapture",
- trUtf8("CameraCapture is only provided by Camera element"));
+ trUtf8("CameraCapture is provided by Camera"));
qmlRegisterUncreatableType<QDeclarativeCameraRecorder>(uri, 4, 0, "CameraRecorder",
- trUtf8("CameraRecorder is only provided by Camera element"));
+ trUtf8("CameraRecorder is provided by Camera"));
qmlRegisterUncreatableType<QDeclarativeCameraExposure>(uri, 4, 0, "CameraExposure",
- trUtf8("CameraExposure is only provided by Camera element"));
+ trUtf8("CameraExposure is provided by Camera"));
qmlRegisterUncreatableType<QDeclarativeCameraFocus>(uri, 4, 0, "CameraFocus",
- trUtf8("CameraFocus is only provided by Camera element"));
+ trUtf8("CameraFocus is provided by Camera"));
qmlRegisterUncreatableType<QDeclarativeCameraFlash>(uri, 4, 0, "CameraFlash",
- trUtf8("CameraFlash is only provided by Camera element"));
+ trUtf8("CameraFlash is provided by Camera"));
qmlRegisterUncreatableType<QDeclarativeCameraImageProcessing>(uri, 4, 0, "CameraImageProcessing",
- trUtf8("CameraImageProcessing is only provided by Camera element"));
+ trUtf8("CameraImageProcessing is only provided by Camera type"));
// Introduced to help transition from QtMultimedia 4.0 to 5.0 (official for Qt 5)
// the 4.0 versioned types will be removed once all clients have made the transition.
@@ -105,17 +105,17 @@ public:
qmlRegisterType<QDeclarativeCamera>(uri, 5, 0, "Camera");
qmlRegisterType<QDeclarativeTorch>(uri, 5, 0, "Torch");
qmlRegisterUncreatableType<QDeclarativeCameraCapture>(uri, 5, 0, "CameraCapture",
- trUtf8("CameraCapture is only provided by Camera element"));
+ trUtf8("CameraCapture is provided by Camera"));
qmlRegisterUncreatableType<QDeclarativeCameraRecorder>(uri, 5, 0, "CameraRecorder",
- trUtf8("CameraRecorder is only provided by Camera element"));
+ trUtf8("CameraRecorder is provided by Camera"));
qmlRegisterUncreatableType<QDeclarativeCameraExposure>(uri, 5, 0, "CameraExposure",
- trUtf8("CameraExposure is only provided by Camera element"));
+ trUtf8("CameraExposure is provided by Camera"));
qmlRegisterUncreatableType<QDeclarativeCameraFocus>(uri, 5, 0, "CameraFocus",
- trUtf8("CameraFocus is only provided by Camera element"));
+ trUtf8("CameraFocus is provided by Camera"));
qmlRegisterUncreatableType<QDeclarativeCameraFlash>(uri, 5, 0, "CameraFlash",
- trUtf8("CameraFlash is only provided by Camera element"));
+ trUtf8("CameraFlash is provided by Camera"));
qmlRegisterUncreatableType<QDeclarativeCameraImageProcessing>(uri, 5, 0, "CameraImageProcessing",
- trUtf8("CameraImageProcessing is only provided by Camera element"));
+ trUtf8("CameraImageProcessing is provided by Camera"));
qmlRegisterType<QDeclarativeMediaMetaData>();
}
diff --git a/src/imports/multimedia/qdeclarativeaudio.cpp b/src/imports/multimedia/qdeclarativeaudio.cpp
index c124c2412..6efdb1afa 100644
--- a/src/imports/multimedia/qdeclarativeaudio.cpp
+++ b/src/imports/multimedia/qdeclarativeaudio.cpp
@@ -58,14 +58,14 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass MediaPlayer
- \brief The MediaPlayer element allows you to add media playback to a scene.
+ \brief The MediaPlayer type allows you to add media playback to a scene.
\inqmlmodule QtMultimedia 5
\ingroup multimedia_qml
\ingroup multimedia_audio_qml
\ingroup multimedia_video_qml
- This element is part of the \b{QtMultimedia 5.0} module.
+ MediaPlayer is part of the \b{QtMultimedia 5.0} module.
\qml
import QtQuick 2.0
@@ -88,8 +88,8 @@ QT_BEGIN_NAMESPACE
}
\endqml
- You can use MediaPlayer by itself to play audio content (like the \l Audio element),
- or you can use it in conjunction with a \l VideoOutput element for rendering video.
+ You can use MediaPlayer by itself to play audio content (like \l Audio),
+ or you can use it in conjunction with a \l VideoOutput for rendering video.
\qml
import QtQuick 2.0
@@ -119,13 +119,13 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass Audio QDeclarativeAudio
- \brief The Audio element allows you to add audio playback to a scene.
+ \brief The Audio type allows you to add audio playback to a scene.
\inqmlmodule QtMultimedia 5
\ingroup multimedia_qml
\ingroup multimedia_audio_qml
- This element is part of the \b{QtMultimedia 5.0} module.
+ This type is part of the \b{QtMultimedia 5.0} module.
\qml
import QtQuick 2.0
@@ -495,7 +495,7 @@ void QDeclarativeAudio::stop()
*/
/*!
- \qmlproperty url QtMultimedia5::Audio::autoLoad
+ \qmlproperty bool QtMultimedia5::Audio::autoLoad
This property indicates if loading of media should begin immediately.
@@ -569,7 +569,7 @@ QDeclarativeAudio::PlaybackState QDeclarativeAudio::playbackState() const
}
/*!
- \qmlproperty int QtMultimedia5::Audio::autoPlay
+ \qmlproperty bool QtMultimedia5::Audio::autoPlay
This property controls whether the media will begin to play on start up.
@@ -596,12 +596,16 @@ QDeclarativeAudio::PlaybackState QDeclarativeAudio::playbackState() const
\qmlproperty real QtMultimedia5::Audio::volume
This property holds the volume of the audio output, from 0.0 (silent) to 1.0 (maximum volume).
+
+ Defaults to 1.0.
*/
/*!
\qmlproperty bool QtMultimedia5::Audio::muted
This property holds whether the audio output is muted.
+
+ Defaults to false.
*/
/*!
@@ -645,6 +649,8 @@ bool QDeclarativeAudio::hasVideo() const
\qmlproperty real QtMultimedia5::Audio::playbackRate
This property holds the rate at which audio is played at as a multiple of the normal rate.
+
+ Defaults to 1.0.
*/
/*!
@@ -652,15 +658,22 @@ bool QDeclarativeAudio::hasVideo() const
This property holds the error state of the audio. It can be one of:
- \list
- \li NoError - there is no current error.
- \li ResourceError - the audio cannot be played due to a problem allocating resources.
- \li FormatError - the audio format is not supported.
- \li NetworkError - the audio cannot be played due to network issues.
- \li AccessDenied - the audio cannot be played due to insufficient permissions.
- \li ServiceMissing - the audio cannot be played because the media service could not be
+ \table
+ \header \li Value \li Description
+ \row \li NoError
+ \li There is no current error.
+ \row \li ResourceError
+ \li The audio cannot be played due to a problem allocating resources.
+ \row \li FormatError
+ \li The audio format is not supported.
+ \row \li NetworkError
+ \li The audio cannot be played due to network issues.
+ \row \li AccessDenied
+ \li The audio cannot be played due to insufficient permissions.
+ \row \li ServiceMissing
+ \li The audio cannot be played because the media service could not be
instantiated.
- \endlist
+ \endtable
*/
QDeclarativeAudio::Error QDeclarativeAudio::error() const
@@ -940,7 +953,7 @@ void QDeclarativeAudio::_q_statusChanged()
/*!
\qmlproperty variant QtMultimedia5::Audio::metaData.audioBitRate
- This property holds the bit rate of the media's audio stream ni bits per
+ This property holds the bit rate of the media's audio stream in bits per
second.
\sa {QtMultimedia::MetaData::AudioBitRate}
@@ -1054,7 +1067,7 @@ void QDeclarativeAudio::_q_statusChanged()
/*!
\qmlproperty variant QtMultimedia5::Audio::metaData.trackCount
- This property holds the number of track on the album containing the media.
+ This property holds the number of tracks on the album containing the media.
\sa {QtMultimedia::MetaData::TrackNumber}
*/
diff --git a/src/imports/multimedia/qdeclarativecamera.cpp b/src/imports/multimedia/qdeclarativecamera.cpp
index 882eac13d..1e5aba27d 100644
--- a/src/imports/multimedia/qdeclarativecamera.cpp
+++ b/src/imports/multimedia/qdeclarativecamera.cpp
@@ -75,18 +75,18 @@ void QDeclarativeCamera::_q_availabilityChanged(QtMultimedia::AvailabilityError
/*!
\qmlclass Camera QDeclarativeCamera
- \brief The Camera element allows you to access viewfinder frames, and take photos and movies.
+ \brief The Camera type allows you to access viewfinder frames, and take photos and movies.
\ingroup multimedia_qml
\ingroup camera_qml
\inqmlmodule QtMultimedia 5
\inherits Item
- This element is part of the \b{QtMultimedia 5.0} module.
+ Camera is part of the \b{QtMultimedia 5.0} module.
- You can use the \c Camera element to capture images and movies from a camera, and manipulate
+ You can use \c Camera to capture images and movies from a camera, and manipulate
the capture and processing settings that get applied to the images. To display the
- viewfinder you can use a \l VideoOutput element with the Camera element set as the source.
+ viewfinder you can use \l VideoOutput with the Camera set as the source.
\qml
@@ -111,7 +111,7 @@ void QDeclarativeCamera::_q_availabilityChanged(QtMultimedia::AvailabilityError
imageCapture {
onImageCaptured: {
- photoPreview.source = preview // Show the preview in an Image element
+ photoPreview.source = preview // Show the preview in an Image
}
}
}
@@ -148,15 +148,15 @@ void QDeclarativeCamera::_q_availabilityChanged(QtMultimedia::AvailabilityError
\endtable
Basic camera state management, error reporting, and simple zoom properties are
- available in the Camera element itself. For integration with C++ code, the
+ available in the Camera itself. For integration with C++ code, the
\l mediaObject property allows you to
access the standard QtMultimedia camera controls.
Many of the camera settings may take some time to apply, and might be limited
- to certain supported values depending on the hardware. Several camera settings
- support both automatic and manual modes, with the current actual setting being
- used being exposed.
-
+ to certain supported values depending on the hardware. Some camera settings may be
+ set manually or automatically. These settings properties contain the current set value.
+ For example, when autofocus is enabled the focus zones are exposed in the
+ \l {CameraFocus}{focus} property.
*/
/*!
@@ -267,10 +267,10 @@ QDeclarativeCamera::Availability QDeclarativeCamera::availability() const
\table
\header \li Value \li Description
\row \li CaptureStillImage
- \li Prepares the camera element for capturing still images.
+ \li Prepares the Camera for capturing still images.
\row \li CaptureVideo
- \li Prepares the camera element for capturing video.
+ \li Prepares the Camera for capturing video.
\endtable
@@ -345,7 +345,6 @@ void QDeclarativeCamera::setCameraState(QDeclarativeCamera::State state)
/*!
\qmlmethod QtMultimedia5::Camera::start()
- \fn QDeclarativeCamera::start()
Starts the camera. Viewfinder frames will
be available and image or movie capture will
@@ -358,7 +357,6 @@ void QDeclarativeCamera::start()
/*!
\qmlmethod QtMultimedia5::Camera::stop()
- \fn QDeclarativeCamera::stop()
Stops the camera, but leaves the camera
stack loaded.
@@ -392,7 +390,7 @@ void QDeclarativeCamera::stop()
The locked state usually means the requested parameter stays the same,
except in the cases when the parameter is requested to be constantly updated.
For example in continuous focusing mode, the focus is considered locked as long
- and the object is in focus, even while the actual focusing distance may be constantly changing.
+ as the object is in focus, even while the actual focusing distance may be constantly changing.
\endtable
*/
/*!
@@ -428,7 +426,6 @@ QDeclarativeCamera::LockStatus QDeclarativeCamera::lockStatus() const
/*!
\qmlmethod QtMultimedia5::Camera::searchAndLock()
- \fn QDeclarativeCamera::searchAndLock()
Start focusing, exposure and white balance calculation.
@@ -444,7 +441,6 @@ void QDeclarativeCamera::searchAndLock()
/*!
\qmlmethod QtMultimedia5::Camera::unlock()
- \fn QDeclarativeCamera::unlock()
Unlock focus, exposure and white balance locks.
*/
@@ -510,7 +506,7 @@ void QDeclarativeCamera::setDigitalZoom(qreal value)
/*!
\qmlproperty variant QtMultimedia5::Camera::mediaObject
- The media object for the Camera element.
+ The media object for the Camera.
*/
/*!
@@ -547,8 +543,6 @@ void QDeclarativeCamera::setDigitalZoom(qreal value)
*/
/*!
- \fn void QDeclarativeCamera::lockStatusChanged()
-
\qmlsignal Camera::lockStatusChanged()
This signal is emitted when the lock status (focus, exposure etc) changes.
@@ -556,7 +550,6 @@ void QDeclarativeCamera::setDigitalZoom(qreal value)
*/
/*!
- \fn void QDeclarativeCamera::stateChanged(QDeclarativeCamera::State state)
\qmlsignal Camera::stateChanged(state)
This signal is emitted when the camera state has changed to \a state. Since the
diff --git a/src/imports/multimedia/qdeclarativecameracapture.cpp b/src/imports/multimedia/qdeclarativecameracapture.cpp
index 7cb0c6c9c..8c575c9c0 100644
--- a/src/imports/multimedia/qdeclarativecameracapture.cpp
+++ b/src/imports/multimedia/qdeclarativecameracapture.cpp
@@ -51,16 +51,16 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass CameraCapture QDeclarativeCameraCapture
- \brief The CameraCapture element provides an interface for capturing camera images
+ \brief The CameraCapture type provides an interface for capturing camera images
\ingroup multimedia_qml
\inqmlmodule QtMultimedia 5
\ingroup camera_qml
- This element allows you to capture still images and be notified when they
+ This type allows you to capture still images and be notified when they
are available or saved to disk. You can adjust the resolution of the captured
image and where the saved image should go.
- This element is a child of a \l Camera element (as the \c imageCapture property)
+ CameraCapture is a child of a \l Camera (as the \c imageCapture property)
and cannot be created directly.
\qml
@@ -76,7 +76,7 @@ QT_BEGIN_NAMESPACE
imageCapture {
onImageCaptured: {
- // Show the preview in an Image element
+ // Show the preview in an Image
photoPreview.source = preview
}
}
@@ -143,12 +143,14 @@ bool QDeclarativeCameraCapture::isReadyForCapture() const
/*!
\qmlmethod QtMultimedia5::CameraCapture::capture()
- \fn QDeclarativeCameraCapture::capture()
Start image capture. The \l onImageCaptured() and \l onImageSaved() signals will
be emitted when the capture is complete.
- The image will be captured to the default system location.
+ The image will be captured to the default system location, typically
+ QStandardPaths::writableLocation(QStandardPaths::PicturesLocation) for
+ still imaged or QStandardPaths::writableLocation(QStandardPaths::MoviesLocation)
+ for video.
Camera saves all the capture parameters like exposure settings or
image processing parameters, so changes to camera paramaters after
@@ -164,13 +166,17 @@ int QDeclarativeCameraCapture::capture()
/*!
\qmlmethod QtMultimedia5::CameraCapture::captureToLocation(location)
- \fn QDeclarativeCameraCapture::captureToLocation(const QString &location)
Start image capture to specified \a location. The \l onImageCaptured() and \l onImageSaved() signals will
be emitted when the capture is complete.
CameraCapture::captureToLocation returns the capture requestId parameter, used with
imageExposed(), imageCaptured(), imageMetadataAvailable() and imageSaved() signals.
+
+ If the application is unable to write to the location specified by \c location
+ the CameraCapture will emit an error. The most likely reasons for the application
+ to be unable to write to a location is that the path is wrong and the location does not exists,
+ or the application does not have write permission for that location.
*/
int QDeclarativeCameraCapture::captureToLocation(const QString &location)
{
@@ -179,7 +185,6 @@ int QDeclarativeCameraCapture::captureToLocation(const QString &location)
/*!
\qmlmethod QtMultimedia5::CameraCapture::cancelCapture()
- \fn QDeclarativeCameraCapture::cancelCapture()
Cancel pending image capture requests.
*/
@@ -268,9 +273,11 @@ QString QDeclarativeCameraCapture::errorString() const
/*!
\qmlmethod QtMultimedia5::CameraCapture::setMetadata(key, value)
- \fn QDeclarativeCameraCapture::setMetadata(const QString &key, const QVariant &value)
+
Sets a particular metadata \a key to \a value for the subsequent image captures.
+
+ \sa QtMultimedia::MetaData
*/
void QDeclarativeCameraCapture::setMetadata(const QString &key, const QVariant &value)
{
@@ -280,7 +287,6 @@ void QDeclarativeCameraCapture::setMetadata(const QString &key, const QVariant &
/*!
\qmlsignal QtMultimedia5::CameraCapture::onCaptureFailed(requestId, message)
- \fn QDeclarativeCameraCapture::captureFailed(int requestId, const QString &message)
This handler is called when an error occurs during capture with \a requestId.
A descriptive message is available in \a message.
@@ -288,18 +294,16 @@ void QDeclarativeCameraCapture::setMetadata(const QString &key, const QVariant &
/*!
\qmlsignal QtMultimedia5::CameraCapture::onImageCaptured(requestId, preview)
- \fn QDeclarativeCameraCapture::imageCaptured(int requestId, const QString &preview)
This handler is called when an image with \a requestId has been captured
but not yet saved to the filesystem. The \a preview
- parameter can be used as the URL supplied to an Image element.
+ parameter can be used as the URL supplied to an \l Image.
\sa onImageSaved
*/
/*!
\qmlsignal QtMultimedia5::CameraCapture::onImageSaved(requestId, path)
- \fn QDeclarativeCameraCapture::imageSaved(int requestId, const QString &path)
This handler is called after the image with \a requestId has been written to the filesystem.
The \a path is a local file path, not a URL.
@@ -310,7 +314,6 @@ void QDeclarativeCameraCapture::setMetadata(const QString &key, const QVariant &
/*!
\qmlsignal QtMultimedia5::CameraCapture::onImageMetadataAvailable(requestId, key, value)
- \fn QDeclarativeCameraCapture::imageMetadataAvailable(int requestId, const QString &key, const QVariant &value);
This handler is called when the image with \a requestId has new metadata
available with the key \a key and value \a value.
diff --git a/src/imports/multimedia/qdeclarativecameraexposure.cpp b/src/imports/multimedia/qdeclarativecameraexposure.cpp
index 41ebd3c3c..967f9b9e1 100644
--- a/src/imports/multimedia/qdeclarativecameraexposure.cpp
+++ b/src/imports/multimedia/qdeclarativecameraexposure.cpp
@@ -46,18 +46,18 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass CameraExposure QDeclarativeCameraExposure
- \brief The CameraExposure element provides interface for exposure related camera settings.
+ \brief The CameraExposure type provides interface for exposure related camera settings.
\ingroup multimedia_qml
\ingroup camera_qml
\inqmlmodule QtMultimedia 5
- This element is part of the \b{QtMultimedia 5.0} module.
+ This type is part of the \b{QtMultimedia 5.0} module.
- This element allows you to adjust exposure related settings
+ CameraExposure allows you to adjust exposure related settings
like aperture and shutter speed, metering and ISO speed.
- It should not be constructed separately but provided by the
- \l Camera element's \c exposure property.
+ It should not be constructed separately, instead the
+ \c exposure property of the a \l Camera should be used.
\qml
import QtQuick 2.0
@@ -95,7 +95,7 @@ QT_BEGIN_NAMESPACE
/*!
\internal
\class QDeclarativeCameraExposure
- \brief The CameraExposure element provides interface for exposure related camera settings.
+ \brief The CameraExposure provides interface for exposure related camera settings.
*/
diff --git a/src/imports/multimedia/qdeclarativecameraflash.cpp b/src/imports/multimedia/qdeclarativecameraflash.cpp
index 1c9a69a02..1be875642 100644
--- a/src/imports/multimedia/qdeclarativecameraflash.cpp
+++ b/src/imports/multimedia/qdeclarativecameraflash.cpp
@@ -47,19 +47,19 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass CameraFlash QDeclarativeCameraFlash
\inqmlmodule QtMultimedia 5
- \brief The CameraFlash element provides interface for flash related camera settings.
+ \brief The CameraFlash type provides interface for flash related camera settings.
\ingroup multimedia_qml
\ingroup camera_qml
- This element is part of the \b{QtMultimedia 5.0} module.
+ CameraFlash is part of the \b{QtMultimedia 5.0} module.
- The CameraFlash element allows you to operate the camera flash
+ This type allows you to operate the camera flash
hardware and control the flash mode used. Not all cameras have
flash hardware (and in some cases it is shared with the
\l {Torch}{torch} hardware).
- It should not be constructed separately but provided by the
- \l Camera element's \c flash property.
+ It should not be constructed separately, instead the
+ \c flash property of a \l Camera should be used.
\qml
import QtQuick 2.0
@@ -78,7 +78,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QDeclarativeCameraFlash
\internal
- \brief The CameraFlash element provides interface for flash related camera settings.
+ \brief The CameraFlash provides interface for flash related camera settings.
*/
/*!
@@ -142,12 +142,15 @@ void QDeclarativeCameraFlash::setFlashMode(int mode)
/*!
\qmlsignal QtMultimedia5::CameraExposure::flashModeChanged(int)
- \fn void QDeclarativeCameraFlash::flashModeChanged(int)
+ This signal is emitted when the \c flashMode property is changed.
+ The corresponding handler is \c onFlashModeChanged.
*/
/*!
\qmlsignal QtMultimedia5::CameraExposure::flashReady(bool)
- \fn void QDeclarativeCameraFlash::flashReady(bool)
+ This signal is emitted when QCameraExposure indicates that
+ the flash is ready to use.
+ The corresponsing handler is \c onFlashReadyChanged.
*/
QT_END_NAMESPACE
diff --git a/src/imports/multimedia/qdeclarativecamerafocus.cpp b/src/imports/multimedia/qdeclarativecamerafocus.cpp
index d69ed1781..8ecbb3e8d 100644
--- a/src/imports/multimedia/qdeclarativecamerafocus.cpp
+++ b/src/imports/multimedia/qdeclarativecamerafocus.cpp
@@ -47,18 +47,18 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass CameraFocus QDeclarativeCameraFocus
\inqmlmodule QtMultimedia 5
- \brief The CameraFocus element provides interface for focus related camera settings.
+ \brief The CameraFocus type provides interface for focus related camera settings.
\ingroup multimedia_qml
\ingroup camera_qml
- This element is part of the \b{QtMultimedia 5.0} module.
+ CameraFocus is part of the \b{QtMultimedia 5.0} module.
- The CameraFocus element allows control over manual and automatic
+ This type allows control over manual and automatic
focus settings, including information about any parts of the
camera frame that are selected for autofocusing.
- It is not constructed separately but is provided by the
- \l Camera element's \c focus property.
+ It should not be constructed separately, instead the
+ \c focus property of a \l Camera should be used.
\qml
import QtQuick 2.0
@@ -74,7 +74,7 @@ QT_BEGIN_NAMESPACE
focus {
focusMode: Camera.FocusMacro
focusPointMode: Camera.FocusPointCustom
- customFocusPoint: Qt.point(0.2, 0.2) //focus to top-left corner
+ customFocusPoint: Qt.point(0.2, 0.2) // Focus relative to top-left corner
}
}
@@ -90,7 +90,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QDeclarativeCameraFocus
\internal
- \brief The CameraFocus element provides interface for focus related camera settings.
+ \brief The CameraFocus provides interface for focus related camera settings.
*/
/*!
@@ -133,7 +133,6 @@ QDeclarativeCamera::FocusMode QDeclarativeCameraFocus::focusMode() const
/*!
\qmlmethod bool QtMultimedia5::CameraFocus::isFocusModeSupported(mode) const
- \fn QDeclarativeCameraFocus::isFocusModeSupported(QDeclarativeCamera::FocusMode mode) const
Returns true if the supplied \a mode is a supported focus mode, and
false otherwise.
@@ -174,7 +173,6 @@ void QDeclarativeCameraFocus::setFocusPointMode(QDeclarativeCamera::FocusPointMo
/*!
\qmlmethod bool QtMultimedia5::CameraFocus::isFocusPointModeSupported(mode) const
- \fn QDeclarativeCameraFocus::isFocusPointModeSupported(QDeclarativeCamera::FocusPointMode mode) const
Returns true if the supplied \a mode is a supported focus point mode, and
false otherwise.
diff --git a/src/imports/multimedia/qdeclarativecameraimageprocessing.cpp b/src/imports/multimedia/qdeclarativecameraimageprocessing.cpp
index d4c06077a..385da404a 100644
--- a/src/imports/multimedia/qdeclarativecameraimageprocessing.cpp
+++ b/src/imports/multimedia/qdeclarativecameraimageprocessing.cpp
@@ -47,16 +47,16 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass CameraImageProcessing QDeclarativeCameraImageProcessing
\inqmlmodule QtMultimedia 5
- \brief The CameraCapture element provides an interface for camera capture related settings
+ \brief The CameraImageProcessing type provides an interface for camera capture related settings
\ingroup multimedia_qml
\ingroup camera_qml
- The CameraImageProcessing element provides control over post-processing
+ CameraImageProcessing provides control over post-processing
done by the camera middleware, including white balance adjustments,
contrast, saturation, sharpening, and denoising
- It is not constructed separately but is provided by the \a Camera element's
- \c imageProcessing property.
+ It should not be constructed separately, instead the
+ \c imageProcessing property of a \l Camera should be used.
\qml
import QtQuick 2.0
@@ -79,7 +79,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QDeclarativeCameraImageProcessing
\internal
- \brief The CameraCapture element provides an interface for camera capture related settings
+ \brief The CameraCapture provides an interface for camera capture related settings
*/
@@ -233,10 +233,12 @@ void QDeclarativeCameraImageProcessing::setDenoisingLevel(qreal value)
/*!
\qmlsignal QtMultimedia5::Camera::whiteBalanceModeChanged(Camera::WhiteBalanceMode)
+ This signal is emitted when the \c whiteBalanceMode property is changed.
*/
/*!
\qmlsignal QtMultimedia5::Camera::manualWhiteBalanceChanged(qreal)
+ This signal is emitted when the \c manualWhiteBalance property is changed.
*/
QT_END_NAMESPACE
diff --git a/src/imports/multimedia/qdeclarativecamerarecorder.cpp b/src/imports/multimedia/qdeclarativecamerarecorder.cpp
index 5144e4bb7..d78d9d391 100644
--- a/src/imports/multimedia/qdeclarativecamerarecorder.cpp
+++ b/src/imports/multimedia/qdeclarativecamerarecorder.cpp
@@ -49,15 +49,15 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass CameraRecorder QDeclarativeCameraRecorder
\inqmlmodule QtMultimedia 5
- \brief The CameraRecorder element controls video recording with the Camera.
+ \brief The CameraRecorder type controls video recording with the Camera.
\ingroup multimedia_qml
\ingroup camera_qml
- This element allows recording camera streams to files, and adjusting recording
+ CameraRecorder allows recording camera streams to files, and adjusting recording
settings and metadata for videos.
- This element is a child of a \l Camera element (as the \c videoRecorder property)
- and cannot be created directly.
+ It should not be constructed separately, instead the
+ \c videRecorder property of a \l Camera should be used.
\qml
Camera {
@@ -237,7 +237,7 @@ int QDeclarativeCameraRecorder::audioSampleRate() const
/*!
\qmlproperty enumeration QtMultimedia5::CameraRecorder::videoEncodingMode
- The type of encoding method to use when recording audio.
+ The type of encoding method to use when recording video.
\table
\header \li Value \li Description
diff --git a/src/imports/multimedia/qdeclarativeradio.cpp b/src/imports/multimedia/qdeclarativeradio.cpp
index cf9e2008b..9942dd440 100644
--- a/src/imports/multimedia/qdeclarativeradio.cpp
+++ b/src/imports/multimedia/qdeclarativeradio.cpp
@@ -47,12 +47,12 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass Radio QDeclarativeRadio
\inqmlmodule QtMultimedia 5
- \brief The Radio element allows you to access radio functionality from a QML application.
+ \brief The Radio type allows you to access radio functionality from a QML application.
\ingroup multimedia_qml
\ingroup multimedia_radio_qml
\inherits Item
- This element is part of the \b{QtMultimedia 5.0} module.
+ Radio is part of the \b{QtMultimedia 5.0} module.
\qml
import QtQuick 2.0
@@ -85,12 +85,12 @@ QT_BEGIN_NAMESPACE
}
\endqml
- You can use the \c Radio element to tune the radio and get information about the signal.
- You can also use the Radio element to get information about tuning, for instance the
+ You can use \c Radio to tune the radio and get information about the signal.
+ You can also use the Radio to get information about tuning, for instance the
frequency steps supported for tuning.
- The corresponding \l RadioData element gives RDS information about the
- current radio station. The best way to access the RadioData element for
+ The corresponding \l RadioData gives RDS information about the
+ current radio station. The best way to access the RadioData for
the current Radio is to use the \c radioData property.
\sa {Radio Overview}
@@ -129,7 +129,7 @@ QDeclarativeRadio::~QDeclarativeRadio()
/*!
\qmlproperty enumeration QtMultimedia5::Radio::state
- This property holds the current state of the Radio element.
+ This property holds the current state of the Radio.
\table
\header \li Value \li Description
@@ -540,7 +540,7 @@ void QDeclarativeRadio::_q_availabilityChanged(QtMultimedia::AvailabilityError e
if \l searchAllStations is called with \c SearchGetStationId.
The \a frequency is returned in Hertz, and the \a stationId corresponds to the station Id
- in the \l RadioData element for this radio station.
+ in the \l RadioData for this radio station.
*/
QT_END_NAMESPACE
diff --git a/src/imports/multimedia/qdeclarativeradiodata.cpp b/src/imports/multimedia/qdeclarativeradiodata.cpp
index 7936dd6f4..cd69913d9 100644
--- a/src/imports/multimedia/qdeclarativeradiodata.cpp
+++ b/src/imports/multimedia/qdeclarativeradiodata.cpp
@@ -46,16 +46,16 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass RadioData QDeclarativeRadioData
\inqmlmodule QtMultimedia 5
- \brief The RadioData element allows you to access RDS data from a QML application.
+ \brief The RadioData type allows you to access RDS data from a QML application.
\ingroup multimedia_qml
\ingroup multimedia_radio_qml
\inherits Item
- This element is part of the \b{QtMultimedia 5.0} module.
+ This type is part of the \b{QtMultimedia 5.0} module.
- The \c RadioData element is your gateway to all the data available through RDS. RDS is the Radio Data System
+ \c RadioData is your gateway to all the data available through RDS. RDS is the Radio Data System
which allows radio stations to broadcast information like the \l stationId, \l programType, \l programTypeName,
- \l stationName, and \l radioText. This information can be read from the \c RadioData element. It also allows
+ \l stationName, and \l radioText. This information can be read from the \c RadioData. It also allows
you to set whether the radio should tune to alternative frequencies if the current signal strength falls too much.
\qml
@@ -88,11 +88,11 @@ QT_BEGIN_NAMESPACE
\endqml
- You use \c RadioData together with the \l Radio element, either by
- accessing the \c radioData property of the Radio element, or
- creating a separate RadioData element. The properties of the
- RadioData element will reflect the information broadcast by the
- radio station the Radio element is currently tuned to.
+ You use \c RadioData together with a \l Radio, either by
+ accessing the \c radioData property of the Radio, or
+ creating a separate RadioData. The properties of the
+ RadioData type will reflect the information broadcast by the
+ radio station the Radio is currently tuned to.
\sa {Radio Overview}
*/
@@ -299,7 +299,7 @@ void QDeclarativeRadioData::connectSignals()
SIGNAL(alternativeFrequenciesEnabledChanged(bool)));
// Note we map availabilityError->availability
- // Since the radio data element depends on the service for the tuner, the availability is also dictated from the tuner
+ // Since the radio data type depends on the service for the tuner, the availability is also dictated from the tuner
connect(m_radioTuner, SIGNAL(availabilityErrorChanged(QtMultimedia::AvailabilityError)), this, SLOT(_q_availabilityChanged(QtMultimedia::AvailabilityError)));
connect(m_radioData, SIGNAL(error(QRadioData::Error)), this, SLOT(_q_error(QRadioData::Error)));
diff --git a/src/imports/multimedia/qdeclarativetorch.cpp b/src/imports/multimedia/qdeclarativetorch.cpp
index 74249d197..56c7c4b10 100644
--- a/src/imports/multimedia/qdeclarativetorch.cpp
+++ b/src/imports/multimedia/qdeclarativetorch.cpp
@@ -49,11 +49,11 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass Torch QDeclarativeTorch
\inqmlmodule QtMultimedia 5
- \brief The Torch element provides simple control over torch functionality
+ \brief The Torch type provides simple control over torch functionality
\ingroup multimedia_qml
- This element is part of the \b{QtMultimedia 5.0} module.
+ \c Torch is part of the \b{QtMultimedia 5.0} module.
In many cases the torch hardware is shared with camera flash functionality,
and might be automatically controlled by the device. You have control over
diff --git a/src/imports/multimedia/qdeclarativevideooutput.cpp b/src/imports/multimedia/qdeclarativevideooutput.cpp
index 3304ff47b..8562390b7 100644
--- a/src/imports/multimedia/qdeclarativevideooutput.cpp
+++ b/src/imports/multimedia/qdeclarativevideooutput.cpp
@@ -52,13 +52,13 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass VideoOutput QDeclarativeVideoOutput
- \brief The VideoOutput element allows you to render video or camera viewfinder.
+ \brief The VideoOutput type allows you to render video or camera viewfinder.
\ingroup multimedia_qml
\ingroup multimedia_video_qml
\inqmlmodule QtMultimedia 5
- This element is part of the \b{QtMultimedia 5.0} module.
+ \c VideoOutput is part of the \b{QtMultimedia 5.0} module.
\qml
import QtQuick 2.0
@@ -105,7 +105,7 @@ QT_BEGIN_NAMESPACE
If it is likely that an application will be playing video for an extended
period of time without user interaction it may be necessary to disable
- the platform's screen saver. The \l ScreenSaver element (from \l QtSystemInfo)
+ the platform's screen saver. The \l ScreenSaver (from \l QtSystemInfo)
may be used to disable the screensaver in this fashion:
\qml
@@ -411,8 +411,8 @@ void QDeclarativeVideoOutput::setOrientation(int orientation)
This property holds the item coordinates of the area that
would contain video to render. With certain fill modes,
- this rectangle will be larger than the visible area of this
- element.
+ this rectangle will be larger than the visible area of the
+ \c VideoOutput.
This property is useful when other coordinates are specified
in terms of the source dimensions - this applied for relative