Doc: Snippet quoting and other documentation fixes.

6 files changed, 217 insertions, 82 deletions

diff --git a/doc/src/snippets/code/doc_src_qdbusadaptors.cpp b/doc/src/snippets/code/doc_src_qdbusadaptors.cpp
index abb31a1..749e64b 100644
--- a/doc/src/snippets/code/doc_src_qdbusadaptors.cpp
+++ b/doc/src/snippets/code/doc_src_qdbusadaptors.cpp
@@ -39,82 +39,82 @@
 ****************************************************************************/
 
 //! [0]
-        class MainApplicationAdaptor: public QDBusAbstractAdaptor
-        {
-            Q_OBJECT
-            Q_CLASSINFO("D-Bus Interface", "org.kde.DBus.MainApplication")
-            Q_PROPERTY(QString caption READ caption WRITE setCaption)
-            Q_PROPERTY(QString organizationName READ organizationName)
-            Q_PROPERTY(QString organizationDomain READ organizationDomain)
-
-        private:
-            QApplication *app;
-
-        public:
-            MainApplicationAdaptor(QApplication *application)
-                : QDBusAbstractAdaptor(application), app(application)
-            {
-                connect(application, SIGNAL(aboutToQuit()), SIGNAL(aboutToQuit()));
-                connect(application, SIGNAL(focusChanged(QWidget*, QWidget*)),
-                        SLOT(focusChangedSlot(QWidget*, QWidget*)));
-            }
-
-            QString caption()
-            {
-                if (app->hasMainWindow())
-                    return app->mainWindow()->caption();
-                return QString(""); // must not return a null QString
-            }
-
-            void setCaption(const QString &newCaption)
-            {
-                if (app->hasMainWindow())
-                    app->mainWindow()->setCaption(newCaption);
-            }
-
-            QString organizationName()
-            {
-                return app->organizationName();
-            }
-
-            QString organizationDomain()
-            {
-                return app->organizationDomain();
-            }
-
-        public slots:
-            Q_NOREPLY void quit()
-            { app->quit(); }
-
-            void reparseConfiguration()
-            { app->reparseConfiguration(); }
-
-            QString mainWindowObject()
-            {
-                if (app->hasMainWindow())
-                    return QString("/%1/mainwindow").arg(app->applicationName());
-                return QString();
-            }
-
-            void setSessionManagement(bool enable)
-            {
-                if (enable)
-                   app->enableSessionManagement();
-                else
-                   app->disableSessionManagement();
-            }
-
-        private slots:
-            void focusChangedSlot(QWidget *, QWidget *now)
-            {
-                if (now == app->mainWindow())
-                    emit mainWindowHasFocus();
-            }
-
-        signals:
-            void aboutToQuit();
-            void mainWindowHasFocus();
-        };
+class MainApplicationAdaptor: public QDBusAbstractAdaptor
+{
+    Q_OBJECT
+    Q_CLASSINFO("D-Bus Interface", "org.kde.DBus.MainApplication")
+    Q_PROPERTY(QString caption READ caption WRITE setCaption)
+    Q_PROPERTY(QString organizationName READ organizationName)
+    Q_PROPERTY(QString organizationDomain READ organizationDomain)
+
+private:
+    QApplication *app;
+
+public:
+    MainApplicationAdaptor(QApplication *application)
+        : QDBusAbstractAdaptor(application), app(application)
+    {
+        connect(application, SIGNAL(aboutToQuit()), SIGNAL(aboutToQuit()));
+        connect(application, SIGNAL(focusChanged(QWidget*, QWidget*)),
+                SLOT(focusChangedSlot(QWidget*, QWidget*)));
+    }
+
+    QString caption()
+    {
+        if (app->hasMainWindow())
+            return app->mainWindow()->caption();
+        return QString(""); // must not return a null QString
+    }
+
+    void setCaption(const QString &newCaption)
+    {
+        if (app->hasMainWindow())
+            app->mainWindow()->setCaption(newCaption);
+    }
+
+    QString organizationName()
+    {
+        return app->organizationName();
+    }
+
+    QString organizationDomain()
+    {
+        return app->organizationDomain();
+    }
+
+public slots:
+    Q_NOREPLY void quit()
+    { app->quit(); }
+
+    void reparseConfiguration()
+    { app->reparseConfiguration(); }
+
+    QString mainWindowObject()
+    {
+        if (app->hasMainWindow())
+            return QString("/%1/mainwindow").arg(app->applicationName());
+        return QString();
+    }
+
+    void setSessionManagement(bool enable)
+    {
+        if (enable)
+           app->enableSessionManagement();
+        else
+           app->disableSessionManagement();
+    }
+
+private slots:
+    void focusChangedSlot(QWidget *, QWidget *now)
+    {
+        if (now == app->mainWindow())
+            emit mainWindowHasFocus();
+    }
+
+signals:
+    void aboutToQuit();
+    void mainWindowHasFocus();
+};
 //! [0]
 
 
