Doc: Fix warnings for undocumented members in camera API

Change-Id: I2e064684f0f148eceabd9a10f6e1ed9b341fd8ae
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
(cherry picked from commit 8bcd2edb6e5ae19d4162cbcdacc9b28582c298d1)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>

3 files changed, 102 insertions, 0 deletions

diff --git a/src/multimedia/camera/qcamera.cpp b/src/multimedia/camera/qcamera.cpp
index 0a0052f7c..680fd59ab 100644
--- a/src/multimedia/camera/qcamera.cpp
+++ b/src/multimedia/camera/qcamera.cpp
@@ -293,6 +293,8 @@ void QCamera::setActive(bool active)
 */
 
 /*!
+    \property QCamera::error
+
     Returns the error state of the camera.
 */
 
@@ -308,6 +310,8 @@ QCamera::Error QCamera::error() const
 */
 
 /*!
+    \property QCamera::errorString
+
     Returns a human readable string describing a camera's error state.
 */
 QString QCamera::errorString() const
@@ -342,6 +346,8 @@ QString QCamera::errorString() const
 */
 
 /*!
+    \property QCamera::supportedFeatures
+
     Returns the features supported by this camera.
 
     \sa QCamera::Feature
@@ -419,6 +425,8 @@ QPlatformCamera *QCamera::platformCamera()
 */
 
 /*!
+    \property QCamera::cameraDevice
+
     Returns the QCameraDevice object associated with this camera.
  */
 QCameraDevice QCamera::cameraDevice() const
@@ -455,6 +463,8 @@ void QCamera::setCameraDevice(const QCameraDevice &cameraDevice)
 */
 
 /*!
+    \property QCamera::cameraFormat
+
     Returns the camera format currently used by the camera.
 
     \sa QCameraDevice::videoFormats
@@ -542,6 +552,11 @@ QCamera::FocusMode QCamera::focusMode() const
     return d->control ? d->control->focusMode() : QCamera::FocusModeAuto;
 }
 
+/*!
+    \fn void QCamera::focusModeChanged()
+
+    Signals when the focusMode changes.
+*/
 void QCamera::setFocusMode(QCamera::FocusMode mode)
 {
     Q_D(QCamera);
@@ -572,6 +587,8 @@ bool QCamera::isFocusModeSupported(FocusMode mode) const
 */
 
 /*!
+    \property QCamera::focusPoint
+
     Returns the point currently used by the auto focus system to focus onto.
  */
 QPointF QCamera::focusPoint() const
@@ -664,6 +681,8 @@ float QCamera::focusDistance() const
 
 
 /*!
+    \property QCamera::maximumZoomFactor
+
     Returns the maximum zoom factor.
 
     This will be \c 1.0 on cameras that do not support zooming.
@@ -684,6 +703,8 @@ float QCamera::maximumZoomFactor() const
 */
 
 /*!
+    \property QCamera::minimumZoomFactor
+
     Returns the minimum zoom factor.
 
     This will be \c 1.0 on cameras that do not support zooming.
@@ -1091,6 +1112,8 @@ float QCamera::exposureTime() const
 */
 
 /*!
+    \property QCamera::manualExposureTime
+
     Set the manual exposure time to \a seconds
 */
 
@@ -1199,6 +1222,8 @@ void QCamera::setAutoExposureTime()
 */
 
 /*!
+    \property QCamera::whiteBalanceMode
+
     Returns the white balance mode being used.
 */
 QCamera::WhiteBalanceMode QCamera::whiteBalanceMode() const
@@ -1251,6 +1276,8 @@ bool QCamera::isWhiteBalanceModeSupported(QCamera::WhiteBalanceMode mode) const
 */
 
 /*!
+    \property QCamera::colorTemperature
+
     Returns the current color temperature if the
     current white balance mode is \c WhiteBalanceManual. For other modes the
     return value is undefined.
@@ -1303,6 +1330,22 @@ void QCamera::setColorTemperature(int colorTemperature)
     \value WhiteBalanceSunset       Sunset white balance mode.
 */
 
+/*!
+    \fn void QCamera::brightnessChanged()
+    \internal
+*/
+/*!
+    \fn void QCamera::contrastChanged()
+    \internal
+*/
+/*!
+    \fn void QCamera::hueChanged()
+    \internal
+*/
+/*!
+    \fn void QCamera::saturationChanged()
+    \internal
+*/
 QT_END_NAMESPACE
 
 #include "moc_qcamera.cpp"
diff --git a/src/multimedia/camera/qcameradevice.cpp b/src/multimedia/camera/qcameradevice.cpp
index e95b41ce2..435e62f70 100644
--- a/src/multimedia/camera/qcameradevice.cpp
+++ b/src/multimedia/camera/qcameradevice.cpp
@@ -89,6 +89,8 @@ QCameraFormat::~QCameraFormat() = default;
 */
 
 /*!
+    \property QCameraFormat::pixelFormat
+
     Returns the pixel format.
 
     Most commonly this is either QVideoFrameFormat::Format_Jpeg or QVideoFrameFormat::Format_YUVY
@@ -108,6 +110,8 @@ QVideoFrameFormat::PixelFormat QCameraFormat::pixelFormat() const noexcept
 */
 
 /*!
+    \property QCameraFormat::resolution
+
     Returns the resolution.
 */
 QSize QCameraFormat::resolution() const noexcept
@@ -122,6 +126,8 @@ QSize QCameraFormat::resolution() const noexcept
 */
 
 /*!
+    \property QCameraFormat::minFrameRate
+
     Returns the lowest frame rate defined by this format.
 */
 float QCameraFormat::minFrameRate() const noexcept
@@ -139,6 +145,8 @@ float QCameraFormat::minFrameRate() const noexcept
 */
 
 /*!
+    \property QCameraFormat::maxFrameRate
+
     Returns the highest frame rate defined by this format.
 
     In 6.2, the camera will always try to use the highest frame rate supported by a
@@ -286,6 +294,8 @@ bool QCameraDevice::isNull() const
 */
 
 /*!
+    \property QCameraDevice::id
+
     Returns the device id of the camera
 
     This is a unique ID to identify the camera and may not be human-readable.
@@ -302,6 +312,8 @@ QByteArray QCameraDevice::id() const
 */
 
 /*!
+    \property QCameraDevice::isDefault
+
     Returns true if this is the default camera device.
 */
 bool QCameraDevice::isDefault() const
@@ -318,6 +330,8 @@ bool QCameraDevice::isDefault() const
 */
 
 /*!
+    \property QCameraDevice::description
+
     Returns the human-readable description of the camera.
 
     Use this string to present the device to the user.
@@ -356,6 +370,8 @@ QString QCameraDevice::description() const
 */
 
 /*!
+    \property QCameraDevice::position
+
     Returns the physical position of the camera on the hardware system.
 */
 QCameraDevice::Position QCameraDevice::position() const
@@ -381,6 +397,8 @@ QList<QSize> QCameraDevice::photoResolutions() const
 */
 
 /*!
+    \property QCameraDevice::videoFormats
+
     Returns the video formats supported by the camera.
 */
 QList<QCameraFormat> QCameraDevice::videoFormats() const
diff --git a/src/multimedia/camera/qimagecapture.cpp b/src/multimedia/camera/qimagecapture.cpp
index e44558674..6d62dcb3f 100644
--- a/src/multimedia/camera/qimagecapture.cpp
+++ b/src/multimedia/camera/qimagecapture.cpp
@@ -101,6 +101,12 @@ QImageCapture::QImageCapture(QObject *parent)
 }
 
 /*!
+    \fn void QImageCapture::imageMetadataAvailable(int id, const QMediaMetaData &metaData)
+
+    Signals that an image identified by \a id has \a metaData.
+*/
+
+/*!
     \internal
 */
 void QImageCapture::setCaptureSession(QMediaCaptureSession *session)
