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>
2012-01-16 16:27:32 +10:00
parent 53d71baed3
commit 508ca28196
89 changed files with 238 additions and 372 deletions
--- 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.
--- 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.
--- 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.
--- 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.
--- 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.
--- 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.
--- 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.
--- 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.
--- 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
--- 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.
--- 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.
--- 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.
--- 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
--- 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.
--- 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.

--- 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
--- 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
--- 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
--- 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.
--- 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.


--- 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
--- 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
--- 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
--- 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
--- 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
--- 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.
--- 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