From 940ef93c30d7b3421c3304762fed538dd1f41504 Mon Sep 17 00:00:00 2001
From: Angus Cummings <angus.cummings@nokia.com>
Date: Thu, 14 Jun 2012 11:49:54 +1000
Subject: [PATCH] Updating brief layout of QML types
Change-Id: I1dcd7bf7427f25bb9e19cbe3c7e17808b0fc9708
Reviewed-by: Michael Goddard <michael.goddard@nokia.com>
Reviewed-by: Peter Yard <peter.yard@nokia.com>
---
src/imports/audioengine/qdeclarative_audioengine_p.cpp | 2 +-
src/imports/audioengine/qdeclarative_audiolistener_p.cpp | 2 +-
src/imports/audioengine/qdeclarative_audiosample_p.cpp | 2 +-
src/imports/audioengine/qdeclarative_playvariation_p.cpp | 2 +-
src/imports/audioengine/qdeclarative_sound_p.cpp | 2 +-
src/imports/audioengine/qdeclarative_soundinstance_p.cpp | 2 +-
src/imports/multimedia/Video.qml | 2 +-
src/imports/multimedia/qdeclarativeaudio.cpp | 4 ++--
src/imports/multimedia/qdeclarativecamera.cpp | 2 +-
src/imports/multimedia/qdeclarativecameracapture.cpp | 2 +-
src/imports/multimedia/qdeclarativecameraexposure.cpp | 2 +-
src/imports/multimedia/qdeclarativecameraflash.cpp | 2 +-
src/imports/multimedia/qdeclarativecamerafocus.cpp | 4 ++--
src/imports/multimedia/qdeclarativecameraimageprocessing.cpp | 2 +-
src/imports/multimedia/qdeclarativecamerarecorder.cpp | 2 +-
src/imports/multimedia/qdeclarativeradio.cpp | 2 +-
src/imports/multimedia/qdeclarativeradiodata.cpp | 2 +-
src/imports/multimedia/qdeclarativetorch.cpp | 2 +-
src/imports/multimedia/qdeclarativevideooutput.cpp | 2 +-
19 files changed, 21 insertions(+), 21 deletions(-)
diff --git a/src/imports/audioengine/qdeclarative_audioengine_p.cpp b/src/imports/audioengine/qdeclarative_audioengine_p.cpp
index 1a75e8349..58259e1e9 100644
--- a/src/imports/audioengine/qdeclarative_audioengine_p.cpp
+++ b/src/imports/audioengine/qdeclarative_audioengine_p.cpp
@@ -58,7 +58,7 @@ QT_USE_NAMESPACE
/*!
\qmlclass AudioEngine QDeclarativeAudioEngine
\since 5.0
- \brief The AudioEngine type allows you to organize all your 3d audio content in one place.
+ \brief Organize all your 3d audio content in one place.
\inqmlmodule QtAudioEngine 1
\ingroup multimedia_audioengine
\inherits Item
diff --git a/src/imports/audioengine/qdeclarative_audiolistener_p.cpp b/src/imports/audioengine/qdeclarative_audiolistener_p.cpp
index 77851332b..55ba0b212 100644
--- a/src/imports/audioengine/qdeclarative_audiolistener_p.cpp
+++ b/src/imports/audioengine/qdeclarative_audiolistener_p.cpp
@@ -50,7 +50,7 @@ QT_USE_NAMESPACE
/*!
\qmlclass AudioListener QDeclarativeAudioListener
\since 5.0
- \brief The AudioListener type allows you to control global listener parameters.
+ \brief Control global listener parameters.
\inqmlmodule QtAudioEngine 1
\ingroup multimedia_audioengine
\inherits Item
diff --git a/src/imports/audioengine/qdeclarative_audiosample_p.cpp b/src/imports/audioengine/qdeclarative_audiosample_p.cpp
index fe80989ee..80b33025e 100644
--- a/src/imports/audioengine/qdeclarative_audiosample_p.cpp
+++ b/src/imports/audioengine/qdeclarative_audiosample_p.cpp
@@ -52,7 +52,7 @@ QT_USE_NAMESPACE
/*!
\qmlclass AudioSample QDeclarativeAudioSample
\since 5.0
- \brief The AudioSample type allows you to load audio samples, mostly wav file.
+ \brief Load audio samples, mostly .wav.
\inqmlmodule QtAudioEngine 1
\ingroup multimedia_audioengine
\inherits Item
diff --git a/src/imports/audioengine/qdeclarative_playvariation_p.cpp b/src/imports/audioengine/qdeclarative_playvariation_p.cpp
index fd6456a0a..64bac1e20 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 type allows you to define a playback variation for \l {Sound} {sounds}.
+ \brief 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.
diff --git a/src/imports/audioengine/qdeclarative_sound_p.cpp b/src/imports/audioengine/qdeclarative_sound_p.cpp
index e775d1dbb..ca9ae10ce 100644
--- a/src/imports/audioengine/qdeclarative_sound_p.cpp
+++ b/src/imports/audioengine/qdeclarative_sound_p.cpp
@@ -140,7 +140,7 @@ void QDeclarativeSoundCone::componentComplete()
/*!
\qmlclass Sound QDeclarativeSound
\since 5.0
- \brief The Sound type allows you to define a variety of samples and parameters to be used for
+ \brief Define a variety of samples and parameters to be used for
SoundInstance.
\inqmlmodule QtAudioEngine 1
\ingroup multimedia_audioengine
diff --git a/src/imports/audioengine/qdeclarative_soundinstance_p.cpp b/src/imports/audioengine/qdeclarative_soundinstance_p.cpp
index c29968f55..2bdc6a69f 100644
--- a/src/imports/audioengine/qdeclarative_soundinstance_p.cpp
+++ b/src/imports/audioengine/qdeclarative_soundinstance_p.cpp
@@ -53,7 +53,7 @@ QT_USE_NAMESPACE
/*!
\qmlclass SoundInstance QDeclarativeSoundInstance
\since 5.0
- \brief The SoundInstance type allows you to play 3d audio content.
+ \brief Play 3d audio content.
\inqmlmodule QtAudioEngine 1
\ingroup multimedia_audioengine
\inherits Item
diff --git a/src/imports/multimedia/Video.qml b/src/imports/multimedia/Video.qml
index d8e1b8d9a..50437063b 100644
--- a/src/imports/multimedia/Video.qml
+++ b/src/imports/multimedia/Video.qml
@@ -47,7 +47,7 @@ import QtMultimedia 5.0
\inherits Item
\ingroup multimedia_qml
\ingroup multimedia_video_qml
- \brief A convenience type for showing a specified video
+ \brief A convenience type for showing a specified video.
\c Video is a convenience type combining the functionality
of a \l MediaPlayer and a \l VideoOutput into one. It provides
diff --git a/src/imports/multimedia/qdeclarativeaudio.cpp b/src/imports/multimedia/qdeclarativeaudio.cpp
index 9e09e270e..97aac507b 100644
--- a/src/imports/multimedia/qdeclarativeaudio.cpp
+++ b/src/imports/multimedia/qdeclarativeaudio.cpp
@@ -58,7 +58,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass Audio QDeclarativeAudio
- \brief The Audio type allows you to add audio playback to a scene.
+ \brief Add audio playback to a scene.
\inqmlmodule QtMultimedia 5
\ingroup multimedia_qml
@@ -1106,7 +1106,7 @@ void QDeclarativeAudio::_q_statusChanged()
/*!
\qmlclass MediaPlayer QDeclarativeAudio
- \brief The MediaPlayer type allows you to add media playback to a scene.
+ \brief Add media playback to a scene.
\inqmlmodule QtMultimedia 5
\ingroup multimedia_qml
diff --git a/src/imports/multimedia/qdeclarativecamera.cpp b/src/imports/multimedia/qdeclarativecamera.cpp
index d79d90981..bbdccd42b 100644
--- a/src/imports/multimedia/qdeclarativecamera.cpp
+++ b/src/imports/multimedia/qdeclarativecamera.cpp
@@ -75,7 +75,7 @@ void QDeclarativeCamera::_q_availabilityChanged(QtMultimedia::AvailabilityError
/*!
\qmlclass Camera QDeclarativeCamera
- \brief The Camera type allows you to access viewfinder frames, and take photos and movies.
+ \brief Access viewfinder frames, and take photos and movies.
\ingroup multimedia_qml
\ingroup camera_qml
\inqmlmodule QtMultimedia 5
diff --git a/src/imports/multimedia/qdeclarativecameracapture.cpp b/src/imports/multimedia/qdeclarativecameracapture.cpp
index 56987f712..f1e551214 100644
--- a/src/imports/multimedia/qdeclarativecameracapture.cpp
+++ b/src/imports/multimedia/qdeclarativecameracapture.cpp
@@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass CameraCapture QDeclarativeCameraCapture
- \brief The CameraCapture type provides an interface for capturing camera images
+ \brief An interface for capturing camera images
\ingroup multimedia_qml
\inqmlmodule QtMultimedia 5
\ingroup camera_qml
diff --git a/src/imports/multimedia/qdeclarativecameraexposure.cpp b/src/imports/multimedia/qdeclarativecameraexposure.cpp
index 967f9b9e1..d1bfe4278 100644
--- a/src/imports/multimedia/qdeclarativecameraexposure.cpp
+++ b/src/imports/multimedia/qdeclarativecameraexposure.cpp
@@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass CameraExposure QDeclarativeCameraExposure
- \brief The CameraExposure type provides interface for exposure related camera settings.
+ \brief An interface for exposure related camera settings.
\ingroup multimedia_qml
\ingroup camera_qml
\inqmlmodule QtMultimedia 5
diff --git a/src/imports/multimedia/qdeclarativecameraflash.cpp b/src/imports/multimedia/qdeclarativecameraflash.cpp
index fd5379400..da0df4c7c 100644
--- a/src/imports/multimedia/qdeclarativecameraflash.cpp
+++ b/src/imports/multimedia/qdeclarativecameraflash.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass CameraFlash QDeclarativeCameraFlash
\inqmlmodule QtMultimedia 5
- \brief The CameraFlash type provides interface for flash related camera settings.
+ \brief An interface for flash related camera settings.
\ingroup multimedia_qml
\ingroup camera_qml
diff --git a/src/imports/multimedia/qdeclarativecamerafocus.cpp b/src/imports/multimedia/qdeclarativecamerafocus.cpp
index 8ecbb3e8d..bba5e3733 100644
--- a/src/imports/multimedia/qdeclarativecamerafocus.cpp
+++ b/src/imports/multimedia/qdeclarativecamerafocus.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass CameraFocus QDeclarativeCameraFocus
\inqmlmodule QtMultimedia 5
- \brief The CameraFocus type provides interface for focus related camera settings.
+ \brief An interface for focus related camera settings.
\ingroup multimedia_qml
\ingroup camera_qml
@@ -90,7 +90,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QDeclarativeCameraFocus
\internal
- \brief The CameraFocus provides interface for focus related camera settings.
+ \brief An interface for focus related camera settings.
*/
/*!
diff --git a/src/imports/multimedia/qdeclarativecameraimageprocessing.cpp b/src/imports/multimedia/qdeclarativecameraimageprocessing.cpp
index ff329982e..94c2cfef3 100644
--- a/src/imports/multimedia/qdeclarativecameraimageprocessing.cpp
+++ b/src/imports/multimedia/qdeclarativecameraimageprocessing.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass CameraImageProcessing QDeclarativeCameraImageProcessing
\inqmlmodule QtMultimedia 5
- \brief The CameraImageProcessing type provides an interface for camera capture related settings
+ \brief An interface for camera capture related settings.
\ingroup multimedia_qml
\ingroup camera_qml
diff --git a/src/imports/multimedia/qdeclarativecamerarecorder.cpp b/src/imports/multimedia/qdeclarativecamerarecorder.cpp
index d78d9d391..1b282ad12 100644
--- a/src/imports/multimedia/qdeclarativecamerarecorder.cpp
+++ b/src/imports/multimedia/qdeclarativecamerarecorder.cpp
@@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass CameraRecorder QDeclarativeCameraRecorder
\inqmlmodule QtMultimedia 5
- \brief The CameraRecorder type controls video recording with the Camera.
+ \brief Controls video recording with the Camera.
\ingroup multimedia_qml
\ingroup camera_qml
diff --git a/src/imports/multimedia/qdeclarativeradio.cpp b/src/imports/multimedia/qdeclarativeradio.cpp
index 9942dd440..dac7aad0e 100644
--- a/src/imports/multimedia/qdeclarativeradio.cpp
+++ b/src/imports/multimedia/qdeclarativeradio.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass Radio QDeclarativeRadio
\inqmlmodule QtMultimedia 5
- \brief The Radio type allows you to access radio functionality from a QML application.
+ \brief Access radio functionality from a QML application.
\ingroup multimedia_qml
\ingroup multimedia_radio_qml
\inherits Item
diff --git a/src/imports/multimedia/qdeclarativeradiodata.cpp b/src/imports/multimedia/qdeclarativeradiodata.cpp
index cd69913d9..a72325e52 100644
--- a/src/imports/multimedia/qdeclarativeradiodata.cpp
+++ b/src/imports/multimedia/qdeclarativeradiodata.cpp
@@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass RadioData QDeclarativeRadioData
\inqmlmodule QtMultimedia 5
- \brief The RadioData type allows you to access RDS data from a QML application.
+ \brief Access RDS data from a QML application.
\ingroup multimedia_qml
\ingroup multimedia_radio_qml
\inherits Item
diff --git a/src/imports/multimedia/qdeclarativetorch.cpp b/src/imports/multimedia/qdeclarativetorch.cpp
index 56c7c4b10..64b6b4c69 100644
--- a/src/imports/multimedia/qdeclarativetorch.cpp
+++ b/src/imports/multimedia/qdeclarativetorch.cpp
@@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass Torch QDeclarativeTorch
\inqmlmodule QtMultimedia 5
- \brief The Torch type provides simple control over torch functionality
+ \brief Simple control over torch functionality
\ingroup multimedia_qml
diff --git a/src/imports/multimedia/qdeclarativevideooutput.cpp b/src/imports/multimedia/qdeclarativevideooutput.cpp
index 418b4d4e1..3e4aa891d 100644
--- a/src/imports/multimedia/qdeclarativevideooutput.cpp
+++ b/src/imports/multimedia/qdeclarativevideooutput.cpp
@@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass VideoOutput QDeclarativeVideoOutput
- \brief The VideoOutput type allows you to render video or camera viewfinder.
+ \brief Render video or camera viewfinder.
\ingroup multimedia_qml
\ingroup multimedia_video_qml
--
GitLab