diff --git a/doc/src/snippets/declarative/models/views-models-delegates.qml b/doc/src/snippets/declarative/models/views-models-delegates.qml
new file mode 100644
index 0000000..2f76856
--- /dev/null
+++ b/doc/src/snippets/declarative/models/views-models-delegates.qml
@@ -0,0 +1,78 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:BSD$
+** You may use this file under the terms of the BSD license as follows:
+**
+** "Redistribution and use in source and binary forms, with or without
+** modification, are permitted provided that the following conditions are
+** met:
+**   * Redistributions of source code must retain the above copyright
+**     notice, this list of conditions and the following disclaimer.
+**   * Redistributions in binary form must reproduce the above copyright
+**     notice, this list of conditions and the following disclaimer in
+**     the documentation and/or other materials provided with the
+**     distribution.
+**   * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
+**     the names of its contributors may be used to endorse or promote
+**     products derived from this software without specific prior written
+**     permission.
+**
+** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+//! [rectangle]
+Rectangle {
+     width: 200; height: 200
+
+    ListModel {
+        id: fruitModel
+        property string language: "en"
+        ListElement {
+            name: "Apple"
+            cost: 2.45
+        }
+        ListElement {
+            name: "Orange"
+            cost: 3.25
+        }
+        ListElement {
+            name: "Banana"
+            cost: 1.95
+        }
+    }
+
+    Component {
+        id: fruitDelegate
+        Row {
+                Text { text: " Fruit: " + name; color: ListView.view.fruit_color }
+                Text { text: " Cost: $" + cost }
+                Text { text: " Language: " + ListView.view.model.language }
+        }
+    }
+
+    ListView {
+        property color fruit_color: "green"
+        model: fruitModel
+        delegate: fruitDelegate
+        anchors.fill: parent
+    }
+}
+//! [rectangle]
diff --git a/doc/src/snippets/declarative/models/visual-model-and-view.qml b/doc/src/snippets/declarative/models/visual-model-and-view.qml
new file mode 100644
index 0000000..4d42b65
--- /dev/null
+++ b/doc/src/snippets/declarative/models/visual-model-and-view.qml
@@ -0,0 +1,57 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:BSD$
+** You may use this file under the terms of the BSD license as follows:
+**
+** "Redistribution and use in source and binary forms, with or without
+** modification, are permitted provided that the following conditions are
+** met:
+**   * Redistributions of source code must retain the above copyright
+**     notice, this list of conditions and the following disclaimer.
+**   * Redistributions in binary form must reproduce the above copyright
+**     notice, this list of conditions and the following disclaimer in
+**     the documentation and/or other materials provided with the
+**     distribution.
+**   * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
+**     the names of its contributors may be used to endorse or promote
+**     products derived from this software without specific prior written
+**     permission.
+**
+** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+Rectangle {
+    width: 200; height: 200
+
+    //! [visual model and view]
+    VisualItemModel {
+        id: itemModel
+        Rectangle { height: 30; width: 80; color: "red" }
+        Rectangle { height: 30; width: 80; color: "green" }
+        Rectangle { height: 30; width: 80; color: "blue" }
+    }
+
+    ListView {
+        anchors.fill: parent
+        model: itemModel
+    }
+    //! [visual model and view]
+}
diff --git a/doc/src/snippets/qtscript/evaluation/main.cpp b/doc/src/snippets/qtscript/evaluation/main.cpp
index e7efd8e..01e06b6 100644
--- a/doc/src/snippets/qtscript/evaluation/main.cpp
+++ b/doc/src/snippets/qtscript/evaluation/main.cpp
@@ -42,9 +42,9 @@
 
 int main(int argc, char *argv[])
 {
-//! [0]
+    //! [0]
     QScriptEngine engine;
     qDebug() << "the magic number is:" << engine.evaluate("1 + 2").toNumber();
-//! [0]
+    //! [0]
     return 0;
 }
diff --git a/doc/src/snippets/qtscript/registeringobjects/main.cpp b/doc/src/snippets/qtscript/registeringobjects/main.cpp
index 1911442..9dab25a 100644
--- a/doc/src/snippets/qtscript/registeringobjects/main.cpp
+++ b/doc/src/snippets/qtscript/registeringobjects/main.cpp
@@ -44,12 +44,12 @@
 
 int main(int argc, char *argv[])
 {
-//! [0]
+    //! [0]
     QScriptEngine engine;
     QObject *someObject = new MyObject;
     QScriptValue objectValue = engine.newQObject(someObject);
     engine.globalObject().setProperty("myObject", objectValue);
-//! [0]
+    //! [0]
     qDebug() << "myObject's calculate() function returns"
              << engine.evaluate("myObject.calculate(10)").toNumber();
     return 0;
diff --git a/doc/src/snippets/qtscript/registeringvalues/main.cpp b/doc/src/snippets/qtscript/registeringvalues/main.cpp
index 3defc1f..6dc5b7c 100644
--- a/doc/src/snippets/qtscript/registeringvalues/main.cpp
+++ b/doc/src/snippets/qtscript/registeringvalues/main.cpp
@@ -43,10 +43,10 @@
 int main(int argc, char *argv[])
 {
     QScriptEngine engine;
-//! [0]
+    //! [0]
     engine.globalObject().setProperty("foo", 123);
     qDebug() << "foo times two is:" << engine.evaluate("foo * 2").toNumber();
-//! [0]
+    //! [0]
     return 0;
 }