Doc: Fixed invalid/incomplete QML code snippets.

9 files changed, 71 insertions, 89 deletions

diff --git a/src/declarative/graphicsitems/qdeclarativeborderimage.cpp b/src/declarative/graphicsitems/qdeclarativeborderimage.cpp
index 16fb376..a851864 100644
--- a/src/declarative/graphicsitems/qdeclarativeborderimage.cpp
+++ b/src/declarative/graphicsitems/qdeclarativeborderimage.cpp
@@ -215,11 +215,13 @@ QDeclarativeBorderImage::~QDeclarativeBorderImage()
     image \c picture.png:
 
     \qml
-    border.left: 10
-    border.top: 10
-    border.bottom: 10
-    border.right: 10
-    source: picture.png
+    BorderImage {
+        border.left: 10
+        border.top: 10
+        border.bottom: 10
+        border.right: 10
+        source: "picture.png"
+    }
     \endqml
 
     The URL may be absolute, or relative to the URL of the component.
@@ -337,7 +339,10 @@ void QDeclarativeBorderImage::load()
     the bottom of the image:
 
     \qml
-    border.bottom: 10
+    BorderImage {
+        border.bottom: 10
+        // ...
+    }
     \endqml
 
     The border lines can also be specified using a
diff --git a/src/declarative/graphicsitems/qdeclarativepathview.cpp b/src/declarative/graphicsitems/qdeclarativepathview.cpp
index 64656af..ee73880 100644
--- a/src/declarative/graphicsitems/qdeclarativepathview.cpp
+++ b/src/declarative/graphicsitems/qdeclarativepathview.cpp
@@ -444,7 +444,7 @@ QDeclarativePathView::~QDeclarativePathView()
     Component {
         Rectangle {
             visible: PathView.onPath
-            ...
+            // ...
         }
     }
     \endqml
diff --git a/src/declarative/graphicsitems/qdeclarativetextedit.cpp b/src/declarative/graphicsitems/qdeclarativetextedit.cpp
index 675f8d9..d326ff7 100644
--- a/src/declarative/graphicsitems/qdeclarativetextedit.cpp
+++ b/src/declarative/graphicsitems/qdeclarativetextedit.cpp
@@ -350,11 +350,13 @@ void QDeclarativeTextEdit::setFont(const QFont &font)
     The text color.
 
     \qml
-// green text using hexadecimal notation
-TextEdit { color: "#00FF00"; ...  }
+    // green text using hexadecimal notation
+    TextEdit { color: "#00FF00" }
+    \endqml
 
-// steelblue text using SVG color name
-TextEdit { color: "steelblue"; ...  }
+    \qml
+    // steelblue text using SVG color name
+    TextEdit { color: "steelblue" }
     \endqml
 */
 QColor QDeclarativeTextEdit::color() const
diff --git a/src/declarative/qml/qdeclarativedom.cpp b/src/declarative/qml/qdeclarativedom.cpp
index 89aa79a..f1296aa 100644
--- a/src/declarative/qml/qdeclarativedom.cpp
+++ b/src/declarative/qml/qdeclarativedom.cpp
@@ -334,10 +334,10 @@ QList<QByteArray> QDeclarativeDomProperty::propertyNameParts() const
     Return true if this property is used as a default property in the QML
     document.
 
-    \qml
+    \code
 <Text text="hello"/>
 <Text>hello</Text>
-    \endqml
+    \endcode
 
     The above two examples return the same DOM tree, except that the second has
     the default property flag set on the text property.  Observe that whether
@@ -509,10 +509,10 @@ QByteArray QDeclarativeDomDynamicProperty::propertyTypeName() const
     Return true if this property is used as a default property in the QML
     document.
 
-    \qml
+    \code
 <Text text="hello"/>
 <Text>hello</Text>
-    \endqml
+    \endcode
 
     The above two examples return the same DOM tree, except that the second has
     the default property flag set on the text property.  Observe that whether
