slapin/qtmultimedia
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Minor doc fixes for QML

Browse Source 
renaming QML element to QML type
removing some \fn tags that were making the docs not build
some rewording
some new signal docs

Change-Id: I9b350dad1780276959aef4105e53b91082a6083e
Reviewed-by: Dmytro Poplavskiy <dmytro.poplavskiy@nokia.com>
This commit is contained in:
Angus Cummings
2012-04-30 16:49:23 +10:00
committed by Qt by Nokia
parent fdb5c419c4
commit 9e6d03584a
35 changed files with 370 additions and 299 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
src/imports/multimedia/qdeclarativecameraflash.cpp
View File

@@ -47,19 +47,19 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass CameraFlash QDeclarativeCameraFlash
\inqmlmodule QtMultimedia 5
\brief The CameraFlash element provides interface for flash related camera settings.
\brief The CameraFlash type provides interface for flash related camera settings.
\ingroup multimedia_qml
\ingroup camera_qml
This element is part of the \b{QtMultimedia 5.0} module.
CameraFlash is part of the \b{QtMultimedia 5.0} module.
The CameraFlash element allows you to operate the camera flash
This type allows you to operate the camera flash
hardware and control the flash mode used. Not all cameras have
flash hardware (and in some cases it is shared with the
\l {Torch}{torch} hardware).
It should not be constructed separately but provided by the
\l Camera element's \c flash property.
It should not be constructed separately, instead the
\c flash property of a \l Camera should be used.
\qml
import QtQuick 2.0
@@ -78,7 +78,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QDeclarativeCameraFlash
\internal
\brief The CameraFlash element provides interface for flash related camera settings.
\brief The CameraFlash provides interface for flash related camera settings.
*/
/*!
@@ -142,12 +142,15 @@ void QDeclarativeCameraFlash::setFlashMode(int mode)
/*!
\qmlsignal QtMultimedia5::CameraExposure::flashModeChanged(int)
\fn void QDeclarativeCameraFlash::flashModeChanged(int)
This signal is emitted when the \c flashMode property is changed.
The corresponding handler is \c onFlashModeChanged.
*/
/*!
\qmlsignal QtMultimedia5::CameraExposure::flashReady(bool)
\fn void QDeclarativeCameraFlash::flashReady(bool)
This signal is emitted when QCameraExposure indicates that
the flash is ready to use.
The corresponsing handler is \c onFlashReadyChanged.
*/
QT_END_NAMESPACE