summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Boddie <david.boddie@nokia.com>2011-02-17 20:38:27 (GMT)
committerDavid Boddie <david.boddie@nokia.com>2011-02-17 20:38:27 (GMT)
commite1b85d70420001f2be698d08e62b7e784a13a134 (patch)
treeca21ef6afc045e409d1c33043e4a78415df8e820
parentc164a5be25cb8bd70235571169b66af2fc6a8cbd (diff)
downloadQt-e1b85d70420001f2be698d08e62b7e784a13a134.zip
Qt-e1b85d70420001f2be698d08e62b7e784a13a134.tar.gz
Qt-e1b85d70420001f2be698d08e62b7e784a13a134.tar.bz2
Doc: Fixed links and whitespace.
-rw-r--r--doc/src/howtos/qmlbestpractices/qmlbestpractices-coding.qdoc4
-rw-r--r--doc/src/snippets/declarative/animation.qml5
-rw-r--r--doc/src/snippets/declarative/events.qml14
-rw-r--r--doc/src/snippets/declarative/mousearea/mousearea-snippet.qml10
-rw-r--r--src/declarative/graphicsitems/qdeclarativeitem.cpp2
-rw-r--r--src/declarative/qml/qdeclarativecomponent.cpp2
-rw-r--r--src/declarative/qml/qdeclarativetypeloader.cpp17
-rw-r--r--src/declarative/util/qdeclarativeanimation.cpp2
-rw-r--r--src/declarative/util/qdeclarativepropertychanges.cpp13
-rw-r--r--src/declarative/util/qdeclarativestate.cpp4
-rw-r--r--src/declarative/util/qdeclarativestategroup.cpp6
-rw-r--r--src/declarative/util/qdeclarativeview.cpp2
12 files changed, 47 insertions, 34 deletions
diff --git a/doc/src/howtos/qmlbestpractices/qmlbestpractices-coding.qdoc b/doc/src/howtos/qmlbestpractices/qmlbestpractices-coding.qdoc
index e33ee13..ac3669d 100644
--- a/doc/src/howtos/qmlbestpractices/qmlbestpractices-coding.qdoc
+++ b/doc/src/howtos/qmlbestpractices/qmlbestpractices-coding.qdoc
@@ -90,8 +90,8 @@ Similar to JavaScript or C++, there are two ways of commenting QML code:
\section1 Group Properties
-Many QML properties are \l{attached-properties}{attached} or
-\l {qml-grouped-properties}{group} properties. For convenience, you may treat
+Many QML properties are \l{attached-properties}{attached} or
+\l {qml-grouped-properties}{group} properties. For convenience, you may treat
them as another element when dealing with multiple properties belonging to the
same group.
diff --git a/doc/src/snippets/declarative/animation.qml b/doc/src/snippets/declarative/animation.qml
index 739d009..ae6142d 100644
--- a/doc/src/snippets/declarative/animation.qml
+++ b/doc/src/snippets/declarative/animation.qml
@@ -179,7 +179,7 @@ Rectangle {
}
//! [behavior animation]
-//! [sequential animation]
+//! [sequential animation]
Rectangle {
id: banner
width: 150; height: 100; border.color: "black"
@@ -216,7 +216,7 @@ Rectangle {
NumberAnimation { target: deploy; property: "opacity"; to: 1.0; duration: 200}
}
}
-//! [sequential animation]
+//! [sequential animation]
}//end of col
//! [parent end]
@@ -224,4 +224,3 @@ Rectangle {
//! [parent end]
//! [document]
-
diff --git a/doc/src/snippets/declarative/events.qml b/doc/src/snippets/declarative/events.qml
index 52fc2bc..3dc44f2 100644
--- a/doc/src/snippets/declarative/events.qml
+++ b/doc/src/snippets/declarative/events.qml
@@ -63,7 +63,7 @@ onSend: {
onPerform: console.log("perform signal emitted")
//! [signal handler declaration]
-//! [automatic signals]
+//! [automatic signals]
Rectangle {
id: sprite
width: 25; height: 25
@@ -72,7 +72,7 @@ Rectangle {
onXChanged: console.log("x property changed, emitted xChanged signal")
onYChanged: console.log("y property changed, emitted yChanged signal")
}
-//! [automatic signals]
+//! [automatic signals]
//! [signal emit]
Rectangle {
@@ -88,7 +88,7 @@ Rectangle {
}
//! [signal emit]
-//! [connect method]
+//! [connect method]
Rectangle {
id: relay
@@ -112,9 +112,9 @@ Rectangle {
console.log("Sending to email: " + person + ", " + notice)
}
}
-//! [connect method]
+//! [connect method]
-//! [forward signal]
+//! [forward signal]
Rectangle {
id: forwarder
width: 100; height: 100
@@ -131,9 +131,9 @@ Rectangle {
mousearea.clicked.connect(send)
}
}
-//! [forward signal]
+//! [forward signal]
-//! [connect method]
+//! [connect method]
//![parent end]
}
//![parent end]
diff --git a/doc/src/snippets/declarative/mousearea/mousearea-snippet.qml b/doc/src/snippets/declarative/mousearea/mousearea-snippet.qml
index 99cdc8b..03473ba 100644
--- a/doc/src/snippets/declarative/mousearea/mousearea-snippet.qml
+++ b/doc/src/snippets/declarative/mousearea/mousearea-snippet.qml
@@ -47,7 +47,7 @@ Rectangle {
width: 500; height: 500
color: "green"
-Column {
+Column {
//! [anchor fill]
Rectangle {
id: button
@@ -68,21 +68,21 @@ Rectangle {
id: button
width: 100; height: 100
-//! [enable handlers]
+//! [enable handlers]
MouseArea {
hoverEnabled: true
acceptedButtons: Qt.LeftButton | Qt.RightButton
onEntered: console.log("mouse entered the area")
onExited: console.log("mouse left the area")
}
-//! [enable handlers]
+//! [enable handlers]
}
Rectangle {
id: button
width: 100; height: 100
-//! [mouse handlers]
+//! [mouse handlers]
MouseArea {
anchors.fill: parent
onClicked: console.log("area clicked")
@@ -90,7 +90,7 @@ Rectangle {
onEntered: console.log("mouse entered the area")
onExited: console.log("mouse left the area")
}
-//! [mouse handlers]
+//! [mouse handlers]
}
} //end of column
diff --git a/src/declarative/graphicsitems/qdeclarativeitem.cpp b/src/declarative/graphicsitems/qdeclarativeitem.cpp
index ffef61b..35de629 100644
--- a/src/declarative/graphicsitems/qdeclarativeitem.cpp
+++ b/src/declarative/graphicsitems/qdeclarativeitem.cpp
@@ -2561,7 +2561,7 @@ QDeclarativeListProperty<QDeclarativeState> QDeclarativeItemPrivate::states()
}
\endqml
- \sa {qdeclarativeanimation.html#transitions}{QML Transitions}
+ \sa {QML Animation and Transitions}{Transitions}
*/
diff --git a/src/declarative/qml/qdeclarativecomponent.cpp b/src/declarative/qml/qdeclarativecomponent.cpp
index 5840f70..2568240 100644
--- a/src/declarative/qml/qdeclarativecomponent.cpp
+++ b/src/declarative/qml/qdeclarativecomponent.cpp
@@ -137,7 +137,7 @@ class QByteArray;
}
\endcode
- \sa {Using QML in C++ Applications}, {Integrating QML with existing Qt UI code}
+ \sa {Using QML Bindings in C++ Applications}, {Integrating QML Code with Existing Qt UI Code}
*/
/*!
diff --git a/src/declarative/qml/qdeclarativetypeloader.cpp b/src/declarative/qml/qdeclarativetypeloader.cpp
index 36cdde9..26f3996 100644
--- a/src/declarative/qml/qdeclarativetypeloader.cpp
+++ b/src/declarative/qml/qdeclarativetypeloader.cpp
@@ -629,7 +629,18 @@ QDeclarativeTypeLoader::~QDeclarativeTypeLoader()
}
/*!
-Return a QDeclarativeTypeData for \a url. The QDeclarativeTypeData may be cached.
+\enum QDeclarativeTypeLoader::Option
+
+This enum defines the options that control the way type data is handled.
+
+\value None The default value, indicating that no other options
+ are enabled.
+\value PreserveParser The parser used to handle the type data is preserved
+ after the data has been parsed.
+*/
+
+/*!
+Returns a QDeclarativeTypeData for the specified \a url. The QDeclarativeTypeData may be cached.
*/
QDeclarativeTypeData *QDeclarativeTypeLoader::get(const QUrl &url)
{
@@ -650,8 +661,10 @@ QDeclarativeTypeData *QDeclarativeTypeLoader::get(const QUrl &url)
}
/*!
-Return a QDeclarativeTypeData for \a data with the provided base \a url. The
+Returns a QDeclarativeTypeData for the given \a data with the provided base \a url. The
QDeclarativeTypeData will not be cached.
+
+The specified \a options control how the loader handles type data.
*/
QDeclarativeTypeData *QDeclarativeTypeLoader::get(const QByteArray &data, const QUrl &url, Options options)
{
diff --git a/src/declarative/util/qdeclarativeanimation.cpp b/src/declarative/util/qdeclarativeanimation.cpp
index a9a639b..e383d1e 100644
--- a/src/declarative/util/qdeclarativeanimation.cpp
+++ b/src/declarative/util/qdeclarativeanimation.cpp
@@ -74,7 +74,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass Animation QDeclarativeAbstractAnimation
- \ingroup qml-animation-transition
+ \ingroup qml-animation-transition
\since 4.7
\brief The Animation element is the base of all QML animations.
diff --git a/src/declarative/util/qdeclarativepropertychanges.cpp b/src/declarative/util/qdeclarativepropertychanges.cpp
index ccd122e..abbe4e2 100644
--- a/src/declarative/util/qdeclarativepropertychanges.cpp
+++ b/src/declarative/util/qdeclarativepropertychanges.cpp
@@ -118,12 +118,13 @@ QT_BEGIN_NAMESPACE
\section2 Immediate property changes in transitions
- When \l Transitions are used to animate state changes, they animate
- properties from their values in the current state to those defined in the
- new state (as defined by PropertyChanges objects). However,
- it is sometimes desirable to set a property value \e immediately during a
- \l Transition, without animation; in these cases, the PropertyAction
- element can be used to force an immediate property change.
+ When \l{QML Animation and Transitions}{Transitions} are used to animate
+ state changes, they animate properties from their values in the current
+ state to those defined in the new state (as defined by PropertyChanges
+ objects). However, it is sometimes desirable to set a property value
+ \e immediately during a \l Transition, without animation; in these cases,
+ the PropertyAction element can be used to force an immediate property
+ change.
See the PropertyAction documentation for more details.
diff --git a/src/declarative/util/qdeclarativestate.cpp b/src/declarative/util/qdeclarativestate.cpp
index 5a4e2b1..5718e29 100644
--- a/src/declarative/util/qdeclarativestate.cpp
+++ b/src/declarative/util/qdeclarativestate.cpp
@@ -152,14 +152,14 @@ QDeclarativeStateOperation::QDeclarativeStateOperation(QObjectPrivate &dd, QObje
Notice the default state is referred to using an empty string ("").
- States are commonly used together with \l {Transitions} to provide
+ States are commonly used together with \l{QML Animation and Transitions}{Transitions} to provide
animations when state changes occur.
\note Setting the state of an object from within another state of the same object is
not allowed.
\sa {declarative/animation/states}{states example}, {qmlstates}{States},
- {qdeclarativeanimation.html#transitions}{QML Transitions}, QtDeclarative
+ {QML Animation and Transitions}{Transitions}, QtDeclarative
*/
QDeclarativeState::QDeclarativeState(QObject *parent)
: QObject(*(new QDeclarativeStatePrivate), parent)
diff --git a/src/declarative/util/qdeclarativestategroup.cpp b/src/declarative/util/qdeclarativestategroup.cpp
index f1d0997..6459bf9 100644
--- a/src/declarative/util/qdeclarativestategroup.cpp
+++ b/src/declarative/util/qdeclarativestategroup.cpp
@@ -88,7 +88,7 @@ public:
/*!
\qmlclass StateGroup QDeclarativeStateGroup
- \ingroup qml-state-elements
+ \ingroup qml-state-elements
\since 4.7
\brief The StateGroup element provides state support for non-Item elements.
@@ -113,7 +113,7 @@ public:
}
\endqml
- \sa {qmlstate}{States} {Transitions}, {QtDeclarative}
+ \sa {qmlstate}{States} {QML Animation and Transitions}{Transitions}, {QtDeclarative}
*/
QDeclarativeStateGroup::QDeclarativeStateGroup(QObject *parent)
@@ -213,7 +213,7 @@ void QDeclarativeStateGroupPrivate::clear_states(QDeclarativeListProperty<QDecla
}
\endqml
- \sa {Transitions}
+ \sa {QML Animation and Transitions}{Transitions}
*/
QDeclarativeListProperty<QDeclarativeTransition> QDeclarativeStateGroup::transitionsProperty()
{
diff --git a/src/declarative/util/qdeclarativeview.cpp b/src/declarative/util/qdeclarativeview.cpp
index bfa2454..de61169 100644
--- a/src/declarative/util/qdeclarativeview.cpp
+++ b/src/declarative/util/qdeclarativeview.cpp
@@ -236,7 +236,7 @@ void QDeclarativeViewPrivate::itemGeometryChanged(QDeclarativeItem *resizeItem,
If you're using your own QGraphicsScene-based scene with QDeclarativeView, remember to
enable scene's sticky focus mode and to set itemIndexMethod to QGraphicsScene::NoIndex.
- \sa {Integrating QML with existing Qt UI code}, {Using QML in C++ Applications}
+ \sa {Integrating QML Code with Existing Qt UI Code}, {Using QML Bindings in C++ Applications}
*/