diff options
| author | Angus Cummings <angus.cummings@nokia.com> | 2012-04-30 16:49:23 +1000 |
|---|---|---|
| committer | Qt by Nokia <qt-info@nokia.com> | 2012-05-16 05:21:25 +0200 |
| commit | 9e6d03584a097964e5f08c46cd02338b0b043080 (patch) | |
| tree | d00b2c09412236e387337890bb2260dc2d3741d6 /src/imports/multimedia/qdeclarativecameraflash.cpp | |
| parent | fdb5c419c4fb7b1ae0268e496ccdd0ffa03b74ce (diff) | |
Minor doc fixes for QML
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>
Diffstat (limited to 'src/imports/multimedia/qdeclarativecameraflash.cpp')
| -rw-r--r-- | src/imports/multimedia/qdeclarativecameraflash.cpp | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/src/imports/multimedia/qdeclarativecameraflash.cpp b/src/imports/multimedia/qdeclarativecameraflash.cpp index 1c9a69a02..1be875642 100644 --- a/src/imports/multimedia/qdeclarativecameraflash.cpp +++ b/src/imports/multimedia/qdeclarativecameraflash.cpp @@ -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 |