Various doc fixes.

Make QML docs fit in with the new Qt style. Fix numerous qdoc errors.

20 files changed, 121 insertions, 183 deletions

diff --git a/doc/src/declarative/effects.qdoc b/doc/src/declarative/effects.qdoc
deleted file mode 100644
index 7879260..0000000
--- a/doc/src/declarative/effects.qdoc
+++ /dev/null
@@ -1,29 +0,0 @@
-/*! 
-\page effects.html
-\target qmleffects
-\title Visual Effects
-
-\section1 Basic Effects
-
-\list
-\o Scaling (\l Item \bold scale property)
-\o Opacity (\l Item \bold opacity property)
-\o Rotation (\l Item \bold rotation property)
-\o Affine Transforms (\l Squish)
-\endlist
-
-\section1 Advanced Effects
-
-These effects are currently only supported by the OpenGL canvas
-backend. Support for other backends may be added if the performance
-can be made acceptable.
-
-\list
-\o \l Shadow
-\o \l Blur
-\o \l Reflection
-\o \l Highlight
-\o \l Particles
-\endlist
-
-*/
diff --git a/doc/src/declarative/elements.qdoc b/doc/src/declarative/elements.qdoc
index 3f74ff5..7c05ca1 100644
--- a/doc/src/declarative/elements.qdoc
+++ b/doc/src/declarative/elements.qdoc
@@ -102,7 +102,7 @@ The following table lists the Qml elements provided by the Qt Declarative module
 
 \header
 \o \bold {Views}
-\o \bold {Layouts}
+\o \bold {Positioners}
 \o \bold {Transforms}
 \o \bold {Effects}
 
@@ -128,9 +128,9 @@ The following table lists the Qml elements provided by the Qt Declarative module
 
 \o
 \list
-\o \l VerticalLayout
-\o \l HorizontalLayout
-\o \l GridLayout
+\o \l VerticalPositioner
+\o \l HorizontalPositioner
+\o \l GridPositioner
 \endlist
 
 \o
diff --git a/doc/src/declarative/qmlreference.qdoc b/doc/src/declarative/qmlreference.qdoc
index cbd086c..da955dc 100644
--- a/doc/src/declarative/qmlreference.qdoc
+++ b/doc/src/declarative/qmlreference.qdoc
@@ -29,7 +29,6 @@
     \o \l {binding}{Data Binding}
     \o \l {anchor-layout}{Layout Anchors}
     \o \l {qmlanimation}{Animation}
-    \o \l {qmleffects}{Visual Effects}
     \o \l {components}{Components}
     \o \l {qmlmodules}{Modules}
     \o \l {qmlfocus}{Keyboard Focus}
diff --git a/doc/src/declarative/qtdeclarative.qdoc b/doc/src/declarative/qtdeclarative.qdoc
index c5d32fe..ccfe4a6 100644
--- a/doc/src/declarative/qtdeclarative.qdoc
+++ b/doc/src/declarative/qtdeclarative.qdoc
@@ -73,7 +73,6 @@
     \o \l {binding}{Data Binding}
     \o \l {anchor-layout}{Layout Anchors}
     \o \l {qmlanimation}{Animation}
-    \o \l {qmleffects}{Visual Effects}
     \o \l {qmlmodules}{Modules}
     \o \l {qmlfocus}{Keyboard Focus}
     \o \l {Extending types from QML}