diff --git a/src/declarative/qml/qdeclarativeengine.cpp b/src/declarative/qml/qdeclarativeengine.cpp
index e0c6e1a..e602781 100644
--- a/src/declarative/qml/qdeclarativeengine.cpp
+++ b/src/declarative/qml/qdeclarativeengine.cpp
@@ -1872,14 +1872,24 @@ QScriptValue QDeclarativeEnginePrivate::quit(QScriptContext * /*ctxt*/, QScriptE
 }
 
 /*!
-\qmlmethod color Qt::tint(color baseColor, color tintColor)
+    \qmlmethod color Qt::tint(color baseColor, color tintColor)
     This function allows tinting one color with another.
 
-    The tint color should usually be mostly transparent, or you will not be able to see the underlying color. The below example provides a slight red tint by having the tint color be pure red which is only 1/16th opaque.
+    The tint color should usually be mostly transparent, or you will not be
+    able to see the underlying color. The below example provides a slight red
+    tint by having the tint color be pure red which is only 1/16th opaque.
 
     \qml
-    Rectangle { x: 0; width: 80; height: 80; color: "lightsteelblue" }
-    Rectangle { x: 100; width: 80; height: 80; color: Qt.tint("lightsteelblue", "#10FF0000") }
+    Item {
+        Rectangle {
+            x: 0; width: 80; height: 80
+            color: "lightsteelblue"
+        }
+        Rectangle {
+            x: 100; width: 80; height: 80
+            color: Qt.tint("lightsteelblue", "#10FF0000")
+        }
+    }
     \endqml
     \image declarative-rect_tint.png
 
diff --git a/src/declarative/qml/qdeclarativeworkerscript.cpp b/src/declarative/qml/qdeclarativeworkerscript.cpp
index ac13c68..6283f92 100644
--- a/src/declarative/qml/qdeclarativeworkerscript.cpp
+++ b/src/declarative/qml/qdeclarativeworkerscript.cpp
@@ -544,12 +544,7 @@ void QDeclarativeWorkerScriptEngine::run()
     The above worker script specifies a JavaScript file, "script.js", that handles
     the operations to be performed in the new thread. Here is \c script.js:
 
-    \qml
-    WorkerScript.onMessage = function(message) {
-        // ... long-running operations and calculations are done here
-        WorkerScript.sendMessage({ 'reply': 'Mouse is at ' + message.x + ',' + message.y })
-    }
-    \endqml
+    \quotefile doc/src/snippets/declarative/script.js
 
     When the user clicks anywhere within the rectangle, \c sendMessage() is
     called, triggering the \tt WorkerScript.onMessage() handler in
diff --git a/src/declarative/util/qdeclarativeanimation.cpp b/src/declarative/util/qdeclarativeanimation.cpp
index f22b9dd..e5905c4 100644
--- a/src/declarative/util/qdeclarativeanimation.cpp
+++ b/src/declarative/util/qdeclarativeanimation.cpp
@@ -672,7 +672,9 @@ QDeclarativeColorAnimation::~QDeclarativeColorAnimation()
 
     \qml
     Item {
-        states: [ ... ]
+        states: [
+            // ...
+        ]
 
         transition: Transition {
             NumberAnimation { from: "#c0c0c0"; duration: 2000 }
@@ -725,7 +727,7 @@ void QDeclarativeColorAnimation::setTo(const QColor &t)
 
 /*!
     \qmlclass ScriptAction QDeclarativeScriptAction
-  \ingroup qml-animation-transition
+    \ingroup qml-animation-transition
     \since 4.7
     \inherits Animation
     \brief The ScriptAction element allows scripts to be run during an animation.
@@ -734,31 +736,20 @@ void QDeclarativeColorAnimation::setTo(const QColor &t)
 
     \qml
     SequentialAnimation {
-        NumberAnimation { ... }
+        NumberAnimation {
+            // ...
+        }
         ScriptAction { script: doSomething(); }
-        NumberAnimation { ... }
+        NumberAnimation {
+            // ...
+        }
     }
     \endqml
 
     When used as part of a Transition, you can also target a specific
     StateChangeScript to run using the \c scriptName property.
 
-    \qml
-    State {
-        StateChangeScript {
-            name: "myScript"
-            script: doStateStuff();
-        }
-    }
-    ...
-    Transition {
-        SequentialAnimation {
-            NumberAnimation { ... }
-            ScriptAction { scriptName: "myScript" }
-            NumberAnimation { ... }
-        }
-    }
-    \endqml
+    \snippet doc/src/snippets/declarative/states/statechangescript.qml state and transition
 
     \sa StateChangeScript
 */
