Move the backend specific documentation into a nicer place.

We really don't need to bore the 99.9% of people who won't care. And it's certainly not more important than camera. Reviewed-by: Derick Hawcroft (cherry picked from commit 51e3a1bc45ffc2688fcd3949216aedda4c41bf81) Change-Id: I8add47e42c2c06bf5e16f406604a19531af6901e Reviewed-on: http://codereview.qt-project.org/5501 Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Michael Goddard <michael.goddard@nokia.com>
2011-08-31 17:37:58 +10:00
parent 589b2e3adf
commit 26d8bedc39
30 changed files with 164 additions and 137 deletions
--- a/src/multimediakit/qaudioencodercontrol.cpp
+++ b/src/multimediakit/qaudioencodercontrol.cpp
@@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE
 /*!
    \class QAudioEncoderControl
    \inmodule QtMultimediaKit
-    \ingroup multimedia
+    \ingroup multimedia-serv
    \since 1.0

    \brief The QAudioEncoderControl class provides access to the settings of a
--- a/src/multimediakit/qcameracapturebufferformatcontrol.cpp
+++ b/src/multimediakit/qcameracapturebufferformatcontrol.cpp
@@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE
    The format is of type QVideoFrame::PixelFormat.

    \inmodule QtMultimediaKit
-    \ingroup camera
+    \ingroup multimedia-serv

    The interface name of QCameraCaptureBufferFormatControl is \c com.nokia.Qt.QCameraCaptureBufferFormatControl/1.0 as
    defined in QCameraCaptureBufferFormatControl_iid.
--- a/src/multimediakit/qcameracapturedestinationcontrol.cpp
+++ b/src/multimediakit/qcameracapturedestinationcontrol.cpp
@@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE
    Depending on backend capabilities capture to file, buffer or both can be supported.

    \inmodule QtMultimediaKit
-    \ingroup camera
+    \ingroup multimedia-serv



--- a/src/multimediakit/qcameracontrol.cpp
+++ b/src/multimediakit/qcameracontrol.cpp
@@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE
    classes that control still cameras or video cameras.

    \inmodule QtMultimediaKit
-    \ingroup camera
+    \ingroup multimedia-serv
    \since 1.1

    This service is provided by a QMediaService object via
--- a/src/multimediakit/qcameraexposurecontrol.cpp
+++ b/src/multimediakit/qcameraexposurecontrol.cpp
@@ -50,7 +50,7 @@ QT_BEGIN_NAMESPACE
    \brief The QCameraExposureControl class allows controlling camera exposure parameters.

    \inmodule QtMultimediaKit
-    \ingroup camera
+    \ingroup multimedia-serv
    \since 1.1

    You can adjust a number of parameters that will affect images and video taken with
--- a/src/multimediakit/qcameraflashcontrol.cpp
+++ b/src/multimediakit/qcameraflashcontrol.cpp
@@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE

    \brief The QCameraFlashControl class allows controlling a camera's flash.

-    \ingroup camera
+    \ingroup multimedia-serv
    \inmodule QtMultimediaKit
    \since 1.1

--- a/src/multimediakit/qcamerafocuscontrol.cpp
+++ b/src/multimediakit/qcamerafocuscontrol.cpp
@@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE
    focusing related camera parameters.

    \inmodule QtMultimediaKit
-    \ingroup camera
+    \ingroup multimedia-serv
    \since 1.1

    The interface name of QCameraFocusControl is \c com.nokia.Qt.QCameraFocusControl/1.0 as
--- a/src/multimediakit/qcameraimagecapture.cpp
+++ b/src/multimediakit/qcameraimagecapture.cpp
@@ -59,7 +59,7 @@ QT_BEGIN_NAMESPACE
 /*!
    \class QCameraImageCapture
    \inmodule QtMultimediaKit
-    \ingroup multimedia
+    \ingroup camera
    \since 1.1


--- a/src/multimediakit/qcameraimagecapturecontrol.cpp
+++ b/src/multimediakit/qcameraimagecapturecontrol.cpp
@@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE
    for image capture services.

    \inmodule QtMultimediaKit
-    \ingroup camera
+    \ingroup multimedia-serv
    \since 1.1


--- a/src/multimediakit/qcameralockscontrol.cpp
+++ b/src/multimediakit/qcameralockscontrol.cpp
@@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE
    classes that control still cameras or video cameras.

    \inmodule QtMultimediaKit
-    \ingroup camera
+    \ingroup multimedia-serv
    \since 1.1

    This service is provided by a QMediaService object via
--- a/src/multimediakit/qimageencodercontrol.cpp
+++ b/src/multimediakit/qimageencodercontrol.cpp
@@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE
    \class QImageEncoderControl

    \inmodule QtMultimediaKit
-    \ingroup multimedia
+    \ingroup multimedia-serv
    \since 1.0

    \brief The QImageEncoderControl class provides access to the settings of a media service that
--- a/src/multimediakit/qmediacontainercontrol.cpp
+++ b/src/multimediakit/qmediacontainercontrol.cpp
@@ -50,7 +50,7 @@ QT_BEGIN_NAMESPACE
    \brief The QMediaContainerControl class provides access to the output container format of a QMediaService

    \inmodule QtMultimediaKit
-    \ingroup multimedia
+    \ingroup multimedia-serv
    \since 1.0

    If a QMediaService supports writing encoded data it will implement
--- a/src/multimediakit/qmediacontrol.cpp
+++ b/src/multimediakit/qmediacontrol.cpp
@@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE
 /*!
    \class QMediaControl
    \inmodule QtMultimediaKit
-    \ingroup multimedia
+    \ingroup multimedia-serv
    \since 1.0


--- a/src/multimediakit/qmedianetworkaccesscontrol.cpp
+++ b/src/multimediakit/qmedianetworkaccesscontrol.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
    \class QMediaNetworkAccessControl
    \preliminary
    \brief The QMediaNetworkAccessControl class allows the setting of the Network Access Point for media related activities.
-    \ingroup multimedia
+    \ingroup multimedia-serv
    \inmodule QtMultimediaKit
    \since 1.2

--- a/src/multimediakit/qmediaplayercontrol.cpp
+++ b/src/multimediakit/qmediaplayercontrol.cpp
@@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE
 /*!
    \class QMediaPlayerControl
    \inmodule QtMultimediaKit
-    \ingroup multimedia
+    \ingroup multimedia-serv
    \since 1.0


--- a/src/multimediakit/qmediaplaylistcontrol.cpp
+++ b/src/multimediakit/qmediaplaylistcontrol.cpp
@@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE
 /*!
    \class QMediaPlaylistControl
    \inmodule QtMultimediaKit
-    \ingroup multimedia
+    \ingroup multimedia-serv
    \since 1.0


--- a/src/multimediakit/qmediaplaylistsourcecontrol.cpp
+++ b/src/multimediakit/qmediaplaylistsourcecontrol.cpp
@@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE
 /*!
    \class QMediaPlaylistSourceControl
    \inmodule QtMultimediaKit
-    \ingroup multimedia
+    \ingroup multimedia-serv
    \since 1.0


--- a/src/multimediakit/qmediarecordercontrol.cpp
+++ b/src/multimediakit/qmediarecordercontrol.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
 /*!
    \class QMediaRecorderControl
    \inmodule QtMultimediaKit
-    \ingroup multimedia
+    \ingroup multimedia-serv
    \since 1.0


--- a/src/multimediakit/qmediaservice.cpp
+++ b/src/multimediakit/qmediaservice.cpp
@@ -54,7 +54,7 @@ QT_BEGIN_NAMESPACE
    \brief The QMediaService class provides a common base class for media
    service implementations.
    \inmodule QtMultimediaKit
-    \ingroup multimedia
+    \ingroup multimedia-serv
    \since 1.0


--- a/src/multimediakit/qmediaserviceprovider.cpp
+++ b/src/multimediakit/qmediaserviceprovider.cpp
@@ -85,7 +85,7 @@ public:
    \brief The QMediaServiceProviderHint class describes what is required of a QMediaService.

    \inmodule QtMultimediaKit
-    \ingroup multimedia
+    \ingroup multimedia-serv
    \since 1.0

    The QMediaServiceProvider class uses hints to select an appropriate media service.
--- a/src/multimediakit/qmediastreamscontrol.cpp
+++ b/src/multimediakit/qmediastreamscontrol.cpp
@@ -49,10 +49,10 @@ QT_BEGIN_NAMESPACE
    \preliminary

    \inmodule QtMultimediaKit
-    \ingroup multimedia
+    \ingroup multimedia-serv
    \brief The QMediaStreamsControl class provides a media stream selection control.

-    \ingroup multimedia
+    \ingroup multimedia-serv
    \since 1.0

    The QMediaStreamsControl class provides descriptions of the available media streams
--- a/src/multimediakit/qmetadatawritercontrol.cpp
+++ b/src/multimediakit/qmetadatawritercontrol.cpp
@@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE
 /*!
    \class QMetaDataWriterControl
    \inmodule QtMultimediaKit
-    \ingroup multimedia
+    \ingroup multimedia-serv
    \since 1.0


--- a/src/multimediakit/qradiotunercontrol.cpp
+++ b/src/multimediakit/qradiotunercontrol.cpp
@@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE
 /*!
    \class QRadioTunerControl
    \inmodule QtMultimediaKit
-    \ingroup multimedia
+    \ingroup multimedia-serv
    \since 1.0


--- a/src/multimediakit/qvideodevicecontrol.cpp
+++ b/src/multimediakit/qvideodevicecontrol.cpp
@@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE

    \brief The QVideoDeviceControl class provides an video device selector media control.
    \inmodule QtMultimediaKit
-    \ingroup multimedia
+    \ingroup multimedia-serv
    \since 1.0

    The QVideoDeviceControl class provides descriptions of the video devices
--- a/src/multimediakit/qvideoencodercontrol.cpp
+++ b/src/multimediakit/qvideoencodercontrol.cpp
@@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE
    \class QVideoEncoderControl

    \inmodule QtMultimediaKit
-    \ingroup multimedia
+    \ingroup multimedia-serv
    \since 1.0

    \brief The QVideoEncoderControl class provides access to the settings
--- a/src/multimediakit/qvideorenderercontrol.cpp
+++ b/src/multimediakit/qvideorenderercontrol.cpp
@@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE
    to a video surface.

    \inmodule QtMultimediaKit
-    \ingroup multimedia
+    \ingroup multimedia-serv
    \since 1.0

    Using the surface() property of QVideoRendererControl a
--- a/src/multimediakitwidgets/qvideowidgetcontrol.cpp
+++ b/src/multimediakitwidgets/qvideowidgetcontrol.cpp
@@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE
    implements a video widget.

    \inmodule QtMultimediaKit
-    \ingroup multimedia
+    \ingroup multimedia-serv
    \since 1.0

    The videoWidget() property of QVideoWidgetControl provides a pointer to a
--- a/src/multimediakitwidgets/qvideowindowcontrol.cpp
+++ b/src/multimediakitwidgets/qvideowindowcontrol.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
    \class QVideoWindowControl

    \inmodule QtMultimediaKit
-    \ingroup multimedia
+    \ingroup multimedia-serv
    \brief The QVideoWindowControl class provides a media control for rendering video to a window.
    \since 1.0