From 4f3a7b5992b5aed67cced46d5d8c8c2f052dfb66 Mon Sep 17 00:00:00 2001 From: Peter Yard Date: Tue, 27 Apr 2010 10:35:48 +1000 Subject: Docs Changes to start page. Minor change to Elements doc. See also added to some elements docs. --- doc/src/declarative/declarativeui.qdoc | 17 +++++++++++++---- doc/src/declarative/elements.qdoc | 2 +- examples/declarative/animations/easing.qml | 4 ++-- src/declarative/qml/qdeclarativecomponent.cpp | 2 ++ src/declarative/util/qdeclarativeanimation.cpp | 2 ++ src/declarative/util/qdeclarativebehavior.cpp | 2 ++ src/declarative/util/qdeclarativebind.cpp | 2 ++ src/declarative/util/qdeclarativeconnections.cpp | 2 ++ src/declarative/util/qdeclarativelistmodel.cpp | 2 +- src/declarative/util/qdeclarativepackage.cpp | 1 + src/declarative/util/qdeclarativepropertychanges.cpp | 2 +- src/declarative/util/qdeclarativestate.cpp | 2 +- src/declarative/util/qdeclarativestategroup.cpp | 2 +- src/declarative/util/qdeclarativetimer.cpp | 2 ++ src/declarative/util/qdeclarativetransition.cpp | 2 +- src/declarative/util/qdeclarativexmllistmodel.cpp | 4 ++++ 16 files changed, 38 insertions(+), 12 deletions(-) diff --git a/doc/src/declarative/declarativeui.qdoc b/doc/src/declarative/declarativeui.qdoc index a2a5283..2d646b9 100644 --- a/doc/src/declarative/declarativeui.qdoc +++ b/doc/src/declarative/declarativeui.qdoc @@ -40,19 +40,28 @@ ****************************************************************************/ /*! -\title Declarative UI (QML) +\title Declarative UI Using QML \page declarativeui.html \brief The Qt Declarative module provides a declarative framework for building highly dynamic, custom user interfaces. +\section1 \l{QML Elements}{Fast QML Elements Reference Page} + +\raw HTML +
+\endraw + +\section1 Preamble + Qt Declarative UI provides a declarative framework for building highly dynamic, custom user interfaces. Declarative UI helps programmers and designers collaborate to build the animation rich, fluid user interfaces that are becoming common in portable consumer devices, such as mobile phones, media players, set-top boxes and netbooks. -The Qt Declarative module provides an engine for interpreting the declarative QML -language, and a rich set of \l {QML Elements}{QML elements} that can be used -from QML. + +The Qt Declarative module provides an engine for interpreting the declarative +QML language, and a rich set of \bold { \l {QML Elements}{QML elements} } +that can be used from QML. QML is an extension to \l {http://www.ecma-international.org/publications/standards/Ecma-262.htm} {JavaScript}, that provides a mechanism to declaratively build an object tree diff --git a/doc/src/declarative/elements.qdoc b/doc/src/declarative/elements.qdoc index ce3a6e3..8318392 100644 --- a/doc/src/declarative/elements.qdoc +++ b/doc/src/declarative/elements.qdoc @@ -44,7 +44,7 @@ \target elements \title QML Elements -The following table lists the QML elements provided by the Qt Declarative module. +The following table lists the QML elements provided by the \l {QtDeclarative}{Qt Declarative} module. \bold {Standard Qt Declarative Elements} diff --git a/examples/declarative/animations/easing.qml b/examples/declarative/animations/easing.qml index bed4b5f9..b0f9669 100644 --- a/examples/declarative/animations/easing.qml +++ b/examples/declarative/animations/easing.qml @@ -79,10 +79,10 @@ Rectangle { } transitions: Transition { - ParallelAnimation { + // ParallelAnimation { NumberAnimation { properties: "x"; easing.type: type; duration: 1000 } ColorAnimation { properties: "color"; easing.type: type; duration: 1000 } - } + // } } } } diff --git a/src/declarative/qml/qdeclarativecomponent.cpp b/src/declarative/qml/qdeclarativecomponent.cpp index 3e4651c..f41d867 100644 --- a/src/declarative/qml/qdeclarativecomponent.cpp +++ b/src/declarative/qml/qdeclarativecomponent.cpp @@ -140,6 +140,8 @@ Item { } } \endqml + + \sa QtDeclarative */ /*! diff --git a/src/declarative/util/qdeclarativeanimation.cpp b/src/declarative/util/qdeclarativeanimation.cpp index 7e20428..f38f66c 100644 --- a/src/declarative/util/qdeclarativeanimation.cpp +++ b/src/declarative/util/qdeclarativeanimation.cpp @@ -834,6 +834,8 @@ QAbstractAnimation *QDeclarativeScriptAction::qtAnimation() The PropertyAction is immediate - the target property is not animated to the selected value in any way. + + \sa QtDeclarative */ /*! \internal diff --git a/src/declarative/util/qdeclarativebehavior.cpp b/src/declarative/util/qdeclarativebehavior.cpp index a6c578e..1089d31 100644 --- a/src/declarative/util/qdeclarativebehavior.cpp +++ b/src/declarative/util/qdeclarativebehavior.cpp @@ -90,6 +90,8 @@ public: Currently only a single Behavior may be specified for a property; this Behavior can be enabled and disabled via the \l{enabled} property. + + \sa QtDeclarative */ diff --git a/src/declarative/util/qdeclarativebind.cpp b/src/declarative/util/qdeclarativebind.cpp index b7bd4e8..5516628 100644 --- a/src/declarative/util/qdeclarativebind.cpp +++ b/src/declarative/util/qdeclarativebind.cpp @@ -92,6 +92,8 @@ public: If the binding target or binding property is changed, the bound value is immediately pushed onto the new target. + + \sa QtDeclarative */ /*! \internal diff --git a/src/declarative/util/qdeclarativeconnections.cpp b/src/declarative/util/qdeclarativeconnections.cpp index 596b306..c392c74 100644 --- a/src/declarative/util/qdeclarativeconnections.cpp +++ b/src/declarative/util/qdeclarativeconnections.cpp @@ -116,6 +116,8 @@ public: onClicked: foo(...) } \endqml + + \sa QtDeclarative */ /*! diff --git a/src/declarative/util/qdeclarativelistmodel.cpp b/src/declarative/util/qdeclarativelistmodel.cpp index 2616ccf..0c2c2a4 100644 --- a/src/declarative/util/qdeclarativelistmodel.cpp +++ b/src/declarative/util/qdeclarativelistmodel.cpp @@ -244,7 +244,7 @@ QDeclarativeListModelParser::ListInstruction *QDeclarativeListModelParser::ListM In addition, the WorkerScript cannot add any list data to the model. - \sa {qmlmodels}{Data Models}, WorkerScript + \sa {qmlmodels}{Data Models}, WorkerScript, QtDeclarative */ diff --git a/src/declarative/util/qdeclarativepackage.cpp b/src/declarative/util/qdeclarativepackage.cpp index ac0788f..20e9907 100644 --- a/src/declarative/util/qdeclarativepackage.cpp +++ b/src/declarative/util/qdeclarativepackage.cpp @@ -70,6 +70,7 @@ QT_BEGIN_NAMESPACE \snippet examples/declarative/package/view.qml 0 + \sa QtDeclarative */ diff --git a/src/declarative/util/qdeclarativepropertychanges.cpp b/src/declarative/util/qdeclarativepropertychanges.cpp index 9c3ee9f..81b83c3 100644 --- a/src/declarative/util/qdeclarativepropertychanges.cpp +++ b/src/declarative/util/qdeclarativepropertychanges.cpp @@ -128,7 +128,7 @@ QT_BEGIN_NAMESPACE Changes to an Item's parent or anchors should be done using the associated change elements (ParentChange and AnchorChanges, respectively) rather than PropertyChanges. - \sa {qmlstate}{States} + \sa {qmlstate}{States}, QtDeclarative */ /*! diff --git a/src/declarative/util/qdeclarativestate.cpp b/src/declarative/util/qdeclarativestate.cpp index 78813fa..d27fc51 100644 --- a/src/declarative/util/qdeclarativestate.cpp +++ b/src/declarative/util/qdeclarativestate.cpp @@ -141,7 +141,7 @@ QDeclarativeStateOperation::QDeclarativeStateOperation(QObjectPrivate &dd, QObje \note setting the state of an object from within another state of the same object is not allowed. - \sa {qmlstates}{States}, {state-transitions}{Transitions} + \sa {qmlstates}{States}, {state-transitions}{Transitions}, QtDeclarative */ /*! diff --git a/src/declarative/util/qdeclarativestategroup.cpp b/src/declarative/util/qdeclarativestategroup.cpp index ff78c60..79bc677 100644 --- a/src/declarative/util/qdeclarativestategroup.cpp +++ b/src/declarative/util/qdeclarativestategroup.cpp @@ -109,7 +109,7 @@ public: } \endqml - \sa {qmlstate}{States} {state-transitions}{Transitions} + \sa {qmlstate}{States} {state-transitions}{Transitions}, {QtDeclarative} */ QDeclarativeStateGroup::QDeclarativeStateGroup(QObject *parent) diff --git a/src/declarative/util/qdeclarativetimer.cpp b/src/declarative/util/qdeclarativetimer.cpp index 76e6d5e..53a9d83 100644 --- a/src/declarative/util/qdeclarativetimer.cpp +++ b/src/declarative/util/qdeclarativetimer.cpp @@ -98,6 +98,8 @@ public: 1000ms has its \e repeat property changed 500ms after starting, the elapsed time will be reset to 0, and the Timer will be triggered 1000ms later. + + \sa {QtDeclarative} */ QDeclarativeTimer::QDeclarativeTimer(QObject *parent) diff --git a/src/declarative/util/qdeclarativetransition.cpp b/src/declarative/util/qdeclarativetransition.cpp index 815dc4c..f284156 100644 --- a/src/declarative/util/qdeclarativetransition.cpp +++ b/src/declarative/util/qdeclarativetransition.cpp @@ -56,7 +56,7 @@ QT_BEGIN_NAMESPACE \since 4.7 \brief The Transition element defines animated transitions that occur on state changes. - \sa {qmlstates}{States}, {state-transitions}{Transitions} + \sa {qmlstates}{States}, {state-transitions}{Transitions}, {QtDeclarative} */ /*! diff --git a/src/declarative/util/qdeclarativexmllistmodel.cpp b/src/declarative/util/qdeclarativexmllistmodel.cpp index 7f8b962..c9f7fee 100644 --- a/src/declarative/util/qdeclarativexmllistmodel.cpp +++ b/src/declarative/util/qdeclarativexmllistmodel.cpp @@ -74,6 +74,8 @@ typedef QPair QDeclarativeXmlListRange; \qmlclass XmlRole QDeclarativeXmlListModelRole \since 4.7 \brief The XmlRole element allows you to specify a role for an XmlListModel. + + \sa {QtDeclarative} */ /*! @@ -502,6 +504,8 @@ void QDeclarativeXmlListModelPrivate::clear_role(QDeclarativeListProperty