aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/util
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@nokia.com>2012-07-27 17:18:12 +0200
committerQt by Nokia <qt-info@nokia.com>2012-07-30 11:11:56 +0200
commit2d3584ff21b8ddd8186972d52ecf189d0963febc (patch)
tree689f7770a5d49b9a39a3ef9ac03aa67bdb37f52b /src/quick/util
parente7b90ea3107996fb4a1b410631e0650d2d704912 (diff)
Doc: Changed \qmlclass to \qmltype and added \instantiates.
-To simplify QDoc, \qmlclass is now \qmltype. -'\instantiates <C+++ class>' is for the types that are defined in C++. Change-Id: I29242d33daf7b972d8b86a356b9689638866b950 Reviewed-by: Laszlo Papp <lpapp@kde.org> Reviewed-by: Bea Lam <bea.lam@nokia.com> Reviewed-by: Martin Smith <martin.smith@nokia.com>
Diffstat (limited to 'src/quick/util')
-rw-r--r--src/quick/util/qquickanimation.cpp33
-rw-r--r--src/quick/util/qquickanimationcontroller.cpp3
-rw-r--r--src/quick/util/qquickbehavior.cpp3
-rw-r--r--src/quick/util/qquickbind.cpp3
-rw-r--r--src/quick/util/qquickconnections.cpp3
-rw-r--r--src/quick/util/qquickfontloader.cpp3
-rw-r--r--src/quick/util/qquickpackage.cpp3
-rw-r--r--src/quick/util/qquickpath.cpp30
-rw-r--r--src/quick/util/qquickpathinterpolator.cpp3
-rw-r--r--src/quick/util/qquickpropertychanges.cpp3
-rw-r--r--src/quick/util/qquicksmoothedanimation.cpp3
-rw-r--r--src/quick/util/qquickspringanimation.cpp3
-rw-r--r--src/quick/util/qquickstate.cpp3
-rw-r--r--src/quick/util/qquickstatechangescript.cpp3
-rw-r--r--src/quick/util/qquickstategroup.cpp3
-rw-r--r--src/quick/util/qquicksystempalette.cpp3
-rw-r--r--src/quick/util/qquicktimer.cpp3
-rw-r--r--src/quick/util/qquicktransition.cpp3
18 files changed, 74 insertions, 37 deletions
diff --git a/src/quick/util/qquickanimation.cpp b/src/quick/util/qquickanimation.cpp
index 46180cb421..912a8e34a4 100644
--- a/src/quick/util/qquickanimation.cpp
+++ b/src/quick/util/qquickanimation.cpp
@@ -70,7 +70,8 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass Animation QQuickAbstractAnimation
+ \qmltype Animation
+ \instantiates QQuickAbstractAnimation
\inqmlmodule QtQuick 2
\ingroup qtquick-transitions-animations
\brief Is the base of all QML animations
@@ -643,7 +644,8 @@ void QQuickAbstractAnimationPrivate::animationFinished(QAbstractAnimationJob*)
}
/*!
- \qmlclass PauseAnimation QQuickPauseAnimation
+ \qmltype PauseAnimation
+ \instantiates QQuickPauseAnimation
\inqmlmodule QtQuick 2
\ingroup qtquick-transitions-animations
\inherits Animation
@@ -713,7 +715,8 @@ QAbstractAnimationJob* QQuickPauseAnimation::transition(QQuickStateActions &acti
}
/*!
- \qmlclass ColorAnimation QQuickColorAnimation
+ \qmltype ColorAnimation
+ \instantiates QQuickColorAnimation
\inqmlmodule QtQuick 2
\ingroup qtquick-animation-properties
\inherits PropertyAnimation
@@ -857,7 +860,8 @@ void QActionAnimation::updateState(State newState, State oldState)
}
/*!
- \qmlclass ScriptAction QQuickScriptAction
+ \qmltype ScriptAction
+ \instantiates QQuickScriptAction
\inqmlmodule QtQuick 2
\ingroup qtquick-transitions-animations
\inherits Animation
@@ -983,7 +987,8 @@ QAbstractAnimationJob* QQuickScriptAction::transition(QQuickStateActions &action
}
/*!
- \qmlclass PropertyAction QQuickPropertyAction
+ \qmltype PropertyAction
+ \instantiates QQuickPropertyAction
\inqmlmodule QtQuick 2
\ingroup qtquick-transitions-animations
\inherits Animation
@@ -1235,7 +1240,8 @@ QAbstractAnimationJob* QQuickPropertyAction::transition(QQuickStateActions &acti
}
/*!
- \qmlclass NumberAnimation QQuickNumberAnimation
+ \qmltype NumberAnimation
+ \instantiates QQuickNumberAnimation
\inqmlmodule QtQuick 2
\ingroup qtquick-animation-properties
\inherits PropertyAnimation
@@ -1347,7 +1353,8 @@ void QQuickNumberAnimation::setTo(qreal t)
/*!
- \qmlclass Vector3dAnimation QQuickVector3dAnimation
+ \qmltype Vector3dAnimation
+ \instantiates QQuickVector3dAnimation
\inqmlmodule QtQuick 2
\ingroup qtquick-animation-properties
\inherits PropertyAnimation
@@ -1423,7 +1430,8 @@ void QQuickVector3dAnimation::setTo(QVector3D t)
/*!
- \qmlclass RotationAnimation QQuickRotationAnimation
+ \qmltype RotationAnimation
+ \instantiates QQuickRotationAnimation
\inqmlmodule QtQuick 2
\ingroup qtquick-animation-properties
\inherits PropertyAnimation
@@ -1663,7 +1671,8 @@ QQmlListProperty<QQuickAbstractAnimation> QQuickAnimationGroup::animations()
}
/*!
- \qmlclass SequentialAnimation QQuickSequentialAnimation
+ \qmltype SequentialAnimation
+ \instantiates QQuickSequentialAnimation
\inqmlmodule QtQuick 2
\ingroup qtquick-transitions-animations
\inherits Animation
@@ -1736,7 +1745,8 @@ QAbstractAnimationJob* QQuickSequentialAnimation::transition(QQuickStateActions
/*!
- \qmlclass ParallelAnimation QQuickParallelAnimation
+ \qmltype ParallelAnimation
+ \instantiates QQuickParallelAnimation
\inqmlmodule QtQuick 2
\ingroup qtquick-transitions-animations
\inherits Animation
@@ -1862,7 +1872,8 @@ void QQuickBulkValueAnimator::topLevelAnimationLoopChanged()
}
/*!
- \qmlclass PropertyAnimation QQuickPropertyAnimation
+ \qmltype PropertyAnimation
+ \instantiates QQuickPropertyAnimation
\inqmlmodule QtQuick 2
\ingroup qtquick-animation-properties
\inherits Animation
diff --git a/src/quick/util/qquickanimationcontroller.cpp b/src/quick/util/qquickanimationcontroller.cpp
index 4cfee6d11f..7a0eba88d4 100644
--- a/src/quick/util/qquickanimationcontroller.cpp
+++ b/src/quick/util/qquickanimationcontroller.cpp
@@ -92,7 +92,8 @@ void QQuickAnimationControllerPrivate::animationCurrentTimeChanged(QAbstractAnim
}
/*!
- \qmlclass AnimationController QQuickAnimationController
+ \qmltype AnimationController
+ \instantiates QQuickAnimationController
\inqmlmodule QtQuick 2
\ingroup qtquick-animation-control
\brief Enables manual control of animations
diff --git a/src/quick/util/qquickbehavior.cpp b/src/quick/util/qquickbehavior.cpp
index ee8a1e494d..77ea7967b8 100644
--- a/src/quick/util/qquickbehavior.cpp
+++ b/src/quick/util/qquickbehavior.cpp
@@ -73,7 +73,8 @@ public:
};
/*!
- \qmlclass Behavior QQuickBehavior
+ \qmltype Behavior
+ \instantiates QQuickBehavior
\inqmlmodule QtQuick 2
\ingroup qtquick-transitions-animations
\ingroup qtquick-interceptors
diff --git a/src/quick/util/qquickbind.cpp b/src/quick/util/qquickbind.cpp
index 3ccd5222f9..9bb3185f55 100644
--- a/src/quick/util/qquickbind.cpp
+++ b/src/quick/util/qquickbind.cpp
@@ -75,7 +75,8 @@ public:
/*!
- \qmlclass Binding QQuickBind
+ \qmltype Binding
+ \instantiates QQuickBind
\inqmlmodule QtQuick 2
\ingroup qtquick-interceptors
\brief Enables the arbitrary creation of property bindings
diff --git a/src/quick/util/qquickconnections.cpp b/src/quick/util/qquickconnections.cpp
index 654d0b7ae7..d2591557d1 100644
--- a/src/quick/util/qquickconnections.cpp
+++ b/src/quick/util/qquickconnections.cpp
@@ -71,7 +71,8 @@ public:
};
/*!
- \qmlclass Connections QQuickConnections
+ \qmltype Connections
+ \instantiates QQuickConnections
\inqmlmodule QtQuick 2
\ingroup qtquick-interceptors
\brief Describes generalized connections to signals
diff --git a/src/quick/util/qquickfontloader.cpp b/src/quick/util/qquickfontloader.cpp
index 82f0468d99..3538662577 100644
--- a/src/quick/util/qquickfontloader.cpp
+++ b/src/quick/util/qquickfontloader.cpp
@@ -146,7 +146,8 @@ public:
QHash<QUrl, QQuickFontObject*> QQuickFontLoaderPrivate::fonts;
/*!
- \qmlclass FontLoader QQuickFontLoader
+ \qmltype FontLoader
+ \instantiates QQuickFontLoader
\inqmlmodule QtQuick 2
\ingroup qtquick-text-utility
\brief Allows fonts to be loaded by name or URL
diff --git a/src/quick/util/qquickpackage.cpp b/src/quick/util/qquickpackage.cpp
index 3ec28f31f1..7e82880a2c 100644
--- a/src/quick/util/qquickpackage.cpp
+++ b/src/quick/util/qquickpackage.cpp
@@ -47,7 +47,8 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass Package QQuickPackage
+ \qmltype Package
+ \instantiates QQuickPackage
\inqmlmodule QtQuick 2
\ingroup qtquick-views
\brief Specifies a collection of named items
diff --git a/src/quick/util/qquickpath.cpp b/src/quick/util/qquickpath.cpp
index 2594d33950..9655cf21d1 100644
--- a/src/quick/util/qquickpath.cpp
+++ b/src/quick/util/qquickpath.cpp
@@ -53,7 +53,8 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass PathElement QQuickPathElement
+ \qmltype PathElement
+ \instantiates QQuickPathElement
\inqmlmodule QtQuick 2
\ingroup qtquick-animation-paths
\brief PathElement is the base path type
@@ -65,7 +66,8 @@ QT_BEGIN_NAMESPACE
*/
/*!
- \qmlclass Path QQuickPath
+ \qmltype Path
+ \instantiates QQuickPath
\inqmlmodule QtQuick 2
\ingroup qtquick-animation-paths
\brief Defines a path for use by \l PathView
@@ -803,7 +805,8 @@ bool QQuickCurve::hasRelativeY()
/****************************************************************************/
/*!
- \qmlclass PathAttribute QQuickPathAttribute
+ \qmltype PathAttribute
+ \instantiates QQuickPathAttribute
\inqmlmodule QtQuick 2
\ingroup qtquick-animation-paths
\brief Specifies how to set an attribute at a given position in a Path
@@ -919,7 +922,8 @@ void QQuickPathAttribute::setValue(qreal value)
/****************************************************************************/
/*!
- \qmlclass PathLine QQuickPathLine
+ \qmltype PathLine
+ \instantiates QQuickPathLine
\inqmlmodule QtQuick 2
\ingroup qtquick-animation-paths
\brief Defines a straight line
@@ -977,7 +981,8 @@ void QQuickPathLine::addToPath(QPainterPath &path, const QQuickPathData &data)
/****************************************************************************/
/*!
- \qmlclass PathQuad QQuickPathQuad
+ \qmltype PathQuad
+ \instantiates QQuickPathQuad
\inqmlmodule QtQuick 2
\ingroup qtquick-animation-paths
\brief Defines a quadratic Bezier curve with a control point
@@ -1128,7 +1133,8 @@ void QQuickPathQuad::addToPath(QPainterPath &path, const QQuickPathData &data)
/****************************************************************************/
/*!
- \qmlclass PathCubic QQuickPathCubic
+ \qmltype PathCubic
+ \instantiates QQuickPathCubic
\inqmlmodule QtQuick 2
\ingroup qtquick-animation-paths
\brief Defines a cubic Bezier curve with two control points
@@ -1351,7 +1357,8 @@ void QQuickPathCubic::addToPath(QPainterPath &path, const QQuickPathData &data)
/****************************************************************************/
/*!
- \qmlclass PathCurve QQuickPathCurve
+ \qmltype PathCurve
+ \instantiates QQuickPathCurve
\inqmlmodule QtQuick 2
\ingroup qtquick-animation-paths
\brief Defines a point on a Catmull-Rom curve
@@ -1496,7 +1503,8 @@ void QQuickPathCatmullRomCurve::addToPath(QPainterPath &path, const QQuickPathDa
/****************************************************************************/
/*!
- \qmlclass PathArc QQuickPathArc
+ \qmltype PathArc
+ \instantiates QQuickPathArc
\inqmlmodule QtQuick 2
\ingroup qtquick-animation-paths
\brief Defines an arc with the given radius
@@ -1666,7 +1674,8 @@ void QQuickPathArc::addToPath(QPainterPath &path, const QQuickPathData &data)
/****************************************************************************/
/*!
- \qmlclass PathSvg QQuickPathSvg
+ \qmltype PathSvg
+ \instantiates QQuickPathSvg
\inqmlmodule QtQuick 2
\ingroup qtquick-animation-paths
\brief Defines a path using an SVG path data string
@@ -1718,7 +1727,8 @@ void QQuickPathSvg::addToPath(QPainterPath &path, const QQuickPathData &)
/****************************************************************************/
/*!
- \qmlclass PathPercent QQuickPathPercent
+ \qmltype PathPercent
+ \instantiates QQuickPathPercent
\inqmlmodule QtQuick 2
\ingroup qtquick-animation-paths
\brief Manipulates the way a path is interpreted
diff --git a/src/quick/util/qquickpathinterpolator.cpp b/src/quick/util/qquickpathinterpolator.cpp
index 1430f72058..034e5f4045 100644
--- a/src/quick/util/qquickpathinterpolator.cpp
+++ b/src/quick/util/qquickpathinterpolator.cpp
@@ -46,7 +46,8 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass PathInterpolator QQuickPathInterpolator
+ \qmltype PathInterpolator
+ \instantiates QQuickPathInterpolator
\inqmlmodule QtQuick 2
\ingroup qtquick-animation-control
\brief Specifies how to manually animate along a path
diff --git a/src/quick/util/qquickpropertychanges.cpp b/src/quick/util/qquickpropertychanges.cpp
index 68e5a0e247..6bd48e2900 100644
--- a/src/quick/util/qquickpropertychanges.cpp
+++ b/src/quick/util/qquickpropertychanges.cpp
@@ -64,7 +64,8 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass PropertyChanges QQuickPropertyChanges
+ \qmltype PropertyChanges
+ \instantiates QQuickPropertyChanges
\inqmlmodule QtQuick 2
\ingroup qtquick-states
\brief Describes new property bindings or values for a state
diff --git a/src/quick/util/qquicksmoothedanimation.cpp b/src/quick/util/qquicksmoothedanimation.cpp
index 7a7968472b..9684cf6c0c 100644
--- a/src/quick/util/qquicksmoothedanimation.cpp
+++ b/src/quick/util/qquicksmoothedanimation.cpp
@@ -307,7 +307,8 @@ void QSmoothedAnimation::init()
}
/*!
- \qmlclass SmoothedAnimation QQuickSmoothedAnimation
+ \qmltype SmoothedAnimation
+ \instantiates QQuickSmoothedAnimation
\inqmlmodule QtQuick 2
\ingroup qtquick-transitions-animations
\inherits NumberAnimation
diff --git a/src/quick/util/qquickspringanimation.cpp b/src/quick/util/qquickspringanimation.cpp
index 718eaf0bab..e5780f6087 100644
--- a/src/quick/util/qquickspringanimation.cpp
+++ b/src/quick/util/qquickspringanimation.cpp
@@ -340,7 +340,8 @@ void QQuickSpringAnimationPrivate::updateMode()
}
/*!
- \qmlclass SpringAnimation QQuickSpringAnimation
+ \qmltype SpringAnimation
+ \instantiates QQuickSpringAnimation
\inqmlmodule QtQuick 2
\ingroup qtquick-transitions-animations
\inherits NumberAnimation
diff --git a/src/quick/util/qquickstate.cpp b/src/quick/util/qquickstate.cpp
index 98dbd6d30c..99f9819590 100644
--- a/src/quick/util/qquickstate.cpp
+++ b/src/quick/util/qquickstate.cpp
@@ -120,7 +120,8 @@ QQuickStateOperation::QQuickStateOperation(QObjectPrivate &dd, QObject *parent)
}
/*!
- \qmlclass State QQuickState
+ \qmltype State
+ \instantiates QQuickState
\inqmlmodule QtQuick 2
\ingroup qtquick-states
\brief Defines configurations of objects and properties
diff --git a/src/quick/util/qquickstatechangescript.cpp b/src/quick/util/qquickstatechangescript.cpp
index 19bd21f3d4..ef894968f5 100644
--- a/src/quick/util/qquickstatechangescript.cpp
+++ b/src/quick/util/qquickstatechangescript.cpp
@@ -68,7 +68,8 @@ public:
};
/*!
- \qmlclass StateChangeScript QQuickStateChangeScript
+ \qmltype StateChangeScript
+ \instantiates QQuickStateChangeScript
\inqmlmodule QtQuick 2
\ingroup qtquick-states
\brief Specifies how to run a script in a state
diff --git a/src/quick/util/qquickstategroup.cpp b/src/quick/util/qquickstategroup.cpp
index 9e0909b741..23a7348ded 100644
--- a/src/quick/util/qquickstategroup.cpp
+++ b/src/quick/util/qquickstategroup.cpp
@@ -92,7 +92,8 @@ public:
};
/*!
- \qmlclass StateGroup QQuickStateGroup
+ \qmltype StateGroup
+ \instantiates QQuickStateGroup
\inqmlmodule QtQuick 2
\ingroup qtquick-states
\brief Provides built-in state support for non-Item types
diff --git a/src/quick/util/qquicksystempalette.cpp b/src/quick/util/qquicksystempalette.cpp
index 7c234a3264..1a2e9f65fe 100644
--- a/src/quick/util/qquicksystempalette.cpp
+++ b/src/quick/util/qquicksystempalette.cpp
@@ -57,7 +57,8 @@ public:
/*!
- \qmlclass SystemPalette QQuickSystemPalette
+ \qmltype SystemPalette
+ \instantiates QQuickSystemPalette
\inqmlmodule QtQuick 2
\ingroup qtquick-visual-utility
\brief Provides access to the Qt palettes
diff --git a/src/quick/util/qquicktimer.cpp b/src/quick/util/qquicktimer.cpp
index 7b747005e2..1124eff0e2 100644
--- a/src/quick/util/qquicktimer.cpp
+++ b/src/quick/util/qquicktimer.cpp
@@ -73,7 +73,8 @@ public:
};
/*!
- \qmlclass Timer QQuickTimer
+ \qmltype Timer
+ \instantiates QQuickTimer
\inqmlmodule QtQuick 2
\ingroup qtquick-interceptors
\brief Triggers a handler at a specified interval
diff --git a/src/quick/util/qquicktransition.cpp b/src/quick/util/qquicktransition.cpp
index 32c97565ce..1548c07254 100644
--- a/src/quick/util/qquicktransition.cpp
+++ b/src/quick/util/qquicktransition.cpp
@@ -53,7 +53,8 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass Transition QQuickTransition
+ \qmltype Transition
+ \instantiates QQuickTransition
\inqmlmodule QtQuick 2
\ingroup qtquick-transitions-animations
\brief Defines animated transitions that occur on state changes