summaryrefslogtreecommitdiffstats
path: root/src/imports/multimedia/qdeclarativetorch.cpp
diff options
context:
space:
mode:
authorVenugopal Shivashankar <venugopal.shivashankar@nokia.com>2012-08-02 11:17:05 +0200
committerQt by Nokia <qt-info@nokia.com>2012-08-29 13:17:52 +0200
commita4c23ac607034d1d8ab15bf9afb6a7d9a7b5d083 (patch)
tree262237db4ed7483e87b6b6e03d5782ef5a7f26d5 /src/imports/multimedia/qdeclarativetorch.cpp
parent8a3706a5a1a9d5839327ede3fa625da8f3c34979 (diff)
Doc: Added an index page and separated \qmlproperty and \property documentation
Change-Id: I29bcfd0a31c781deb4cce2d6bcb2afca32191ae6 Reviewed-by: Geir Vattekar <geir.vattekar@nokia.com> Reviewed-by: Martin Smith <martin.smith@nokia.com>
Diffstat (limited to 'src/imports/multimedia/qdeclarativetorch.cpp')
-rw-r--r--src/imports/multimedia/qdeclarativetorch.cpp18
1 files changed, 10 insertions, 8 deletions
diff --git a/src/imports/multimedia/qdeclarativetorch.cpp b/src/imports/multimedia/qdeclarativetorch.cpp
index b884a2f33..01623bd31 100644
--- a/src/imports/multimedia/qdeclarativetorch.cpp
+++ b/src/imports/multimedia/qdeclarativetorch.cpp
@@ -93,16 +93,17 @@ QDeclarativeTorch::~QDeclarativeTorch()
/*!
\qmlproperty bool QtMultimedia5::Torch::enabled
- \property QDeclarativeTorch::enabled
- Whether the torch is on. If the torch functionality is shared
+ This property indicates whether the torch is enabled. If the torch functionality is shared
with the camera flash hardware, the camera will take priority
- over torch settings and the torch may be disabled.
+ over torch settings and the torch is disabled.
*/
/*!
- Returns whether the torch is on. If the torch functionality
+ \property QDeclarativeTorch::enabled
+
+ This property indicates whether the torch is enabled. If the torch functionality
is shared with the camera flash hardware, the camera will take
- priority and the torch may be disabled.
+ priority and the torch is disabled.
*/
bool QDeclarativeTorch::enabled() const
{
@@ -140,15 +141,16 @@ void QDeclarativeTorch::setEnabled(bool on)
/*!
\qmlproperty int QtMultimedia5::Torch::power
- \property QDeclarativeTorch::power
- The current torch power setting, as a percentage of full power.
+ This property holds the current torch power setting, as a percentage of full power.
In some cases this setting may change automatically as a result
of temperature or battery conditions.
*/
/*!
- Returns the current torch power settings, as a percentage of full power.
+ \property QDeclarativeTorch::power
+
+ This property holds the current torch power settings, as a percentage of full power.
*/
int QDeclarativeTorch::power() const
{