Doc: Fix documentation warnings

Add a custom module header, used only for documentation builds, that
pulls in also the QtMultimediaWidgets module.

Several documentation fixes to clean up warnings from clang.

Task-number: QTBUG-67790
Change-Id: I6c1013798a648250c8555eb92684ec3b33ff7531
Reviewed-by: Martin Smith <martin.smith@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>

5 files changed, 19 insertions, 18 deletions

diff --git a/src/multimedia/camera/qcamera.cpp b/src/multimedia/camera/qcamera.cpp
index fd804316c..722c5b629 100644
--- a/src/multimedia/camera/qcamera.cpp
+++ b/src/multimedia/camera/qcamera.cpp
@@ -478,11 +478,11 @@ QCameraImageProcessing *QCamera::imageProcessing() const
 }
 
 /*!
-  Sets the QVideoWidget based camera \a viewfinder.
-  The previously set viewfinder is detached.
-*/
+    Sets the QVideoWidget based camera \a viewfinder.
+    The previously set viewfinder is detached.
 
-// QVideoWidget is forward declared
+    //! QVideoWidget is forward declared.
+*/
 void QCamera::setViewfinder(QVideoWidget *viewfinder)
 {
     Q_D(QCamera);
@@ -498,10 +498,11 @@ void QCamera::setViewfinder(QVideoWidget *viewfinder)
 }
 
 /*!
-  Sets the QGraphicsVideoItem based camera \a viewfinder.
-  The previously set viewfinder is detached.
+    Sets the QGraphicsVideoItem based camera \a viewfinder.
+    The previously set viewfinder is detached.
+
+    //! QGraphicsVideoItem is forward declared.
 */
-// QGraphicsVideoItem is forward declared
 void QCamera::setViewfinder(QGraphicsVideoItem *viewfinder)
 {
     Q_D(QCamera);
diff --git a/src/multimedia/camera/qcamera.h b/src/multimedia/camera/qcamera.h
index 06187fec0..b2582cd19 100644
--- a/src/multimedia/camera/qcamera.h
+++ b/src/multimedia/camera/qcamera.h
@@ -232,15 +232,15 @@ public Q_SLOTS:
     void unlock(QCamera::LockTypes locks);
 
 Q_SIGNALS:
-    void stateChanged(QCamera::State);
+    void stateChanged(QCamera::State state);
     void captureModeChanged(QCamera::CaptureModes);
-    void statusChanged(QCamera::Status);
+    void statusChanged(QCamera::Status status);
 
     void locked();
     void lockFailed();
 
-    void lockStatusChanged(QCamera::LockStatus, QCamera::LockChangeReason);
-    void lockStatusChanged(QCamera::LockType, QCamera::LockStatus, QCamera::LockChangeReason);
+    void lockStatusChanged(QCamera::LockStatus status, QCamera::LockChangeReason reason);
+    void lockStatusChanged(QCamera::LockType lock, QCamera::LockStatus status, QCamera::LockChangeReason reason);
 
     void error(QCamera::Error);
 
diff --git a/src/multimedia/camera/qcameraexposure.h b/src/multimedia/camera/qcameraexposure.h
index 336d4c0b3..f8eb68fbf 100644
--- a/src/multimedia/camera/qcameraexposure.h
+++ b/src/multimedia/camera/qcameraexposure.h
@@ -160,7 +160,7 @@ Q_SIGNALS:
 
     void apertureChanged(qreal);
     void apertureRangeChanged();
-    void shutterSpeedChanged(qreal);
+    void shutterSpeedChanged(qreal speed);
     void shutterSpeedRangeChanged();
     void isoSensitivityChanged(int);
     void exposureCompensationChanged(qreal);
diff --git a/src/multimedia/camera/qcameraimagecapture.cpp b/src/multimedia/camera/qcameraimagecapture.cpp
index 03089e006..cedae2609 100644
--- a/src/multimedia/camera/qcameraimagecapture.cpp
+++ b/src/multimedia/camera/qcameraimagecapture.cpp
@@ -632,9 +632,9 @@ void QCameraImageCapture::cancelCapture()
 */
 
 /*!
-    \fn QCameraImageCapture::imageAvailable(int id, const QVideoFrame &buffer)
+    \fn QCameraImageCapture::imageAvailable(int id, const QVideoFrame &frame)
 
-    Signal emitted when the frame with request \a id is available as \a buffer.
+    Signal emitted when the \a frame with request \a id is available.
 */
 
 /*!
diff --git a/src/multimedia/camera/qcameraimagecapture.h b/src/multimedia/camera/qcameraimagecapture.h
index 6fedb7e2c..931fe3902 100644
--- a/src/multimedia/camera/qcameraimagecapture.h
+++ b/src/multimedia/camera/qcameraimagecapture.h
@@ -124,14 +124,14 @@ public Q_SLOTS:
 Q_SIGNALS:
     void error(int id, QCameraImageCapture::Error error, const QString &errorString);
 
-    void readyForCaptureChanged(bool);
-    void bufferFormatChanged(QVideoFrame::PixelFormat);
-    void captureDestinationChanged(QCameraImageCapture::CaptureDestinations);
+    void readyForCaptureChanged(bool ready);
+    void bufferFormatChanged(QVideoFrame::PixelFormat format);
+    void captureDestinationChanged(QCameraImageCapture::CaptureDestinations destination);
 
     void imageExposed(int id);
     void imageCaptured(int id, const QImage &preview);
     void imageMetadataAvailable(int id, const QString &key, const QVariant &value);
-    void imageAvailable(int id, const QVideoFrame &image);
+    void imageAvailable(int id, const QVideoFrame &frame);
     void imageSaved(int id, const QString &fileName);
 
 protected: