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

@@ -46,6 +46,7 @@ import QtMultimedia 5.0
\qmlclass Video
\inherits Item
\ingroup multimedia_qml
\ingroup multimedia_video_qml
\brief A convenience element for showing a specified video
The \c Video element is a convenience element combining the functionality

View File

@@ -62,6 +62,8 @@ QT_BEGIN_NAMESPACE
\inqmlmodule QtMultimedia 5
\ingroup multimedia_qml
\ingroup multimedia_audio_qml
\ingroup multimedia_video_qml
This element is part of the \b{QtMultimedia 5.0} module.
@@ -121,6 +123,7 @@ QT_BEGIN_NAMESPACE
\inqmlmodule QtMultimedia 5
\ingroup multimedia_qml
\ingroup multimedia_audio_qml
This element is part of the \b{QtMultimedia 5.0} module.
@@ -782,7 +785,7 @@ void QDeclarativeAudio::_q_statusChanged()
*/
/*!
\qmlsignal QtMultimedia5::Audio::onError(error, errorString)
\qmlsignal QtMultimedia5::Audio::error(error, errorString)
This handler is called when an \l {QMediaPlayer::Error}{error} has
occurred. The errorString parameter may contain more detailed

View File

@@ -143,8 +143,8 @@ void QDeclarativeCamera::_q_availabilityChanged(QtMultimedia::AvailabilityError
Basic camera state management, error reporting, and simple zoom properties are
available in the Camera element itself. For integration with C++ code, the
\l mediaObject property allows you to access the standard QtMultimedia camera
controls.
\l mediaObject property allows you to
access the standard QtMultimedia camera controls.
Many of the camera settings may take some time to apply, and might be limited
to certain supported values depending on the hardware. Several camera settings
@@ -500,6 +500,11 @@ void QDeclarativeCamera::setDigitalZoom(qreal value)
m_camera->focus()->zoomTo(opticalZoom(), value);
}
/*!
\qmlproperty variant QtMultimedia5::Camera::mediaObject
The media object for the Camera element.
*/
/*!
\qmlsignal QtMultimedia5::Camera::onError(error, errorString)

View File

@@ -60,9 +60,8 @@ QT_BEGIN_NAMESPACE
are available or saved to disk. You can adjust the resolution of the captured
image and where the saved image should go.
This element is a child of a Camera element (as the
\l {Camera::imageCapture}{imageCapture} property) and cannot be created
directly.
This element is a child of a \l Camera element (as the \c imageCapture property)
and cannot be created directly.
\qml
import QtQuick 2.0

View File

@@ -57,7 +57,7 @@ QT_BEGIN_NAMESPACE
like aperture and shutter speed, metering and ISO speed.
It should not be constructed separately but provided by the
Camera element's \l {Camera::exposure} {exposure} property.
\l Camera element's \c exposure property.
\qml
import QtQuick 2.0

View File

@@ -59,7 +59,7 @@ QT_BEGIN_NAMESPACE
\l {Torch}{torch} hardware).
It should not be constructed separately but provided by the
Camera element's \l {Camera::flash}{flash} property.
\l Camera element's \c flash property.
\qml
import QtQuick 2.0

View File

@@ -58,7 +58,7 @@ QT_BEGIN_NAMESPACE
camera frame that are selected for autofocusing.
It is not constructed separately but is provided by the
Camera element's \l {Camera::focus}{focus} property.
\l Camera element's \c focus property.
\qml
import QtQuick 2.0
@@ -122,8 +122,8 @@ QDeclarativeCamera::FocusMode QDeclarativeCameraFocus::focusMode() const
}
/*!
\qmlmethod bool QtMultimedia5::CameraFocus::isFocusModeSupported(mode)
\fn QDeclarativeCameraFocus::isFocusPointModeSupported(QDeclarativeCamera::FocusMode mode)
\qmlmethod bool QtMultimedia5::CameraFocus::isFocusModeSupported(mode) const
\fn QDeclarativeCameraFocus::isFocusModeSupported(QDeclarativeCamera::FocusMode mode) const
Returns true if the supplied \a mode is a supported focus mode, and
false otherwise.
@@ -163,8 +163,8 @@ void QDeclarativeCameraFocus::setFocusPointMode(QDeclarativeCamera::FocusPointMo
}
/*!
\qmlmethod bool QtMultimedia5::CameraFocus::isFocusPointModeSupported(mode)
\fn QDeclarativeCameraFocus::isFocusPointModeSupported(QDeclarativeCamera::FocusPointMode mode)
\qmlmethod bool QtMultimedia5::CameraFocus::isFocusPointModeSupported(mode) const
\fn QDeclarativeCameraFocus::isFocusPointModeSupported(QDeclarativeCamera::FocusPointMode mode) const
Returns true if the supplied \a mode is a supported focus point mode, and
false otherwise.

View File

@@ -82,7 +82,7 @@ public:
QAbstractListModel *focusZones() const;
Q_INVOKABLE bool isFocusModeSupported(QDeclarativeCamera::FocusMode mode) const;
Q_INVOKABLE bool isFocusPointModeSupported(QDeclarativeCamera::FocusPointMode) const;
Q_INVOKABLE bool isFocusPointModeSupported(QDeclarativeCamera::FocusPointMode mode) const;
public Q_SLOTS:
void setFocusMode(QDeclarativeCamera::FocusMode);

View File

@@ -55,8 +55,8 @@ QT_BEGIN_NAMESPACE
done by the camera middleware, including white balance adjustments,
contrast, saturation, sharpening, and denoising
It is not constructed separately but is provided by the Camera element's
\l {Camera::imageProcessing}{imageProcessing} property.
It is not constructed separately but is provided by the \a Camera element's
\c imageProcessing property.
\qml
import QtQuick 2.0

View File

@@ -56,9 +56,8 @@ QT_BEGIN_NAMESPACE
This element allows recording camera streams to files, and adjusting recording
settings and metadata for videos.
This element is a child of a Camera element (as the
\l {Camera::videoRecorder}{videoRecorder} property) and cannot be created
directly.
This element is a child of a \l Camera element (as the \c videoRecorder property)
and cannot be created directly.
\qml
Camera {
@@ -113,7 +112,7 @@ QSize QDeclarativeCameraRecorder::captureResolution()
The audio codec to use for recording video.
Typically this is something like \c aac or \c amr-wb.
\sa whiteBalanceMode
\sa {QtMultimedia5::CameraImageProcessing::whiteBalanceMode}{whileBalanceMode}
*/
QString QDeclarativeCameraRecorder::audioCodec() const
{

View File

@@ -49,6 +49,7 @@ QT_BEGIN_NAMESPACE
\inqmlmodule QtMultimedia 5
\brief The Radio element allows you to access radio functionality from a QML application.
\ingroup multimedia_qml
\ingroup multimedia_radio_qml
\inherits Item
This element is part of the \b{QtMultimedia 5.0} module.

View File

@@ -48,6 +48,7 @@ QT_BEGIN_NAMESPACE
\inqmlmodule QtMultimedia 5
\brief The RadioData element allows you to access RDS data from a QML application.
\ingroup multimedia_qml
\ingroup multimedia_radio_qml
\inherits Item
This element is part of the \b{QtMultimedia 5.0} module.

View File

@@ -122,6 +122,7 @@ private:
\brief The VideoOutput element allows you to render video or camera viewfinder.
\ingroup multimedia_qml
\ingroup multimedia_video_qml
\inqmlmodule QtMultimedia 5
This element is part of the \b{QtMultimedia 5.0} module.