diff --git a/examples/declarative/extending/properties/birthdayparty.cpp b/examples/declarative/extending/properties/birthdayparty.cpp
new file mode 100644
index 0000000..92bc3ba
--- /dev/null
+++ b/examples/declarative/extending/properties/birthdayparty.cpp
@@ -0,0 +1,25 @@
+#include "birthdayparty.h"
+
+BirthdayParty::BirthdayParty(QObject *parent)
+: QObject(parent), m_celebrant(0)
+{
+}
+
+// ![0]
+Person *BirthdayParty::celebrant() const
+{
+    return m_celebrant;
+}
+
+void BirthdayParty::setCelebrant(Person *c)
+{
+    m_celebrant = c;
+}
+
+QmlList<Person *> *BirthdayParty::guests() 
+{
+    return &m_guests;
+}
+// ![0]
+
+QML_DEFINE_TYPE(People, 1, 0, 0, BirthdayParty, BirthdayParty);
diff --git a/examples/declarative/extending/properties/birthdayparty.h b/examples/declarative/extending/properties/birthdayparty.h
new file mode 100644
index 0000000..1804980
--- /dev/null
+++ b/examples/declarative/extending/properties/birthdayparty.h
@@ -0,0 +1,35 @@
+#ifndef BIRTHDAYPARTY_H
+#define BIRTHDAYPARTY_H
+
+#include <QObject>
+#include <qml.h>
+#include "person.h"
+
+// ![0]
+class BirthdayParty : public QObject
+{
+Q_OBJECT
+// ![0]
+// ![1]
+Q_PROPERTY(Person *celebrant READ celebrant WRITE setCelebrant)
+// ![1]
+// ![2]
+Q_PROPERTY(QmlList<Person *> *guests READ guests)
+// ![2]
+// ![3]
+public:
+    BirthdayParty(QObject *parent = 0);
+
+    Person *celebrant() const;
+    void setCelebrant(Person *);
+
+    QmlList<Person *> *guests();
+
+private:
+    Person *m_celebrant;
+    QmlConcreteList<Person *> m_guests;
+};
+QML_DECLARE_TYPE(BirthdayParty);
+// ![3]
+
+#endif // BIRTHDAYPARTY_H
diff --git a/src/declarative/3rdparty/qlistmodelinterface.cpp b/src/declarative/3rdparty/qlistmodelinterface.cpp
index 75960a1..4213ff2 100644
--- a/src/declarative/3rdparty/qlistmodelinterface.cpp
+++ b/src/declarative/3rdparty/qlistmodelinterface.cpp
@@ -44,6 +44,7 @@
 QT_BEGIN_NAMESPACE
 
 /*!
+  \internal
   \class QListModelInterface
   \brief The QListModelInterface class can be subclassed to provide C++ models to QFx Views
 
diff --git a/src/declarative/fx/qfxgridview.cpp b/src/declarative/fx/qfxgridview.cpp
index 6c5a712..28f2219 100644
--- a/src/declarative/fx/qfxgridview.cpp
+++ b/src/declarative/fx/qfxgridview.cpp
@@ -1028,18 +1028,12 @@ void QFxGridView::sizeChange()
     }
 }
 
-/*!
-  \reimp
-*/
 void QFxGridView::viewportMoved()
 {
     QFxFlickable::viewportMoved();
     refill();
 }
 
-/*!
-  \reimp
-*/
 qreal QFxGridView::minYExtent() const
 {
     Q_D(const QFxGridView);
@@ -1048,9 +1042,6 @@ qreal QFxGridView::minYExtent() const
     return -d->startPosition();
 }
 
-/*!
-  \reimp
-*/
 qreal QFxGridView::maxYExtent() const
 {
     Q_D(const QFxGridView);
@@ -1059,9 +1050,6 @@ qreal QFxGridView::maxYExtent() const
     return -(d->endPosition() - height());
 }
 
-/*!
-  \reimp
-*/
 qreal QFxGridView::minXExtent() const
 {
     Q_D(const QFxGridView);
@@ -1070,9 +1058,6 @@ qreal QFxGridView::minXExtent() const
     return -d->startPosition();
 }
 
-/*!
-  \reimp
-*/
 qreal QFxGridView::maxXExtent() const
 {
     Q_D(const QFxGridView);
@@ -1081,9 +1066,6 @@ qreal QFxGridView::maxXExtent() const
     return -(d->endPosition() - height());
 }
 
-/*!
-  \reimp
-*/
 void QFxGridView::keyPressEvent(QKeyEvent *event)
 {
     Q_D(QFxGridView);
@@ -1131,9 +1113,6 @@ void QFxGridView::keyPressEvent(QKeyEvent *event)
     QFxFlickable::keyPressEvent(event);
 }
 
