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>
This commit is contained in:
Jonas Rabbe
2012-04-03 15:55:55 +10:00
committed by Qt by Nokia
parent e908790a6a
commit c532850fd1
68 changed files with 476 additions and 318 deletions

View File

@@ -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):

View File

@@ -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)

View File

@@ -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.
*/

View File

@@ -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;

View File

@@ -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
*/