@@ -141,6 +147,8 @@ QMediaCaptureSession *QImageCapture::captureSession() const
 }
 
 /*!
+    \property QImageCapture::error
+
     Returns the current error state.
 
     \sa errorString()
@@ -152,6 +160,8 @@ QImageCapture::Error QImageCapture::error() const
 }
 
 /*!
+    \property QImageCapture::errorString
+
     Returns a string describing the current error state.
 
     \sa error()
@@ -339,6 +349,20 @@ int QImageCapture::capture()
 */
 
 /*!
+    \enum QImageCapture::FileFormat
+
+    Choose one of the following image formats:
+
+    \value UnspecifiedFormat No format specified
+    \value JPEG \c .jpg or \c .jpeg format
+    \value PNG \c .png format
+    \value WebP \c .webp format
+    \value Tiff \c .tiff format
+    \omitvalue LastFileFormat
+*/
+
+
+/*!
     \property QImageCapture::fileFormat
     \brief The image format.
 */
@@ -367,11 +391,19 @@ void QImageCapture::setFileFormat(QImageCapture::FileFormat format)
     emit fileFormatChanged();
 }
 
+/*!
+    Returns a list of supported file formats.
+
+    \sa {QImageCapture::}{FileFormat}
+*/
 QList<QImageCapture::FileFormat> QImageCapture::supportedFormats()
 {
     return QPlatformMediaIntegration::instance()->formatInfo()->imageFormats;
 }
 
+/*!
+    Returns the name of the given format, \a f.
+*/
 QString QImageCapture::fileFormatName(QImageCapture::FileFormat f)
 {
     const char *name = nullptr;
@@ -395,6 +427,9 @@ QString QImageCapture::fileFormatName(QImageCapture::FileFormat f)
     return QString::fromUtf8(name);
 }
 
+/*!
+    Returns the description of the given file format, \a f.
+*/
 QString QImageCapture::fileFormatDescription(QImageCapture::FileFormat f)
 {
     const char *name = nullptr;
@@ -431,6 +466,12 @@ QSize QImageCapture::resolution() const
 }
 
 /*!
+    \fn void QImageCapture::resolutionChanged()
+
+    Signals when the image resolution changes.
+*/
+
+/*!
     Sets the \a resolution of the encoded image.
 
     An empty QSize indicates the encoder should make an optimal choice based on