summaryrefslogtreecommitdiffstats
path: root/src/declarative/util
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@nokia.com>2012-07-27 18:30:10 +0200
committerQt by Nokia <qt-info@nokia.com>2012-07-30 10:54:06 +0200
commita90f11dbfcf0bfa6bd1a110c7878d01596646a23 (patch)
treedcfecc43a397d382332b2e2ebada01bbf6537e4c /src/declarative/util
parent3b64f4d9a4c48f4e9cf19a446c551790f2658278 (diff)
Doc: Changed \qmlclass to \qmltype and added \instantiates
-\qmlclass is now \qmltype -\instantiates is for QML types implemented in C++ Change-Id: I017822524de1879d272d777ec7681f4233128b01 Reviewed-by: Alan Alpert <alan.alpert@nokia.com>
Diffstat (limited to 'src/declarative/util')
-rw-r--r--src/declarative/util/qdeclarativeanimation.cpp39
-rw-r--r--src/declarative/util/qdeclarativebehavior.cpp3
-rw-r--r--src/declarative/util/qdeclarativebind.cpp3
-rw-r--r--src/declarative/util/qdeclarativeconnections.cpp3
-rw-r--r--src/declarative/util/qdeclarativefontloader.cpp3
-rw-r--r--src/declarative/util/qdeclarativelistmodel.cpp6
-rw-r--r--src/declarative/util/qdeclarativepackage.cpp3
-rw-r--r--src/declarative/util/qdeclarativepropertychanges.cpp3
-rw-r--r--src/declarative/util/qdeclarativesmoothedanimation.cpp3
-rw-r--r--src/declarative/util/qdeclarativespringanimation.cpp3
-rw-r--r--src/declarative/util/qdeclarativestate.cpp3
-rw-r--r--src/declarative/util/qdeclarativestategroup.cpp3
-rw-r--r--src/declarative/util/qdeclarativestateoperations.cpp9
-rw-r--r--src/declarative/util/qdeclarativesystempalette.cpp3
-rw-r--r--src/declarative/util/qdeclarativetimer.cpp3
-rw-r--r--src/declarative/util/qdeclarativetransition.cpp3
-rw-r--r--src/declarative/util/qdeclarativexmllistmodel.cpp6
17 files changed, 66 insertions, 33 deletions
diff --git a/src/declarative/util/qdeclarativeanimation.cpp b/src/declarative/util/qdeclarativeanimation.cpp
index f697a49d..66dcb126 100644
--- a/src/declarative/util/qdeclarativeanimation.cpp
+++ b/src/declarative/util/qdeclarativeanimation.cpp
@@ -73,7 +73,8 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass Animation QDeclarativeAbstractAnimation
+ \qmltype Animation
+ \instantiates QDeclarativeAbstractAnimation
\ingroup qml-animation-transition
\since 4.7
\brief The Animation element is the base of all QML animations.
@@ -553,7 +554,8 @@ void QDeclarativeAbstractAnimation::timelineComplete()
}
/*!
- \qmlclass PauseAnimation QDeclarativePauseAnimation
+ \qmltype PauseAnimation
+ \instantiates QDeclarativePauseAnimation
\ingroup qml-animation-transition
\since 4.7
\inherits Animation
@@ -624,7 +626,8 @@ QAbstractAnimation *QDeclarativePauseAnimation::qtAnimation()
}
/*!
- \qmlclass ColorAnimation QDeclarativeColorAnimation
+ \qmltype ColorAnimation
+ \instantiates QDeclarativeColorAnimation
\ingroup qml-animation-transition
\since 4.7
\inherits PropertyAnimation
@@ -728,7 +731,8 @@ void QDeclarativeColorAnimation::setTo(const QColor &t)
/*!
- \qmlclass ScriptAction QDeclarativeScriptAction
+ \qmltype ScriptAction
+ \instantiates QDeclarativeScriptAction
\ingroup qml-animation-transition
\since 4.7
\inherits Animation
@@ -862,7 +866,8 @@ QAbstractAnimation *QDeclarativeScriptAction::qtAnimation()
/*!
- \qmlclass PropertyAction QDeclarativePropertyAction
+ \qmltype PropertyAction
+ \instantiates QDeclarativePropertyAction
\ingroup qml-animation-transition
\since 4.7
\inherits Animation
@@ -1123,7 +1128,8 @@ void QDeclarativePropertyAction::transition(QDeclarativeStateActions &actions,
}
/*!
- \qmlclass NumberAnimation QDeclarativeNumberAnimation
+ \qmltype NumberAnimation
+ \instantiates QDeclarativeNumberAnimation
\ingroup qml-animation-transition
\since 4.7
\inherits PropertyAnimation
@@ -1235,7 +1241,8 @@ void QDeclarativeNumberAnimation::setTo(qreal t)
/*!
- \qmlclass Vector3dAnimation QDeclarativeVector3dAnimation
+ \qmltype Vector3dAnimation
+ \instantiates QDeclarativeVector3dAnimation
\ingroup qml-animation-transition
\since 4.7
\inherits PropertyAnimation
@@ -1311,7 +1318,8 @@ void QDeclarativeVector3dAnimation::setTo(QVector3D t)
/*!
- \qmlclass RotationAnimation QDeclarativeRotationAnimation
+ \qmltype RotationAnimation
+ \instantiates QDeclarativeRotationAnimation
\ingroup qml-animation-transition
\since 4.7
\inherits PropertyAnimation
@@ -1555,7 +1563,8 @@ QDeclarativeListProperty<QDeclarativeAbstractAnimation> QDeclarativeAnimationGro
}
/*!
- \qmlclass SequentialAnimation QDeclarativeSequentialAnimation
+ \qmltype SequentialAnimation
+ \instantiates QDeclarativeSequentialAnimation
\ingroup qml-animation-transition
\since 4.7
\inherits Animation
@@ -1629,7 +1638,8 @@ void QDeclarativeSequentialAnimation::transition(QDeclarativeStateActions &actio
/*!
- \qmlclass ParallelAnimation QDeclarativeParallelAnimation
+ \qmltype ParallelAnimation
+ \instantiates QDeclarativeParallelAnimation
\ingroup qml-animation-transition
\since 4.7
\inherits Animation
@@ -1743,7 +1753,8 @@ void QDeclarativePropertyAnimationPrivate::convertVariant(QVariant &variant, int
}
/*!
- \qmlclass PropertyAnimation QDeclarativePropertyAnimation
+ \qmltype PropertyAnimation
+ \instantiates QDeclarativePropertyAnimation
\ingroup qml-animation-transition
\since 4.7
\inherits Animation
@@ -2432,7 +2443,8 @@ void QDeclarativePropertyAnimation::transition(QDeclarativeStateActions &actions
}
/*!
- \qmlclass ParentAnimation QDeclarativeParentAnimation
+ \qmltype ParentAnimation
+ \instantiates QDeclarativeParentAnimation
\ingroup qml-animation-transition
\since 4.7
\inherits Animation
@@ -2793,7 +2805,8 @@ QAbstractAnimation *QDeclarativeParentAnimation::qtAnimation()
}
/*!
- \qmlclass AnchorAnimation QDeclarativeAnchorAnimation
+ \qmltype AnchorAnimation
+ \instantiates QDeclarativeAnchorAnimation
\ingroup qml-animation-transition
\since 4.7
\inherits Animation
diff --git a/src/declarative/util/qdeclarativebehavior.cpp b/src/declarative/util/qdeclarativebehavior.cpp
index 0c1ddc96..40bc448f 100644
--- a/src/declarative/util/qdeclarativebehavior.cpp
+++ b/src/declarative/util/qdeclarativebehavior.cpp
@@ -71,7 +71,8 @@ public:
};
/*!
- \qmlclass Behavior QDeclarativeBehavior
+ \qmltype Behavior
+ \instantiates QDeclarativeBehavior
\ingroup qml-animation-transition
\since 4.7
\brief The Behavior element allows you to specify a default animation for a property change.
diff --git a/src/declarative/util/qdeclarativebind.cpp b/src/declarative/util/qdeclarativebind.cpp
index 1675a9d8..3753f23f 100644
--- a/src/declarative/util/qdeclarativebind.cpp
+++ b/src/declarative/util/qdeclarativebind.cpp
@@ -72,7 +72,8 @@ public:
/*!
- \qmlclass Binding QDeclarativeBind
+ \qmltype Binding
+ \instantiates QDeclarativeBind
\ingroup qml-working-with-data
\since 4.7
\brief The Binding element allows arbitrary property bindings to be created.
diff --git a/src/declarative/util/qdeclarativeconnections.cpp b/src/declarative/util/qdeclarativeconnections.cpp
index 866fa042..de2a6fcc 100644
--- a/src/declarative/util/qdeclarativeconnections.cpp
+++ b/src/declarative/util/qdeclarativeconnections.cpp
@@ -71,7 +71,8 @@ public:
};
/*!
- \qmlclass Connections QDeclarativeConnections
+ \qmltype Connections
+ \instantiates QDeclarativeConnections
\ingroup qml-utility-elements
\since 4.7
\brief A Connections element describes generalized connections to signals.
diff --git a/src/declarative/util/qdeclarativefontloader.cpp b/src/declarative/util/qdeclarativefontloader.cpp
index a6720d6e..fc8d4637 100644
--- a/src/declarative/util/qdeclarativefontloader.cpp
+++ b/src/declarative/util/qdeclarativefontloader.cpp
@@ -146,7 +146,8 @@ public:
QHash<QUrl, QDeclarativeFontObject*> QDeclarativeFontLoaderPrivate::fonts;
/*!
- \qmlclass FontLoader QDeclarativeFontLoader
+ \qmltype FontLoader
+ \instantiates QDeclarativeFontLoader
\ingroup qml-utility-elements
\since 4.7
\brief The FontLoader element allows fonts to be loaded by name or URL.
diff --git a/src/declarative/util/qdeclarativelistmodel.cpp b/src/declarative/util/qdeclarativelistmodel.cpp
index 14de5f63..50018c12 100644
--- a/src/declarative/util/qdeclarativelistmodel.cpp
+++ b/src/declarative/util/qdeclarativelistmodel.cpp
@@ -86,7 +86,8 @@ QDeclarativeListModelParser::ListInstruction *QDeclarativeListModelParser::ListM
}
/*!
- \qmlclass ListModel QDeclarativeListModel
+ \qmltype ListModel
+ \instantiates QDeclarativeListModel
\ingroup qml-working-with-data
\since 4.7
\brief The ListModel element defines a free-form list data source.
@@ -874,7 +875,8 @@ bool QDeclarativeListModelParser::definesEmptyList(const QString &s)
/*!
- \qmlclass ListElement QDeclarativeListElement
+ \qmltype ListElement
+ \instantiates QDeclarativeListElement
\ingroup qml-working-with-data
\since 4.7
\brief The ListElement element defines a data item in a ListModel.
diff --git a/src/declarative/util/qdeclarativepackage.cpp b/src/declarative/util/qdeclarativepackage.cpp
index ec7ff43a..52447f0a 100644
--- a/src/declarative/util/qdeclarativepackage.cpp
+++ b/src/declarative/util/qdeclarativepackage.cpp
@@ -47,7 +47,8 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass Package QDeclarativePackage
+ \qmltype Package
+ \instantiates QDeclarativePackage
\ingroup qml-working-with-data
\brief Package provides a collection of named items.
diff --git a/src/declarative/util/qdeclarativepropertychanges.cpp b/src/declarative/util/qdeclarativepropertychanges.cpp
index bcc5a56d..b318668d 100644
--- a/src/declarative/util/qdeclarativepropertychanges.cpp
+++ b/src/declarative/util/qdeclarativepropertychanges.cpp
@@ -64,7 +64,8 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass PropertyChanges QDeclarativePropertyChanges
+ \qmltype PropertyChanges
+ \instantiates QDeclarativePropertyChanges
\ingroup qml-state-elements
\since 4.7
\brief The PropertyChanges element describes new property bindings or values for a state.
diff --git a/src/declarative/util/qdeclarativesmoothedanimation.cpp b/src/declarative/util/qdeclarativesmoothedanimation.cpp
index 36402fb1..2fc30c02 100644
--- a/src/declarative/util/qdeclarativesmoothedanimation.cpp
+++ b/src/declarative/util/qdeclarativesmoothedanimation.cpp
@@ -249,7 +249,8 @@ void QSmoothedAnimation::init()
}
/*!
- \qmlclass SmoothedAnimation QDeclarativeSmoothedAnimation
+ \qmltype SmoothedAnimation
+ \instantiates QDeclarativeSmoothedAnimation
\ingroup qml-animation-transition
\since 4.7
\inherits NumberAnimation
diff --git a/src/declarative/util/qdeclarativespringanimation.cpp b/src/declarative/util/qdeclarativespringanimation.cpp
index cc810ec3..59a55f30 100644
--- a/src/declarative/util/qdeclarativespringanimation.cpp
+++ b/src/declarative/util/qdeclarativespringanimation.cpp
@@ -234,7 +234,8 @@ void QDeclarativeSpringAnimationPrivate::updateMode()
}
/*!
- \qmlclass SpringAnimation QDeclarativeSpringAnimation
+ \qmltype SpringAnimation
+ \instantiates QDeclarativeSpringAnimation
\ingroup qml-animation-transition
\inherits NumberAnimation
\since 4.7
diff --git a/src/declarative/util/qdeclarativestate.cpp b/src/declarative/util/qdeclarativestate.cpp
index 6c152904..605d2633 100644
--- a/src/declarative/util/qdeclarativestate.cpp
+++ b/src/declarative/util/qdeclarativestate.cpp
@@ -129,7 +129,8 @@ QDeclarativeStateOperation::QDeclarativeStateOperation(QObjectPrivate &dd, QObje
}
/*!
- \qmlclass State QDeclarativeState
+ \qmltype State
+ \instantiates QDeclarativeState
\ingroup qml-state-elements
\since 4.7
\brief The State element defines configurations of objects and properties.
diff --git a/src/declarative/util/qdeclarativestategroup.cpp b/src/declarative/util/qdeclarativestategroup.cpp
index fa5e143c..2fed7bd6 100644
--- a/src/declarative/util/qdeclarativestategroup.cpp
+++ b/src/declarative/util/qdeclarativestategroup.cpp
@@ -92,7 +92,8 @@ public:
};
/*!
- \qmlclass StateGroup QDeclarativeStateGroup
+ \qmltype StateGroup
+ \instantiates QDeclarativeStateGroup
\ingroup qml-state-elements
\since 4.7
\brief The StateGroup element provides state support for non-Item elements.
diff --git a/src/declarative/util/qdeclarativestateoperations.cpp b/src/declarative/util/qdeclarativestateoperations.cpp
index 1fc92ac5..a4bf36cc 100644
--- a/src/declarative/util/qdeclarativestateoperations.cpp
+++ b/src/declarative/util/qdeclarativestateoperations.cpp
@@ -169,7 +169,8 @@ void QDeclarativeParentChangePrivate::doChange(QDeclarativeItem *targetParent, Q
/*!
\preliminary
- \qmlclass ParentChange QDeclarativeParentChange
+ \qmltype ParentChange
+ \instantiates QDeclarativeParentChange
\ingroup qml-state-elements
\brief The ParentChange element allows you to reparent an Item in a state change.
@@ -598,7 +599,8 @@ public:
};
/*!
- \qmlclass StateChangeScript QDeclarativeStateChangeScript
+ \qmltype StateChangeScript
+ \instantiates QDeclarativeStateChangeScript
\ingroup qml-state-elements
\brief The StateChangeScript element allows you to run a script in a state.
@@ -685,7 +687,8 @@ QString QDeclarativeStateChangeScript::typeName() const
}
/*!
- \qmlclass AnchorChanges QDeclarativeAnchorChanges
+ \qmltype AnchorChanges
+ \instantiates QDeclarativeAnchorChanges
\ingroup qml-state-elements
\brief The AnchorChanges element allows you to change the anchors of an item in a state.
diff --git a/src/declarative/util/qdeclarativesystempalette.cpp b/src/declarative/util/qdeclarativesystempalette.cpp
index 134137f2..56f385f8 100644
--- a/src/declarative/util/qdeclarativesystempalette.cpp
+++ b/src/declarative/util/qdeclarativesystempalette.cpp
@@ -57,7 +57,8 @@ public:
/*!
- \qmlclass SystemPalette QDeclarativeSystemPalette
+ \qmltype SystemPalette
+ \instantiates QDeclarativeSystemPalette
\ingroup qml-utility-elements
\since 4.7
\brief The SystemPalette element provides access to the Qt palettes.
diff --git a/src/declarative/util/qdeclarativetimer.cpp b/src/declarative/util/qdeclarativetimer.cpp
index 2c1efd2e..77a7cc3c 100644
--- a/src/declarative/util/qdeclarativetimer.cpp
+++ b/src/declarative/util/qdeclarativetimer.cpp
@@ -69,7 +69,8 @@ public:
};
/*!
- \qmlclass Timer QDeclarativeTimer
+ \qmltype Timer
+ \instantiates QDeclarativeTimer
\ingroup qml-utility-elements
\since 4.7
\brief The Timer item triggers a handler at a specified interval.
diff --git a/src/declarative/util/qdeclarativetransition.cpp b/src/declarative/util/qdeclarativetransition.cpp
index ef4869f9..3a861961 100644
--- a/src/declarative/util/qdeclarativetransition.cpp
+++ b/src/declarative/util/qdeclarativetransition.cpp
@@ -52,7 +52,8 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass Transition QDeclarativeTransition
+ \qmltype Transition
+ \instantiates QDeclarativeTransition
\ingroup qml-animation-transition
\since 4.7
\brief The Transition element defines animated transitions that occur on state changes.
diff --git a/src/declarative/util/qdeclarativexmllistmodel.cpp b/src/declarative/util/qdeclarativexmllistmodel.cpp
index 35cc1a4c..b98c178a 100644
--- a/src/declarative/util/qdeclarativexmllistmodel.cpp
+++ b/src/declarative/util/qdeclarativexmllistmodel.cpp
@@ -70,7 +70,8 @@ typedef QPair<int, int> QDeclarativeXmlListRange;
#define XMLLISTMODEL_CLEAR_ID 0
/*!
- \qmlclass XmlRole QDeclarativeXmlListModelRole
+ \qmltype XmlRole
+ \instantiates QDeclarativeXmlListModelRole
\ingroup qml-working-with-data
\since 4.7
\brief The XmlRole element allows you to specify a role for an XmlListModel.
@@ -598,7 +599,8 @@ void QDeclarativeXmlListModelPrivate::clear_role(QDeclarativeListProperty<QDecla
}
/*!
- \qmlclass XmlListModel QDeclarativeXmlListModel
+ \qmltype XmlListModel
+ \instantiates QDeclarativeXmlListModel
\ingroup qml-working-with-data
\since 4.7
\brief The XmlListModel element is used to specify a read-only model using XPath expressions.