Add documentation for the 'when' property of Binding.

1 files changed, 14 insertions, 1 deletions

diff --git a/src/declarative/util/qdeclarativebind.cpp b/src/declarative/util/qdeclarativebind.cpp
index e95a03e..26baa38 100644
--- a/src/declarative/util/qdeclarativebind.cpp
+++ b/src/declarative/util/qdeclarativebind.cpp
@@ -72,7 +72,7 @@ public:
 
 /*!
     \qmlclass Binding QDeclarativeBind
-  \since 4.7
+    \since 4.7
     \brief The Binding element allows arbitrary property bindings to be created.
 
     Sometimes it is necessary to bind to a property of an object that wasn't
@@ -114,6 +114,19 @@ QDeclarativeBind::~QDeclarativeBind()
 {
 }
 
+/*!
+    \qmlproperty bool Binding::when
+
+    This property holds when the binding is active.
+    This should be set to an expression that evaluates to true when you want the binding to be active.
+
+    \code
+    Binding {
+        target: contactName; property: 'text'
+        value: name; when: list.ListView.isCurrentItem
+    }
+    \endcode
+*/
 bool QDeclarativeBind::when() const
 {
     Q_D(const QDeclarativeBind);