diff options
author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2020-01-15 15:28:33 +0100 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2020-01-17 14:27:15 +0100 |
commit | 1cc4b7e28bf9f8f684bf17ed30a822aa6d1c6735 (patch) | |
tree | 689215c8378e99a4ba16733fc694ebb69b99016a /src/multimedia | |
parent | ee50d9a38689c2d56d530ef41f94ee0f6844b571 (diff) |
Doc: Explain that the camera consumes power in Camera.LoadedState
Fix the QDoc code to use \value for \qmlproperty enumeration. Remove
empty lines within \value on the C++ side, because they break the
docs.
Fixes: QTBUG-81364
Change-Id: I5b26e4ec9d86292d63d70c3751865ca26ff13fa0
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Diffstat (limited to 'src/multimedia')
-rw-r--r-- | src/multimedia/camera/qcamera.cpp | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/src/multimedia/camera/qcamera.cpp b/src/multimedia/camera/qcamera.cpp index e23193f11..00c387083 100644 --- a/src/multimedia/camera/qcamera.cpp +++ b/src/multimedia/camera/qcamera.cpp @@ -838,6 +838,10 @@ void QCamera::start() /*! Stops the camera. The camera state is changed from QCamera::ActiveState to QCamera::LoadedState. + + In this state, the camera still consumes power. + + \sa unload(), QCamera::UnloadedState */ void QCamera::stop() { @@ -1078,23 +1082,22 @@ void QCamera::unlock() /*! \enum QCamera::State + + This enum holds the current state of the camera. + \value UnloadedState - The initial camera state, with camera not loaded, - the camera capabilities except of supported capture modes + The initial camera state, with camera not loaded. + The camera capabilities, except supported capture modes, are unknown. - While the supported settings are unknown in this state, it's allowed to set the camera capture settings like codec, resolution, or frame rate. - \value LoadedState The camera is loaded and ready to be configured. - - In the Idle state it's allowed to query camera capabilities, + In this state it's allowed to query camera capabilities, set capture resolution, codecs, etc. - The viewfinder is not active in the loaded state. - + The camera consumes power in the loaded state. \value ActiveState In the active state as soon as camera is started the viewfinder displays video frames and the |