-/*!
-  \reimp
-*/
 void QFxGridView::componentComplete()
 {
     Q_D(QFxGridView);
diff --git a/src/declarative/fx/qfxitem.cpp b/src/declarative/fx/qfxitem.cpp
index 572fcc7..1ab252c 100644
--- a/src/declarative/fx/qfxitem.cpp
+++ b/src/declarative/fx/qfxitem.cpp
@@ -893,18 +893,6 @@ QFxKeysAttached *QFxKeysAttached::qmlAttachedProperties(QObject *obj)
 */
 
 /*!
-    \fn void QFxItem::hcenterChanged()
-
-    This signal is emitted when the horizontal center coordinate of the item changes.
-*/
-
-/*!
-    \fn void QFxItem::vcenterChanged()
-
-    This signal is emitted when the vertical center coordinate of the item changes.
-*/
-
-/*!
     \fn void QFxItem::stateChanged(const QString &state)
 
     This signal is emitted when the \a state of the item changes.
@@ -1334,27 +1322,6 @@ void QFxItem::setClip(bool c)
  */
 
 /*!
-  \property QFxItem::x
-
-  The x coordinate of the item relative to its parent.
-*/
-
-/*!
-  \property QFxItem::y
-
-  The y coordinate of the item relative to its parent.
-*/
-
-/*!
-  \property QFxItem::z
-
-  The z coordinate of the item relative to its parent.
-
-  A negative z coordinate means the item will be painted below its parent.
-*/
-
-
-/*!
   \qmlproperty real Item::z
 
   Sets the stacking order of the item.  By default the stacking order is 0.
@@ -1977,12 +1944,7 @@ QmlList<QmlTransition *>* QFxItem::transitions()
     return d->states()->transitionsProperty();
 }
 
-/*!
-  \internal
-  \property QFxItem::filter
-*/
-
-/*!
+/*
   \qmlproperty list<Filter> Item::filter
   This property holds a list of graphical filters to be applied to the item.
 
@@ -2205,11 +2167,17 @@ QPointF QFxItemPrivate::computeTransformOrigin() const
     }
 }
 
+/*!
+    \reimp
+*/
 bool QFxItem::sceneEvent(QEvent *event)
 {
     return QGraphicsItem::sceneEvent(event);
 }
 
+/*!
+    \reimp
+*/
 QVariant QFxItem::itemChange(GraphicsItemChange change,
                                        const QVariant &value)
 {
@@ -2220,6 +2188,9 @@ QVariant QFxItem::itemChange(GraphicsItemChange change,
     return QGraphicsItem::itemChange(change, value);
 }
 
+/*!
+    \reimp
+*/
 QRectF QFxItem::boundingRect() const
 {
     Q_D(const QFxItem);
@@ -2441,10 +2412,16 @@ bool QFxItem::hasActiveFocus() const
     return QGraphicsItem::hasFocus();
 }
 
+/*!
+    \reimp
+*/
 void QFxItem::paint(QPainter *, const QStyleOptionGraphicsItem *, QWidget *)
 {
 }
 
+/*!
+    \reimp
+*/
 bool QFxItem::event(QEvent *ev)
 {
     return QGraphicsObject::event(ev);
diff --git a/src/declarative/fx/qfxlistview.cpp b/src/declarative/fx/qfxlistview.cpp
index 0232717..b6301f6 100644
--- a/src/declarative/fx/qfxlistview.cpp
+++ b/src/declarative/fx/qfxlistview.cpp
@@ -1260,9 +1260,6 @@ void QFxListView::viewportMoved()
     }
 }
 
-/*!
-    \reimp
-*/
 qreal QFxListView::minYExtent() const
 {
     Q_D(const QFxListView);
@@ -1275,9 +1272,6 @@ qreal QFxListView::minYExtent() const
     return extent;
 }
 
-/*!
-    \reimp
-*/
 qreal QFxListView::maxYExtent() const
 {
     Q_D(const QFxListView);
@@ -1294,9 +1288,6 @@ qreal QFxListView::maxYExtent() const
     return extent;
 }
 
-/*!
-    \reimp
-*/
 qreal QFxListView::minXExtent() const
 {
     Q_D(const QFxListView);
@@ -1309,9 +1300,6 @@ qreal QFxListView::minXExtent() const
     return extent;
 }
 
-/*!
-    \reimp
-*/
 qreal QFxListView::maxXExtent() const
 {
     Q_D(const QFxListView);
diff --git a/src/declarative/fx/qfxloader.cpp b/src/declarative/fx/qfxloader.cpp
index 6d06ee9..95ddae3 100644
--- a/src/declarative/fx/qfxloader.cpp
+++ b/src/declarative/fx/qfxloader.cpp
@@ -85,13 +85,6 @@ QFxLoader::~QFxLoader()
 }
 
 /*!
-    \internal
-    \fn void QFxItem::sourceChanged()
-    This signal is emitted whenever the item's dynamic QML
-    source url changes.
- */
-
-/*!
     \qmlproperty url Loader::source
     This property holds the dynamic URL of the QML for the item.
 
diff --git a/src/declarative/fx/qfxmouseregion.cpp b/src/declarative/fx/qfxmouseregion.cpp
index 514701d..dc0f6b8 100644
--- a/src/declarative/fx/qfxmouseregion.cpp
+++ b/src/declarative/fx/qfxmouseregion.cpp
@@ -138,7 +138,7 @@ void QFxDrag::setYmax(qreal m)
     example extended so as to give a different color when you right click.
     \snippet doc/src/snippets/declarative/mouseregion.qml 1
 
-    For basic key handling, see \l KeyActions.
+    For basic key handling, see \l Keys.
 
     MouseRegion is an invisible item: it is never painted.
 
diff --git a/src/declarative/fx/qfxtextinput.cpp b/src/declarative/fx/qfxtextinput.cpp
index 1407a78..a2e2a11 100644
--- a/src/declarative/fx/qfxtextinput.cpp
+++ b/src/declarative/fx/qfxtextinput.cpp
@@ -53,8 +53,8 @@ QML_DEFINE_NOCREATE_TYPE(QValidator);
 QML_DEFINE_TYPE(Qt,4,6,(QT_VERSION&0x00ff00)>>8,QIntValidator,QIntValidator);
 
 /*!
-    \qmlclass LineEdit
-    The LineEdit item allows you to add an editable line of text to a scene.
+    \qmlclass TextInput
+    The TextInput item allows you to add an editable line of text to a scene.
 */
 QFxTextInput::QFxTextInput(QFxItem* parent)
     : QFxPaintedItem(*(new QFxTextInputPrivate), parent)
@@ -78,9 +78,9 @@ QFxTextInput::~QFxTextInput()
 }
 
 /*!
-    \qmlproperty string LineEdit::text
+    \qmlproperty string TextInput::text
 
-    The text in the LineEdit.
+    The text in the TextInput.
 */
 
 QString QFxTextInput::text() const
