summaryrefslogtreecommitdiffstats
path: root/src/multimedia/camera
diff options
context:
space:
mode:
authorJonas Rabbe <jonas.rabbe@nokia.com>2012-04-03 15:55:55 +1000
committerQt by Nokia <qt-info@nokia.com>2012-04-05 03:54:02 +0200
commitc532850fd1f55b563930ad6e178e30cf560ee532 (patch)
tree818e0cb5a8fe04193101ba72c15a38243b0e0157 /src/multimedia/camera
parente908790a6a8b6cc779e5ec24ec94f6caf00d354e (diff)
Updated a lot of minor fixes to the docs and removed warnings from qdoc
Change-Id: Ib7fd75fb93c038f9e8fa9d71b6ad01fb27b97622 Reviewed-by: Michael Goddard <michael.goddard@nokia.com>
Diffstat (limited to 'src/multimedia/camera')
-rw-r--r--src/multimedia/camera/qcamera.cpp2
-rw-r--r--src/multimedia/camera/qcameraexposure.cpp16
-rw-r--r--src/multimedia/camera/qcameraimagecapture.cpp14
-rw-r--r--src/multimedia/camera/qcameraimagecapture.h2
-rw-r--r--src/multimedia/camera/qcameraimageprocessing.cpp2
5 files changed, 27 insertions, 9 deletions
diff --git a/src/multimedia/camera/qcamera.cpp b/src/multimedia/camera/qcamera.cpp
index bf9db9245..baecb1a06 100644
--- a/src/multimedia/camera/qcamera.cpp
+++ b/src/multimedia/camera/qcamera.cpp
@@ -336,7 +336,7 @@ void QCameraPrivate::_q_updateLockStatus(QCamera::LockType type, QCamera::LockSt
/*!
- Construct a QCamera from service \a provider and \a parent.
+ Construct a QCamera with a \a parent.
*/
QCamera::QCamera(QObject *parent):
diff --git a/src/multimedia/camera/qcameraexposure.cpp b/src/multimedia/camera/qcameraexposure.cpp
index 2a52a5f8d..9e4870c7b 100644
--- a/src/multimedia/camera/qcameraexposure.cpp
+++ b/src/multimedia/camera/qcameraexposure.cpp
@@ -335,9 +335,9 @@ void QCameraExposure::setMeteringMode(QCameraExposure::MeteringMode mode)
}
/*!
- \property QCameraExposure::spotMeteringPoint
+ \fn QCameraExposure::spotMeteringPoint() const
- When supported, this property is the (normalized) position of the point of the image
+ When supported, the spot metering point is the (normalized) position of the point of the image
where exposure metering will be performed. This is typically used to indicate an
"interesting" area of the image that should be exposed properly.
@@ -346,13 +346,23 @@ void QCameraExposure::setMeteringMode(QCameraExposure::MeteringMode mode)
which is typically the default spot metering point.
The spot metering point is only used with spot metering mode.
- */
+
+ \sa setSpotMeteringPoint()
+*/
QPointF QCameraExposure::spotMeteringPoint() const
{
return d_func()->exposureControl ? d_func()->exposureControl->actualValue(QCameraExposureControl::SpotMeteringPoint).toPointF() : QPointF();
}
+/*!
+ \fn QCameraExposure::setSpotMeteringPoint(const QPointF &point)
+
+ Allows setting the spot metering point to \a point.
+
+ \sa spotMeteringPoint()
+*/
+
void QCameraExposure::setSpotMeteringPoint(const QPointF &point)
{
if (d_func()->exposureControl)
diff --git a/src/multimedia/camera/qcameraimagecapture.cpp b/src/multimedia/camera/qcameraimagecapture.cpp
index fd516c0e4..81c178d2d 100644
--- a/src/multimedia/camera/qcameraimagecapture.cpp
+++ b/src/multimedia/camera/qcameraimagecapture.cpp
@@ -76,6 +76,13 @@ QT_BEGIN_NAMESPACE
\sa QCamera
*/
+/*!
+ \enum QCameraImageCapture::CaptureDestination
+
+ \value CaptureToFile Capture the image to a file.
+ \value CaptureToBuffer Capture the image to a buffer for further processing.
+*/
+
namespace
{
class MediaRecorderRegisterMetaTypes
@@ -441,9 +448,9 @@ QVideoFrame::PixelFormat QCameraImageCapture::bufferFormat() const
}
/*!
- Sets the buffer image capture format to be used.
+ Sets the buffer image capture \a format to be used.
- \sa BufferFormat() supportedBufferFormats() captureDestination()
+ \sa bufferFormat() supportedBufferFormats() captureDestination()
*/
void QCameraImageCapture::setBufferFormat(const QVideoFrame::PixelFormat format)
{
@@ -626,7 +633,8 @@ void QCameraImageCapture::cancelCapture()
/*!
\fn QCameraImageCapture::imageMetadataAvailable(int id, const QString &key, const QVariant &value)
- Signals that a metadata for an image with request \a id is available.
+ Signals that a metadata for an image with request \a id is available. Also
+ includes the \a key and \a value of the metadata.
This signal is emitted between imageExposed and imageSaved signals.
*/
diff --git a/src/multimedia/camera/qcameraimagecapture.h b/src/multimedia/camera/qcameraimagecapture.h
index 207938d6c..f050d5206 100644
--- a/src/multimedia/camera/qcameraimagecapture.h
+++ b/src/multimedia/camera/qcameraimagecapture.h
@@ -117,7 +117,7 @@ public:
QList<QVideoFrame::PixelFormat> supportedBufferFormats() const;
QVideoFrame::PixelFormat bufferFormat() const;
- void setBufferFormat(QVideoFrame::PixelFormat format);
+ void setBufferFormat(const QVideoFrame::PixelFormat format);
bool isCaptureDestinationSupported(CaptureDestinations destination) const;
CaptureDestinations captureDestination() const;
diff --git a/src/multimedia/camera/qcameraimageprocessing.cpp b/src/multimedia/camera/qcameraimageprocessing.cpp
index 990795049..4fe31b317 100644
--- a/src/multimedia/camera/qcameraimageprocessing.cpp
+++ b/src/multimedia/camera/qcameraimageprocessing.cpp
@@ -96,7 +96,7 @@ QT_BEGIN_NAMESPACE
In some cases changing these settings may result in a longer delay
before an image is ready.
- For more information on image processing of camera frames, see \l {Camera Image Processing}.
+ For more information on image processing of camera frames, see \l {camera_image_processing}{Camera Image Processing}.
\sa QCameraImageProcessingControl
*/