@@ -870,7 +861,7 @@ QAbstractAnimation *QDeclarativeScriptAction::qtAnimation()
 
 /*!
     \qmlclass PropertyAction QDeclarativePropertyAction
-  \ingroup qml-animation-transition
+    \ingroup qml-animation-transition
     \since 4.7
     \inherits Animation
     \brief The PropertyAction element allows immediate property changes during animation.
@@ -896,7 +887,7 @@ QAbstractAnimation *QDeclarativeScriptAction::qtAnimation()
     However, with this code, the \c transformOrigin is not set until \e after
     the animation, as a \l State is taken to define the values at the \e end of
     a transition. The animation would rotate at the default \c transformOrigin,
-    then jump to \c Item.BottomRight. To fix this, insert a PropertyChanges 
+    then jump to \c Item.BottomRight. To fix this, insert a PropertyAction
     before the RotationAnimation begins:
 
     \qml
@@ -910,7 +901,7 @@ QAbstractAnimation *QDeclarativeScriptAction::qtAnimation()
     
     This immediately sets the \c transformOrigin property to the value defined
     in the end state of the \l Transition (i.e. the value defined in the 
-    PropertyChanges object) so that the rotation animation begins with the
+    PropertyAction object) so that the rotation animation begins with the
     correct transform origin.
 
     \sa {QML Animation}, QtDeclarative
@@ -1421,7 +1412,9 @@ QDeclarativeRotationAnimation::~QDeclarativeRotationAnimation()
 
     \qml
     Item {
-        states: [ ... ]
+        states: [
+            // ...
+        ]
 
         transition: Transition {
             RotationAnimation { properties: "angle"; from: 100; duration: 2000 }
@@ -2253,7 +2246,7 @@ void QDeclarativePropertyAnimation::setProperties(const QString &prop)
            width: 100; height: 100
            color: Qt.rgba(0,0,1)
            //need to explicitly specify target and property
-           NumberAnimation { id: theAnim; target: theRect; property: "x" to: 500 }
+           NumberAnimation { id: theAnim; target: theRect; property: "x"; to: 500 }
            MouseArea {
                anchors.fill: parent
                onClicked: theAnim.start()
@@ -2555,7 +2548,7 @@ void QDeclarativeParentAnimation::setNewParent(QDeclarativeItem *newParent)
     ParentAnimation {
         target: myItem
         via: topLevelItem
-        ...
+        // ...
     }
     \endqml
 */
diff --git a/src/declarative/util/qdeclarativestate.cpp b/src/declarative/util/qdeclarativestate.cpp
index bb1a0b8..c41d39a 100644
--- a/src/declarative/util/qdeclarativestate.cpp
+++ b/src/declarative/util/qdeclarativestate.cpp
@@ -216,15 +216,18 @@ bool QDeclarativeState::isWhenKnown() const
 
     \snippet doc/src/snippets/declarative/state-when.qml 0
 
-    If multiple states in a group have \c when clauses that evaluate to \c true at the same time,
-    the first matching state will be applied. For example, in the following snippet
-    \c state1 will always be selected rather than \c state2 when sharedCondition becomes
-    \c true.
+    If multiple states in a group have \c when clauses that evaluate to \c true
+    at the same time, the first matching state will be applied. For example, in
+    the following snippet \c state1 will always be selected rather than
+    \c state2 when sharedCondition becomes \c true.
     \qml
-    states: [
-        State { name: "state1"; when: sharedCondition },
-        State { name: "state2"; when: sharedCondition }
-    ]
+    Item {
+        states: [
+            State { name: "state1"; when: sharedCondition },
+            State { name: "state2"; when: sharedCondition }
+        ]
+        // ...
+    }
     \endqml
 */
 QDeclarativeBinding *QDeclarativeState::when() const
diff --git a/src/declarative/util/qdeclarativetransition.cpp b/src/declarative/util/qdeclarativetransition.cpp
index e533a07..063ec3e 100644
--- a/src/declarative/util/qdeclarativetransition.cpp
+++ b/src/declarative/util/qdeclarativetransition.cpp
@@ -82,15 +82,7 @@ QT_BEGIN_NAMESPACE
 
     To define multiple transitions, specify \l Item::transitions as a list:
 
-    \qml
-    Item {
-        ...
-        transitions: [
-            Transition { to: "state1" ... },
-            Transition { ... }
-        ]
-    }
-    \endqml
+    \snippet doc/src/snippets/declarative/transitions-list.qml list of transitions
 
     If multiple Transitions are specified, only a single (best-matching) Transition will be applied for any particular
     state change. In the example above, when changing to \c state1, the first transition will be used, rather
@@ -222,13 +214,7 @@ void QDeclarativeTransition::prepare(QDeclarativeStateOperation::ActionList &act
 
     If the transition was changed to this:
 
-    \qml
-        transitions: Transition { 
-            to: "brighter"
-            ColorAnimation { duration: 1000 }
-        }
-    }
-    \endqml
+    \snippet doc/src/snippets/declarative/transition-from-to-modified.qml modified transition
 
     The animation would only be applied when changing from the default state to
     the "brighter" state (i.e. when the mouse is pressed, but not on release).
@@ -313,24 +299,12 @@ void QDeclarativeTransition::setToState(const QString &t)
 
     This property holds a list of the animations to be run for this transition.
 
-    \qml
-    Transition {
-        PropertyAnimation { ... }
-        NumberAnimation { ... }
-    }
-    \endqml
+    \snippet examples/declarative/toys/dynamicscene/dynamicscene.qml top-level transitions
 
     The top-level animations are run in parallel. To run them sequentially,
     define them within a SequentialAnimation:
 
-    \qml
-    Transition {
-        SequentialAnimation {
-            PropertyAnimation { ... }
-            NumberAnimation { ... }
-        }
-    }
-    \endqml
+    \snippet doc/src/snippets/declarative/transition-reversible.qml sequential animations
 */
 QDeclarativeListProperty<QDeclarativeAbstractAnimation> QDeclarativeTransition::animations()
 {