@@ -99,9 +99,9 @@ void QFxTextInput::setText(const QString &s)
 }
 
 /*!
-    \qmlproperty font LineEdit::font
+    \qmlproperty font TextInput::font
 
-    Set the LineEdit's font attributes.  \c font.size sets the font's point size.
+    Set the TextInput's font attributes.  \c font.size sets the font's point size.
 */
 QFont QFxTextInput::font() const
 {
@@ -125,7 +125,7 @@ void QFxTextInput::setFont(const QFont &font)
 }
 
 /*!
-    \qmlproperty color LineEdit::color
+    \qmlproperty color TextInput::color
 
     The text color.
 */
@@ -143,7 +143,7 @@ void QFxTextInput::setColor(const QColor &c)
 
 
 /*!
-    \qmlproperty color LineEdit::highlightColor
+    \qmlproperty color TextInput::highlightColor
 
     The text highlight color, used behind selections.
 */
@@ -164,7 +164,7 @@ void QFxTextInput::setHighlightColor(const QColor &color)
 }
 
 /*!
-    \qmlproperty color LineEdit::highlightedTextColor
+    \qmlproperty color TextInput::highlightedTextColor
 
     The highlighted text color, used in selections.
 */
@@ -221,7 +221,7 @@ void QFxTextInput::setMaxLength(int ml)
 }
 
 /*!
-    \qmlproperty bool LineEdit::cursorVisible
+    \qmlproperty bool TextInput::cursorVisible
     If true the text edit shows a cursor.
 
     This property is set and unset when the line edit gets focus, but it can also
@@ -244,8 +244,8 @@ void QFxTextInput::setCursorVisible(bool on)
 }
 
 /*!
-    \qmlproperty int LineEdit::cursorPosition
-    The position of the cursor in the LineEdit.
+    \qmlproperty int TextInput::cursorPosition
+    The position of the cursor in the TextInput.
 */
 int QFxTextInput::cursorPosition() const
 {
@@ -259,7 +259,7 @@ void QFxTextInput::setCursorPosition(int cp)
 }
 
 /*!
-    \qmlproperty int LineEdit::selectionStart
+    \qmlproperty int TextInput::selectionStart
 
     The cursor position before the first character in the current selection.
     Setting this and selectionEnd allows you to specify a selection in the
@@ -287,7 +287,7 @@ void QFxTextInput::setSelectionStart(int s)
 }
 
 /*!
-    \qmlproperty int LineEdit::selectionEnd
+    \qmlproperty int TextInput::selectionEnd
 
     The cursor position after the last character in the current selection.
     Setting this and selectionStart allows you to specify a selection in the
@@ -368,12 +368,12 @@ void QFxTextInput::setEchoMode(uint echo)
 }
 
 /*!
-    \qmlproperty Component LineEdit::cursorDelegate
-    The delegate for the cursor in the LineEdit.
+    \qmlproperty Component TextInput::cursorDelegate
+    The delegate for the cursor in the TextInput.
 
-    If you set a cursorDelegate for a LineEdit, this delegate will be used for
+    If you set a cursorDelegate for a TextInput, this delegate will be used for
     drawing the cursor instead of the standard cursor. An instance of the
-    delegate will be created and managed by the LineEdit when a cursor is
+    delegate will be created and managed by the TextInput when a cursor is
     needed, and the x property of delegate instance will be set so as
     to be one pixel before the top left of the current character.
 
@@ -514,7 +514,7 @@ void QFxTextInput::drawContents(QPainter *p, const QRect &r)
 }
 
 /*!
-    \qmlproperty bool LineEdit::smooth
+    \qmlproperty bool TextInput::smooth
 
     Set this property if you want the text to be smoothly scaled or
     transformed.  Smooth filtering gives better visual quality, but is slower.  If
diff --git a/src/declarative/qml/qmlcontext.cpp b/src/declarative/qml/qmlcontext.cpp
index 365c0e8..61850c3 100644
--- a/src/declarative/qml/qmlcontext.cpp
+++ b/src/declarative/qml/qmlcontext.cpp
@@ -339,7 +339,7 @@ QmlContext *QmlContext::parentContext() const
 }
 
 /*!
-    Add a default \a object to this context.  The object will be added after
+    Add \a defaultObject to this context.  The object will be added after
     any existing default objects.
 */
 void QmlContext::addDefaultObject(QObject *defaultObject)
