summaryrefslogtreecommitdiffstats
path: root/src/multimedia/controls
diff options
context:
space:
mode:
authorMichael Goddard <michael.goddard@nokia.com>2012-01-16 16:27:32 +1000
committerQt by Nokia <qt-info@nokia.com>2012-01-17 01:57:58 +0100
commit508ca281961a9dd59f21218adfa2305b6a4c8ac1 (patch)
tree0405a1f39ed151d722a3f19ce5a461238f8512b2 /src/multimedia/controls
parent53d71baed324d43bf5bac1fd50fc2eb4764b3857 (diff)
Fix up a few doc issues
* lingering references to Mobility * missing group tags on some classes meant they went missing * put classes into functional groups as well (e.g. audio, camera) * added some of the qdoc files to OTHER_FILES so they show up in Creator There are still a lot of warnings since it seems like qdoc is not processing the controls directory. Change-Id: I036f8826ae63f8273b3e649cb32c091d964ce830 Reviewed-by: Jonas Rabbe <jonas.rabbe@nokia.com>
Diffstat (limited to 'src/multimedia/controls')
-rw-r--r--src/multimedia/controls/qaudioencodercontrol.cpp3
-rw-r--r--src/multimedia/controls/qcameracapturebufferformatcontrol.cpp3
-rw-r--r--src/multimedia/controls/qcameracapturedestinationcontrol.cpp5
-rw-r--r--src/multimedia/controls/qcameracontrol.cpp3
-rw-r--r--src/multimedia/controls/qcameraexposurecontrol.cpp3
-rw-r--r--src/multimedia/controls/qcameraflashcontrol.cpp4
-rw-r--r--src/multimedia/controls/qcamerafocuscontrol.cpp4
-rw-r--r--src/multimedia/controls/qcameraimagecapturecontrol.cpp4
-rw-r--r--src/multimedia/controls/qcameraimageprocessingcontrol.cpp4
-rw-r--r--src/multimedia/controls/qcameralockscontrol.cpp4
-rw-r--r--src/multimedia/controls/qimageencodercontrol.cpp4
-rw-r--r--src/multimedia/controls/qmediabackgroundplaybackcontrol.cpp3
-rw-r--r--src/multimedia/controls/qmediacontainercontrol.cpp4
-rw-r--r--src/multimedia/controls/qmediagaplessplaybackcontrol.cpp2
-rw-r--r--src/multimedia/controls/qmedianetworkaccesscontrol.cpp5
-rw-r--r--src/multimedia/controls/qmediaplayercontrol.cpp4
-rw-r--r--src/multimedia/controls/qmediaplaylistcontrol.cpp4
-rw-r--r--src/multimedia/controls/qmediaplaylistsourcecontrol.cpp4
-rw-r--r--src/multimedia/controls/qmediarecordercontrol.cpp3
-rw-r--r--src/multimedia/controls/qmediastreamscontrol.cpp7
-rw-r--r--src/multimedia/controls/qmetadatareadercontrol.cpp4
-rw-r--r--src/multimedia/controls/qmetadatawritercontrol.cpp4
-rw-r--r--src/multimedia/controls/qradiodatacontrol.cpp4
-rw-r--r--src/multimedia/controls/qradiotunercontrol.cpp4
-rw-r--r--src/multimedia/controls/qvideodevicecontrol.cpp4
-rw-r--r--src/multimedia/controls/qvideoencodercontrol.cpp4
-rw-r--r--src/multimedia/controls/qvideorenderercontrol.cpp8
27 files changed, 72 insertions, 37 deletions
diff --git a/src/multimedia/controls/qaudioencodercontrol.cpp b/src/multimedia/controls/qaudioencodercontrol.cpp
index df79e465b..8c9ff4f2d 100644
--- a/src/multimedia/controls/qaudioencodercontrol.cpp
+++ b/src/multimedia/controls/qaudioencodercontrol.cpp
@@ -48,7 +48,8 @@ QT_BEGIN_NAMESPACE
/*!
\class QAudioEncoderControl
\inmodule QtMultimedia
- \ingroup multimedia-serv
+ \ingroup multimedia
+ \ingroup multimedia_control
\brief The QAudioEncoderControl class provides access to the settings of a
media service that performs audio encoding.
diff --git a/src/multimedia/controls/qcameracapturebufferformatcontrol.cpp b/src/multimedia/controls/qcameracapturebufferformatcontrol.cpp
index 321dc2b9d..639e157a7 100644
--- a/src/multimedia/controls/qcameracapturebufferformatcontrol.cpp
+++ b/src/multimedia/controls/qcameracapturebufferformatcontrol.cpp
@@ -51,7 +51,8 @@ QT_BEGIN_NAMESPACE
The format is of type QVideoFrame::PixelFormat.
\inmodule QtMultimedia
- \ingroup multimedia-serv
+ \ingroup multimedia
+ \ingroup multimedia_control
The interface name of QCameraCaptureBufferFormatControl is \c com.nokia.Qt.QCameraCaptureBufferFormatControl/1.0 as
defined in QCameraCaptureBufferFormatControl_iid.
diff --git a/src/multimedia/controls/qcameracapturedestinationcontrol.cpp b/src/multimedia/controls/qcameracapturedestinationcontrol.cpp
index bbce6996f..e2d3e9e18 100644
--- a/src/multimedia/controls/qcameracapturedestinationcontrol.cpp
+++ b/src/multimedia/controls/qcameracapturedestinationcontrol.cpp
@@ -52,9 +52,8 @@ QT_BEGIN_NAMESPACE
Depending on backend capabilities capture to file, buffer or both can be supported.
\inmodule QtMultimedia
- \ingroup multimedia-serv
-
-
+ \ingroup multimedia
+ \ingroup multimedia_control
The interface name of QCameraCaptureDestinationControl is \c com.nokia.Qt.QCameraCaptureDestinationControl/1.0 as
defined in QCameraCaptureDestinationControl_iid.
diff --git a/src/multimedia/controls/qcameracontrol.cpp b/src/multimedia/controls/qcameracontrol.cpp
index 32440b108..72506094f 100644
--- a/src/multimedia/controls/qcameracontrol.cpp
+++ b/src/multimedia/controls/qcameracontrol.cpp
@@ -53,7 +53,8 @@ QT_BEGIN_NAMESPACE
classes that control still cameras or video cameras.
\inmodule QtMultimedia
- \ingroup multimedia-serv
+ \ingroup multimedia
+ \ingroup multimedia_control
This service is provided by a QMediaService object via
QMediaService::control(). It is used by QCamera.
diff --git a/src/multimedia/controls/qcameraexposurecontrol.cpp b/src/multimedia/controls/qcameraexposurecontrol.cpp
index 4ca75d38d..3beafe727 100644
--- a/src/multimedia/controls/qcameraexposurecontrol.cpp
+++ b/src/multimedia/controls/qcameraexposurecontrol.cpp
@@ -50,7 +50,8 @@ QT_BEGIN_NAMESPACE
\brief The QCameraExposureControl class allows controlling camera exposure parameters.
\inmodule QtMultimedia
- \ingroup multimedia-serv
+ \ingroup multimedia
+ \ingroup multimedia_control
You can adjust a number of parameters that will affect images and video taken with
the corresponding QCamera object.
diff --git a/src/multimedia/controls/qcameraflashcontrol.cpp b/src/multimedia/controls/qcameraflashcontrol.cpp
index a2b2d6b62..9bf8ddad0 100644
--- a/src/multimedia/controls/qcameraflashcontrol.cpp
+++ b/src/multimedia/controls/qcameraflashcontrol.cpp
@@ -49,10 +49,10 @@ QT_BEGIN_NAMESPACE
\brief The QCameraFlashControl class allows controlling a camera's flash.
- \ingroup multimedia-serv
\inmodule QtMultimedia
- \inmodule QtMultimedia
+ \ingroup multimedia
+ \ingroup multimedia_control
You can set the type of flash effect used when an image is captured, and test to see
if the flash hardware is ready to fire.
diff --git a/src/multimedia/controls/qcamerafocuscontrol.cpp b/src/multimedia/controls/qcamerafocuscontrol.cpp
index 1e580a5c4..6c904757d 100644
--- a/src/multimedia/controls/qcamerafocuscontrol.cpp
+++ b/src/multimedia/controls/qcamerafocuscontrol.cpp
@@ -52,7 +52,9 @@ QT_BEGIN_NAMESPACE
focusing related camera parameters.
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
The interface name of QCameraFocusControl is \c com.nokia.Qt.QCameraFocusControl/1.0 as
defined in QCameraFocusControl_iid.
diff --git a/src/multimedia/controls/qcameraimagecapturecontrol.cpp b/src/multimedia/controls/qcameraimagecapturecontrol.cpp
index f86c50ed0..1f3606069 100644
--- a/src/multimedia/controls/qcameraimagecapturecontrol.cpp
+++ b/src/multimedia/controls/qcameraimagecapturecontrol.cpp
@@ -51,9 +51,9 @@ QT_BEGIN_NAMESPACE
for image capture services.
\inmodule QtMultimedia
- \ingroup multimedia-serv
-
+ \ingroup multimedia
+ \ingroup multimedia_control
The interface name of QCameraImageCaptureControl is \c com.nokia.Qt.QCameraImageCaptureControl/1.0 as
defined in QCameraImageCaptureControl_iid.
diff --git a/src/multimedia/controls/qcameraimageprocessingcontrol.cpp b/src/multimedia/controls/qcameraimageprocessingcontrol.cpp
index 967b0d38f..d59718a95 100644
--- a/src/multimedia/controls/qcameraimageprocessingcontrol.cpp
+++ b/src/multimedia/controls/qcameraimageprocessingcontrol.cpp
@@ -59,7 +59,9 @@ namespace
/*!
\class QCameraImageProcessingControl
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
\brief The QCameraImageProcessingControl class provides an abstract class
diff --git a/src/multimedia/controls/qcameralockscontrol.cpp b/src/multimedia/controls/qcameralockscontrol.cpp
index 7ce0766cd..1a7db8431 100644
--- a/src/multimedia/controls/qcameralockscontrol.cpp
+++ b/src/multimedia/controls/qcameralockscontrol.cpp
@@ -53,7 +53,9 @@ QT_BEGIN_NAMESPACE
classes that control still cameras or video cameras.
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
This service is provided by a QMediaService object via
QMediaService::control(). It is used by QCamera.
diff --git a/src/multimedia/controls/qimageencodercontrol.cpp b/src/multimedia/controls/qimageencodercontrol.cpp
index 11d8d3c70..328ce2d48 100644
--- a/src/multimedia/controls/qimageencodercontrol.cpp
+++ b/src/multimedia/controls/qimageencodercontrol.cpp
@@ -48,7 +48,9 @@ QT_BEGIN_NAMESPACE
\class QImageEncoderControl
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
\brief The QImageEncoderControl class provides access to the settings of a media service that
performs image encoding.
diff --git a/src/multimedia/controls/qmediabackgroundplaybackcontrol.cpp b/src/multimedia/controls/qmediabackgroundplaybackcontrol.cpp
index a5f3d0910..9c93ac5e1 100644
--- a/src/multimedia/controls/qmediabackgroundplaybackcontrol.cpp
+++ b/src/multimedia/controls/qmediabackgroundplaybackcontrol.cpp
@@ -48,8 +48,9 @@ QT_BEGIN_NAMESPACE
/*!
\class QMediaBackgroundPlaybackControl
\inmodule QtMultimedia
- \ingroup multimedia
+ \ingroup multimedia
+ \ingroup multimedia_control
\brief The QMediaBackgroundPlaybackControl class provides access to the background playback
related control of a QMediaService.
diff --git a/src/multimedia/controls/qmediacontainercontrol.cpp b/src/multimedia/controls/qmediacontainercontrol.cpp
index 44b7220b4..142ccb719 100644
--- a/src/multimedia/controls/qmediacontainercontrol.cpp
+++ b/src/multimedia/controls/qmediacontainercontrol.cpp
@@ -50,7 +50,9 @@ QT_BEGIN_NAMESPACE
\brief The QMediaContainerControl class provides access to the output container format of a QMediaService
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
If a QMediaService supports writing encoded data it will implement
QMediaContainerControl. This control provides information about the output
diff --git a/src/multimedia/controls/qmediagaplessplaybackcontrol.cpp b/src/multimedia/controls/qmediagaplessplaybackcontrol.cpp
index ec0ed76ff..c80be984a 100644
--- a/src/multimedia/controls/qmediagaplessplaybackcontrol.cpp
+++ b/src/multimedia/controls/qmediagaplessplaybackcontrol.cpp
@@ -45,7 +45,9 @@
/*!
\class QMediaGaplessPlaybackControl
\inmodule QtMultimedia
+
\ingroup multimedia
+ \ingroup multimedia_control
\brief The QMediaGaplessPlaybackControl class provides access to the gapless playback
related control of a QMediaService.
diff --git a/src/multimedia/controls/qmedianetworkaccesscontrol.cpp b/src/multimedia/controls/qmedianetworkaccesscontrol.cpp
index f592fb3a4..0fefc3f1e 100644
--- a/src/multimedia/controls/qmedianetworkaccesscontrol.cpp
+++ b/src/multimedia/controls/qmedianetworkaccesscontrol.cpp
@@ -45,11 +45,12 @@ QT_BEGIN_NAMESPACE
/*!
\class QMediaNetworkAccessControl
- \preliminary
\brief The QMediaNetworkAccessControl class allows the setting of the Network Access Point for media related activities.
- \ingroup multimedia-serv
\inmodule QtMultimedia
+ \ingroup multimedia
+ \ingroup multimedia_control
+
The functionality provided by this control allows the
setting of a Network Access Point.
diff --git a/src/multimedia/controls/qmediaplayercontrol.cpp b/src/multimedia/controls/qmediaplayercontrol.cpp
index 7035c3063..e882817b2 100644
--- a/src/multimedia/controls/qmediaplayercontrol.cpp
+++ b/src/multimedia/controls/qmediaplayercontrol.cpp
@@ -49,7 +49,9 @@ QT_BEGIN_NAMESPACE
/*!
\class QMediaPlayerControl
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
\brief The QMediaPlayerControl class provides access to the media playing
diff --git a/src/multimedia/controls/qmediaplaylistcontrol.cpp b/src/multimedia/controls/qmediaplaylistcontrol.cpp
index a024045c8..b9c60dd58 100644
--- a/src/multimedia/controls/qmediaplaylistcontrol.cpp
+++ b/src/multimedia/controls/qmediaplaylistcontrol.cpp
@@ -48,7 +48,9 @@ QT_BEGIN_NAMESPACE
/*!
\class QMediaPlaylistControl
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
\brief The QMediaPlaylistControl class provides access to the playlist
diff --git a/src/multimedia/controls/qmediaplaylistsourcecontrol.cpp b/src/multimedia/controls/qmediaplaylistsourcecontrol.cpp
index b91ce33d3..bc18be46e 100644
--- a/src/multimedia/controls/qmediaplaylistsourcecontrol.cpp
+++ b/src/multimedia/controls/qmediaplaylistsourcecontrol.cpp
@@ -48,7 +48,9 @@ QT_BEGIN_NAMESPACE
/*!
\class QMediaPlaylistSourceControl
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
\brief The QMediaPlaylistSourceControl class provides access to the playlist playback
diff --git a/src/multimedia/controls/qmediarecordercontrol.cpp b/src/multimedia/controls/qmediarecordercontrol.cpp
index cccc6c5e2..c31b8cc0f 100644
--- a/src/multimedia/controls/qmediarecordercontrol.cpp
+++ b/src/multimedia/controls/qmediarecordercontrol.cpp
@@ -47,8 +47,9 @@ QT_BEGIN_NAMESPACE
/*!
\class QMediaRecorderControl
\inmodule QtMultimedia
- \ingroup multimedia-serv
+ \ingroup multimedia
+ \ingroup multimedia_control
\brief The QMediaRecorderControl class provides access to the recording
functionality of a QMediaService.
diff --git a/src/multimedia/controls/qmediastreamscontrol.cpp b/src/multimedia/controls/qmediastreamscontrol.cpp
index 056ad7c80..001daecf1 100644
--- a/src/multimedia/controls/qmediastreamscontrol.cpp
+++ b/src/multimedia/controls/qmediastreamscontrol.cpp
@@ -58,10 +58,11 @@ namespace
/*!
\class QMediaStreamsControl
- \preliminary
-
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
+
\brief The QMediaStreamsControl class provides a media stream selection control.
diff --git a/src/multimedia/controls/qmetadatareadercontrol.cpp b/src/multimedia/controls/qmetadatareadercontrol.cpp
index f122a2d2f..7272974c6 100644
--- a/src/multimedia/controls/qmetadatareadercontrol.cpp
+++ b/src/multimedia/controls/qmetadatareadercontrol.cpp
@@ -48,7 +48,9 @@ QT_BEGIN_NAMESPACE
/*!
\class QMetaDataReaderControl
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
\brief The QMetaDataReaderControl class provides read access to the
diff --git a/src/multimedia/controls/qmetadatawritercontrol.cpp b/src/multimedia/controls/qmetadatawritercontrol.cpp
index c7dcb5c70..5111a7e3b 100644
--- a/src/multimedia/controls/qmetadatawritercontrol.cpp
+++ b/src/multimedia/controls/qmetadatawritercontrol.cpp
@@ -48,7 +48,9 @@ QT_BEGIN_NAMESPACE
/*!
\class QMetaDataWriterControl
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
\brief The QMetaDataWriterControl class provides write access to the
diff --git a/src/multimedia/controls/qradiodatacontrol.cpp b/src/multimedia/controls/qradiodatacontrol.cpp
index 38a26d4dc..40d1ff71a 100644
--- a/src/multimedia/controls/qradiodatacontrol.cpp
+++ b/src/multimedia/controls/qradiodatacontrol.cpp
@@ -49,7 +49,9 @@ QT_BEGIN_NAMESPACE
/*!
\class QRadioDataControl
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
\brief The QRadioDataControl class provides access to the RDS functionality of the
diff --git a/src/multimedia/controls/qradiotunercontrol.cpp b/src/multimedia/controls/qradiotunercontrol.cpp
index fba568910..14f277a3e 100644
--- a/src/multimedia/controls/qradiotunercontrol.cpp
+++ b/src/multimedia/controls/qradiotunercontrol.cpp
@@ -49,7 +49,9 @@ QT_BEGIN_NAMESPACE
/*!
\class QRadioTunerControl
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
\brief The QRadioTunerControl class provides access to the radio tuning
diff --git a/src/multimedia/controls/qvideodevicecontrol.cpp b/src/multimedia/controls/qvideodevicecontrol.cpp
index 4d79de5f2..416dfc131 100644
--- a/src/multimedia/controls/qvideodevicecontrol.cpp
+++ b/src/multimedia/controls/qvideodevicecontrol.cpp
@@ -48,7 +48,9 @@ QT_BEGIN_NAMESPACE
\brief The QVideoDeviceControl class provides an video device selector media control.
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
The QVideoDeviceControl class provides descriptions of the video devices
available on a system and allows one to be selected as the endpoint of a
diff --git a/src/multimedia/controls/qvideoencodercontrol.cpp b/src/multimedia/controls/qvideoencodercontrol.cpp
index da806e246..53c835ab5 100644
--- a/src/multimedia/controls/qvideoencodercontrol.cpp
+++ b/src/multimedia/controls/qvideoencodercontrol.cpp
@@ -49,7 +49,9 @@ QT_BEGIN_NAMESPACE
\class QVideoEncoderControl
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
\brief The QVideoEncoderControl class provides access to the settings
of a media service that performs video encoding.
diff --git a/src/multimedia/controls/qvideorenderercontrol.cpp b/src/multimedia/controls/qvideorenderercontrol.cpp
index dafc2add2..62048b520 100644
--- a/src/multimedia/controls/qvideorenderercontrol.cpp
+++ b/src/multimedia/controls/qvideorenderercontrol.cpp
@@ -48,12 +48,10 @@ QT_BEGIN_NAMESPACE
/*!
\class QVideoRendererControl
-
- \brief The QVideoRendererControl class provides a control for rendering
- to a video surface.
-
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
Using the surface() property of QVideoRendererControl a
QAbstractVideoSurface may be set as the video render target of a