summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Brasser <michael.brasser@nokia.com>2009-10-28 06:06:09 (GMT)
committerMichael Brasser <michael.brasser@nokia.com>2009-10-28 06:06:09 (GMT)
commit753f8a4f263fd44ec22c7f6b0835df1466d01f82 (patch)
tree871565dc1164f215a1d6b447d207e54e52ab6dfa
parent1f8a4748e860d259d525e47426fd3a1072d9fb5c (diff)
downloadQt-753f8a4f263fd44ec22c7f6b0835df1466d01f82.zip
Qt-753f8a4f263fd44ec22c7f6b0835df1466d01f82.tar.gz
Qt-753f8a4f263fd44ec22c7f6b0835df1466d01f82.tar.bz2
Doc.
-rw-r--r--doc/src/declarative/elements.qdoc2
-rw-r--r--doc/src/declarative/extending.qdoc2
-rw-r--r--doc/src/declarative/qmlmodels.qdoc2
-rw-r--r--doc/src/declarative/qmlreference.qdoc9
-rw-r--r--doc/src/declarative/qmlstates.qdoc1
-rw-r--r--doc/src/declarative/qtbinding.qdoc1
-rw-r--r--doc/src/declarative/qtprogrammers.qdoc2
-rw-r--r--src/declarative/extra/qmlxmllistmodel.cpp5
-rw-r--r--src/declarative/fx/qfxitem.cpp27
-rw-r--r--src/declarative/qml/qmlcompiler.cpp4
-rw-r--r--src/declarative/qml/qmlcomponent.cpp16
-rw-r--r--src/declarative/util/qmllistmodel.cpp6
-rw-r--r--src/declarative/util/qmlstate.cpp2
-rw-r--r--src/declarative/util/qmltransition.cpp2
-rw-r--r--src/declarative/util/qmlview.cpp2
15 files changed, 64 insertions, 19 deletions
diff --git a/doc/src/declarative/elements.qdoc b/doc/src/declarative/elements.qdoc
index 4fa4ec5..3ea5989 100644
--- a/doc/src/declarative/elements.qdoc
+++ b/doc/src/declarative/elements.qdoc
@@ -85,7 +85,7 @@ The following table lists the QML elements provided by the Qt Declarative module
\o
\list
\o \l Binding
-\o \l ListModel
+\o \l ListModel, \l ListElement
\o \l VisualItemModel
\o \l XmlListModel and XmlRole
\o \l SqlQuery, \l SqlConnection, and \l SqlBind
diff --git a/doc/src/declarative/extending.qdoc b/doc/src/declarative/extending.qdoc
index b872632..7a4e51c 100644
--- a/doc/src/declarative/extending.qdoc
+++ b/doc/src/declarative/extending.qdoc
@@ -604,7 +604,7 @@ public:
\title Extending types from QML
Many of the elements available for use in QML are implemented in
-\l {QML for C++ Programmers}{C++}. These types are know as "core types". QML
+\l {Extending QML}{C++}. These types are know as "core types". QML
allows programmers to build new, fully functional elements without using C++.
Existing core types can be extended, and new types defined entirely in the QML
language.
diff --git a/doc/src/declarative/qmlmodels.qdoc b/doc/src/declarative/qmlmodels.qdoc
index 45df29b..a14345b 100644
--- a/doc/src/declarative/qmlmodels.qdoc
+++ b/doc/src/declarative/qmlmodels.qdoc
@@ -51,7 +51,7 @@ have items modified, inserted, removed or moved dynamically.
Data is provided to the delegate via named data roles which the
delegate may bind to. The roles are exposed as properties of the
-\model property, though this property is set as a default property
+\e model property, though this property is set as a default property
of the delegate so, unless there is a naming clash with a
property in the delegate, the roles are usually accessed unqualified.
diff --git a/doc/src/declarative/qmlreference.qdoc b/doc/src/declarative/qmlreference.qdoc
index 6a874b6..a56813c 100644
--- a/doc/src/declarative/qmlreference.qdoc
+++ b/doc/src/declarative/qmlreference.qdoc
@@ -60,9 +60,8 @@
\list
\o \l {Introduction to the QML language}
\o \l {tutorial}{Tutorial: 'Hello World'}
- \o \l {tutorials-declarative-contacts.html}{Tutorial: 'Introduction to QML'}
\o \l {advtutorial.html}{Advanced Tutorial: 'Same Game'}
- \o \l {qmlexamples}{Examples}
+ \o \l {QML Examples and Walkthroughs}
\endlist
\section1 Core QML Features:
@@ -82,7 +81,11 @@
QML Reference:
\list
- \o \l {QML Format Reference}
\o \l {elements}{QML Elements}
\endlist
+
+ \section1 Deprecated
+ \list
+ \o \l {tutorials-declarative-contacts.html}{Tutorial: 'Introduction to QML'}
+ \endlist
*/
diff --git a/doc/src/declarative/qmlstates.qdoc b/doc/src/declarative/qmlstates.qdoc
index 078b718..261e3f5 100644
--- a/doc/src/declarative/qmlstates.qdoc
+++ b/doc/src/declarative/qmlstates.qdoc
@@ -55,5 +55,6 @@ Other things you can do in a state change:
\o change an item's parent with ParentChange
\o change an item's anchors with AnchorChanges
\o run some script with StateChangeScript
+\endlist
*/
diff --git a/doc/src/declarative/qtbinding.qdoc b/doc/src/declarative/qtbinding.qdoc
index 18685ac..61520f7 100644
--- a/doc/src/declarative/qtbinding.qdoc
+++ b/doc/src/declarative/qtbinding.qdoc
@@ -211,7 +211,6 @@ Rectangle {
}
}
\endcode
-\endtable
To detect when a C++ property value - in this case the \c CustomPalette's \c text property -
changes, the property must have a corresponding NOTIFY signal. The NOTIFY signal specifies a signal
diff --git a/doc/src/declarative/qtprogrammers.qdoc b/doc/src/declarative/qtprogrammers.qdoc
index ea27d7e..4c28255 100644
--- a/doc/src/declarative/qtprogrammers.qdoc
+++ b/doc/src/declarative/qtprogrammers.qdoc
@@ -109,7 +109,7 @@ just as QTextEdit, QWebView, and QListView are built upon
those same UI-agnostic components.
The encapsulation of the look and feel that QWidgets gives is important, and for this
-the QML concept of \l components serves the same purpose. If you are building a complete
+the QML concept of \l {qmldocuments.html}{components} serves the same purpose. If you are building a complete
suite of applications which should have a consistent look and feel, you should build
a set of reusable components with the look and feel you desire.
diff --git a/src/declarative/extra/qmlxmllistmodel.cpp b/src/declarative/extra/qmlxmllistmodel.cpp
index df89f56..a3c96fd 100644
--- a/src/declarative/extra/qmlxmllistmodel.cpp
+++ b/src/declarative/extra/qmlxmllistmodel.cpp
@@ -406,6 +406,11 @@ void QmlXmlRoleList::insert(int i, QmlXmlListModelRole *role)
}
/*!
+ \class QmlXmlListModel
+ \internal
+*/
+
+/*!
\qmlclass XmlListModel
\brief The XmlListModel element allows you to specify a model using XPath expressions.
diff --git a/src/declarative/fx/qfxitem.cpp b/src/declarative/fx/qfxitem.cpp
index 7d60336..ed07696 100644
--- a/src/declarative/fx/qfxitem.cpp
+++ b/src/declarative/fx/qfxitem.cpp
@@ -79,6 +79,19 @@ QML_DEFINE_TYPE(Qt,4,6,(QT_VERSION&0x00ff00)>>8,Rotation,QGraphicsRotation)
#include "qfxeffects.cpp"
/*!
+ \qmlclass Transform
+ \brief The Transform elements provide a way of building advanced transformations on Items.
+
+ The Transform elements let you create and control advanced transformations that can be configured
+ independently using specialized properties.
+
+ You can assign any number of Transform elements to an Item. Each Transform is applied in order,
+ one at a time, to the Item it's assigned to.
+
+ \sa Rotation, Scale
+*/
+
+/*!
\qmlclass Scale
\brief The Scale object provides a way to scale an Item.
@@ -1295,7 +1308,7 @@ QFxKeysAttached *QFxKeysAttached::qmlAttachedProperties(QObject *obj)
This signal is emitted when the \a state of the item changes.
- \sa states-transitions
+ \sa {qmlstates}{States}
*/
/*!
@@ -2315,14 +2328,14 @@ QmlList<QObject *> *QFxItem::resources()
}
\endqml
- \sa {states-transitions}{States and Transitions}
+ \sa {qmlstate}{States}
*/
/*!
\property QFxItem::states
This property holds a list of states defined by the item.
- \sa {states-transitions}{States and Transitions}
+ \sa {qmlstate}{States}
*/
QmlList<QmlState *>* QFxItem::states()
{
@@ -2344,14 +2357,14 @@ QmlList<QmlState *>* QFxItem::states()
}
\endqml
- \sa {states-transitions}{States and Transitions}
+ \sa {state-transitions}{Transitions}
*/
/*!
\property QFxItem::transitions
This property holds a list of transitions defined by the item.
- \sa {states-transitions}{States and Transitions}
+ \sa {state-transitions}{Transitions}
*/
QmlList<QmlTransition *>* QFxItem::transitions()
{
@@ -2423,7 +2436,7 @@ QmlList<QmlTransition *>* QFxItem::transitions()
set), \c state will be a blank string. Likewise, you can return an
item to its base state by setting its current state to \c ''.
- \sa {states-transitions}{States and Transitions}
+ \sa {qmlstates}{States}
*/
/*!
@@ -2449,7 +2462,7 @@ QmlList<QmlTransition *>* QFxItem::transitions()
set), \c state will be a blank string. Likewise, you can return an
item to its base state by setting its current state to \c ''.
- \sa {states-transitions}{States and Transitions}
+ \sa {qmlstates}{States}
*/
QString QFxItem::state() const
{
diff --git a/src/declarative/qml/qmlcompiler.cpp b/src/declarative/qml/qmlcompiler.cpp
index ad74446..7a417bb 100644
--- a/src/declarative/qml/qmlcompiler.cpp
+++ b/src/declarative/qml/qmlcompiler.cpp
@@ -150,6 +150,8 @@ bool QmlCompiler::isSignalPropertyName(const QByteArray &name)
}
/*!
+ \macro COMPILE_EXCEPTION
+ \internal
Inserts an error into the QmlCompiler error list, and returns false
(failure).
@@ -175,6 +177,8 @@ bool QmlCompiler::isSignalPropertyName(const QByteArray &name)
}
/*!
+ \macro COMPILE_CHECK
+ \internal
Returns false if \a is false, otherwise does nothing.
*/
#define COMPILE_CHECK(a) \
diff --git a/src/declarative/qml/qmlcomponent.cpp b/src/declarative/qml/qmlcomponent.cpp
index 0894758..1e3a082 100644
--- a/src/declarative/qml/qmlcomponent.cpp
+++ b/src/declarative/qml/qmlcomponent.cpp
@@ -74,7 +74,7 @@ int statusId = qRegisterMetaType<QmlComponent::Status>("QmlComponent::Status");
\brief The Component element encapsulates a QML component description.
Components are reusable, encapsulated Qml element with a well-defined interface.
- They are often defined in \l {components}{Component Files}.
+ They are often defined in \l {qmldocuments.html}{Component Files}.
The \e Component element allows defining components within a QML file.
This can be useful for reusing a small component within a single QML
@@ -267,6 +267,10 @@ bool QmlComponent::isLoading() const
return status() == Loading;
}
+/*!
+ Returns he progress of loading the component, from 0.0 (nothing loaded)
+ to 1.0 (finished).
+*/
qreal QmlComponent::progress() const
{
Q_D(const QmlComponent);
@@ -274,6 +278,13 @@ qreal QmlComponent::progress() const
}
/*!
+ \fn void QmlComponent::progressChanged(qreal progress)
+
+ Emitted whenever the component's loading progress changes. \a progress will be the
+ current progress between 0.0 (nothing loaded) and 1.0 (finished).
+*/
+
+/*!
\fn void QmlComponent::statusChanged(QmlComponent::Status status)
Emitted whenever the component's status changes. \a status will be the
@@ -659,6 +670,9 @@ QmlComponentAttached::~QmlComponentAttached()
next = 0;
}
+/*!
+ \internal
+*/
QmlComponentAttached *QmlComponent::qmlAttachedProperties(QObject *obj)
{
QmlComponentAttached *a = new QmlComponentAttached(obj);
diff --git a/src/declarative/util/qmllistmodel.cpp b/src/declarative/util/qmllistmodel.cpp
index 7ccccec..9c9fa6a 100644
--- a/src/declarative/util/qmllistmodel.cpp
+++ b/src/declarative/util/qmllistmodel.cpp
@@ -809,6 +809,12 @@ void QmlListModelParser::setCustomData(QObject *obj, const QByteArray &d)
QML_DEFINE_CUSTOM_TYPE(Qt, 4,6, (QT_VERSION&0x00ff00)>>8, ListModel, QmlListModel, QmlListModelParser)
+/*!
+ \qmlclass ListElement
+ \brief The ListElement element defines a data item in a ListModel.
+
+ \sa ListModel
+*/
// ### FIXME
class QmlListElement : public QObject
{
diff --git a/src/declarative/util/qmlstate.cpp b/src/declarative/util/qmlstate.cpp
index 7e4e992..425480c 100644
--- a/src/declarative/util/qmlstate.cpp
+++ b/src/declarative/util/qmlstate.cpp
@@ -134,7 +134,7 @@ QmlStateOperation::QmlStateOperation(QObjectPrivate &dd, QObject *parent)
inadvisible. Not only would this have the same effect as going directly to the second state
it may cause the program to crash.
- \sa {states-transitions}{States and Transitions}
+ \sa {qmlstates}{States}, {state-transitions}{Transitions}
*/
/*!
diff --git a/src/declarative/util/qmltransition.cpp b/src/declarative/util/qmltransition.cpp
index 66275d9..97a3b74 100644
--- a/src/declarative/util/qmltransition.cpp
+++ b/src/declarative/util/qmltransition.cpp
@@ -54,7 +54,7 @@ QT_BEGIN_NAMESPACE
\qmlclass Transition QmlTransition
\brief The Transition element defines animated transitions that occur on state changes.
- \sa {states-transitions}{States and Transitions}
+ \sa {qmlstates}{States}, {state-transitions}{Transitions}
*/
/*!
diff --git a/src/declarative/util/qmlview.cpp b/src/declarative/util/qmlview.cpp
index f91d0db..329a9b2 100644
--- a/src/declarative/util/qmlview.cpp
+++ b/src/declarative/util/qmlview.cpp
@@ -386,7 +386,7 @@ void QmlView::continueExecute()
*/
/*! \fn void QmlView::initialSize(QSize size)
- This signal is emitted when the initial size of the root item is known.
+ This signal is emitted when the initial \a size of the root item is known.
*/
/*! \fn void QmlView::errors(const QList<QmlError> &errors)