@@ -417,7 +417,7 @@ void QmlContext::setContextProperty(const QString &name, QObject *value)
     Resolves the URL \a src relative to the URL of the
     containing component.
 
-    \sa QmlEngine::componentUrl(), setBaseUrl()
+    \sa QmlEngine::baseUrl(), setBaseUrl()
 */
 QUrl QmlContext::resolvedUrl(const QUrl &src)
 {
@@ -441,13 +441,12 @@ QUrl QmlContext::resolvedUrl(const QUrl &src)
 }
 
 /*!
-    Explicitly sets the url both resolveUri() and resolveUrl() will
-    use for relative references to \a baseUrl.
+    Explicitly sets the url resolveUrl() will use for relative references to \a baseUrl.
 
     Calling this function will override the url of the containing
     component used by default.
 
-    \sa resolvedUrl(), resolvedUri()
+    \sa resolvedUrl()
 */
 void QmlContext::setBaseUrl(const QUrl &baseUrl)
 {
diff --git a/src/declarative/qml/qmlengine.cpp b/src/declarative/qml/qmlengine.cpp
index 558bd49..52fd0b7 100644
--- a/src/declarative/qml/qmlengine.cpp
+++ b/src/declarative/qml/qmlengine.cpp
@@ -532,15 +532,6 @@ void QmlDeclarativeData::destroyed(QObject *object)
     delete this;
 }
 
-/*! \internal */
-/*
-QScriptEngine *QmlEngine::scriptEngine()
-{
-    Q_D(QmlEngine);
-    return &d->scriptEngine;
-}
-*/
-
 /*!
     Creates a QScriptValue allowing you to use \a object in QML script.
     \a engine is the QmlEngine it is to be created in.
diff --git a/src/declarative/qml/qmlengine.h b/src/declarative/qml/qmlengine.h
index 6066059..8caa505 100644
--- a/src/declarative/qml/qmlengine.h
+++ b/src/declarative/qml/qmlengine.h
@@ -74,7 +74,6 @@ public:
 
     void clearComponentCache();
 
-
     void addImportPath(const QString& dir);
 
     void setNetworkAccessManager(QNetworkAccessManager *);
diff --git a/src/declarative/qml/qmlmetaproperty.cpp b/src/declarative/qml/qmlmetaproperty.cpp
index e69746e..99f9f0c 100644
--- a/src/declarative/qml/qmlmetaproperty.cpp
+++ b/src/declarative/qml/qmlmetaproperty.cpp
@@ -540,10 +540,10 @@ QmlAbstractBinding *QmlMetaProperty::binding() const
 }
 
 /*!
-    Set the binding associated with this property to \a binding.  Returns
+    Set the binding associated with this property to \a newBinding.  Returns
     the existing binding (if any), otherwise 0.
 
-    \a binding will be enabled, and the returned binding (if any) will be
+    \a newBinding will be enabled, and the returned binding (if any) will be
     disabled.
 */
 QmlAbstractBinding *
diff --git a/src/declarative/util/qfxview.cpp b/src/declarative/util/qfxview.cpp
index 2c02cee..3acbf56 100644
--- a/src/declarative/util/qfxview.cpp
+++ b/src/declarative/util/qfxview.cpp
@@ -310,8 +310,8 @@ void QFxView::continueExecute()
   This signal is emitted when the view is resized to \a size.
  */
 
-/*! \fn void QFxView::error(const QList<QmlError> &errors)
-  This signal is emitted when the qml loaded contains errors.
+/*! \fn void QFxView::errors(const QList<QmlError> &errors)
+  This signal is emitted when the qml loaded contains \a errors.
  */
 
 /*!
diff --git a/src/declarative/util/qfxview.h b/src/declarative/util/qfxview.h
index 03557a3..25e2997 100644
--- a/src/declarative/util/qfxview.h
+++ b/src/declarative/util/qfxview.h
@@ -62,7 +62,8 @@ class QmlError;
 class QFxViewPrivate;
 class Q_DECLARATIVE_EXPORT QFxView : public QGraphicsView
 {
-Q_OBJECT
+    Q_OBJECT
+    Q_PROPERTY(bool contentResizable READ contentResizable WRITE setContentResizable)
 public:
     explicit QFxView(QWidget *parent = 0);
 
diff --git a/tools/qdoc3/test/classic.css b/tools/qdoc3/test/classic.css
index f97bdbe..b02edec 100644
--- a/tools/qdoc3/test/classic.css
+++ b/tools/qdoc3/test/classic.css
@@ -251,45 +251,26 @@ span.string,span.char
 
 .qmlname {
     white-space: nowrap;
-    font-weight: bold;
-    font-size: 125%;
 }
 
 .qmltype {
-    font-weight: bold;
-    font-size: 125%;
-}
-
-.qmlproto, .qmldoc {
-   // border-top: 1px solid #84b0c7;
+   // font-weight: bold;
+    text-align: center;
+    font-size: 160%;
 }
 
 .qmlproto {
-    padding: 0;
-    //background-color: #e4e4e4;//#d5e1e8;
-    //font-weight: bold;
-    //-webkit-border-top-left-radius: 8px;
-    //-webkit-border-top-right-radius: 8px;
-    //-moz-border-radius-topleft: 8px;
-    //-moz-border-radius-topright: 8px;
+    background-color: #eee;
+    border-width: 1px;
+    border-style: solid;
+    border-color: #ddd;
+    font-weight: bold;
+    padding: 6px 0px 6px 10px;
+    margin: 42px 0px 0px 0px;
 }
 
 .qmldoc {
-    border-top: 1px solid #e4e4e4;
-    //padding: 2px 5px;
-    //background-color: #eef3f5;
-    //border-top-width: 0;
-    //-webkit-border-bottom-left-radius: 8px;
-    //-webkit-border-bottom-right-radius: 8px;
-    //-moz-border-radius-bottomleft: 8px;
-    //-moz-border-radius-bottomright: 8px;
-}
-
-.qmldoc p, .qmldoc dl, .qmldoc ul {
-    //margin: 6px 0;
 }
 
 *.qmlitem p {
-    //margin-top: 0px;
-    //margin-bottom: 0px;
 }