aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/util
diff options
context:
space:
mode:
authorChris Adams <christopher.adams@nokia.com>2012-05-28 17:12:56 +1000
committerQt by Nokia <qt-info@nokia.com>2012-06-21 09:58:56 +0200
commit5e33b0f580d2b20f1a2989bf2ee8dde4525a2e39 (patch)
tree780d25ce7d8955e56ea985a35dd84609df12fbf0 /src/quick/util
parent03342a435a88656d64d1445991a4421d244fcb45 (diff)
Create new documentation structure
The documentation currently has no clear separation between Qt QML and Qt Quick. With recent commits like: 6c8378eaf1edbbefe6aaa3672b0127816a004fd7 and ab1e510121c8a679fdaca12ccd30e0f7ac12a26b the separation between the language definition and implementation, provided by Qt QML, and the standard library for the QML language, provided by Qt Quick, is clear. This commit creates a new documentation structure that is more navigable and separates concepts into logical categories, with clear separation between QtQML and QtQuick. It also provides a more generic QML Application Developer Resources page which contains links to information for QML application developers. Change-Id: Ia807ccfbfd24ffa0e1c7f0a51ed9d2ed3aa6a733 Reviewed-by: Martin Jones <martin.jones@nokia.com>
Diffstat (limited to 'src/quick/util')
-rw-r--r--src/quick/util/qquickanimation.cpp12
-rw-r--r--src/quick/util/qquickbehavior.cpp3
-rw-r--r--src/quick/util/qquickbind.cpp2
-rw-r--r--src/quick/util/qquickconnections.cpp2
-rw-r--r--src/quick/util/qquickfontloader.cpp2
-rw-r--r--src/quick/util/qquickimageprovider.cpp2
-rw-r--r--src/quick/util/qquickpackage.cpp2
-rw-r--r--src/quick/util/qquickpath.cpp20
-rw-r--r--src/quick/util/qquicksmoothedanimation.cpp2
-rw-r--r--src/quick/util/qquickspringanimation.cpp2
-rw-r--r--src/quick/util/qquicksystempalette.cpp2
-rw-r--r--src/quick/util/qquicktimer.cpp2
-rw-r--r--src/quick/util/qquicktransition.cpp2
13 files changed, 28 insertions, 27 deletions
diff --git a/src/quick/util/qquickanimation.cpp b/src/quick/util/qquickanimation.cpp
index 8162aaeee3..ebdde58c63 100644
--- a/src/quick/util/qquickanimation.cpp
+++ b/src/quick/util/qquickanimation.cpp
@@ -72,7 +72,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass Animation QQuickAbstractAnimation
\inqmlmodule QtQuick 2
- \ingroup qtquick-animation-properties
+ \ingroup qtquick-transitions-animations
\brief Is the base of all QML animations
The Animation element cannot be used directly in a QML file. It exists
@@ -617,7 +617,7 @@ void QQuickAbstractAnimationPrivate::animationFinished(QAbstractAnimationJob*)
/*!
\qmlclass PauseAnimation QQuickPauseAnimation
\inqmlmodule QtQuick 2
- \ingroup qtquick-animation-modifiers
+ \ingroup qtquick-transitions-animations
\inherits Animation
\brief Provides a pause for an animation
@@ -831,7 +831,7 @@ void QActionAnimation::updateState(State newState, State oldState)
/*!
\qmlclass ScriptAction QQuickScriptAction
\inqmlmodule QtQuick 2
- \ingroup qtquick-animation-modifiers
+ \ingroup qtquick-transitions-animations
\inherits Animation
\brief Defines scripts to be run during an animation
@@ -957,7 +957,7 @@ QAbstractAnimationJob* QQuickScriptAction::transition(QQuickStateActions &action
/*!
\qmlclass PropertyAction QQuickPropertyAction
\inqmlmodule QtQuick 2
- \ingroup qtquick-animation-modifiers
+ \ingroup qtquick-transitions-animations
\inherits Animation
\brief Specifies immediate property changes during animation
@@ -1637,7 +1637,7 @@ QQmlListProperty<QQuickAbstractAnimation> QQuickAnimationGroup::animations()
/*!
\qmlclass SequentialAnimation QQuickSequentialAnimation
\inqmlmodule QtQuick 2
- \ingroup qtquick-animation-define
+ \ingroup qtquick-transitions-animations
\inherits Animation
\brief Allows animations to be run sequentially
@@ -1710,7 +1710,7 @@ QAbstractAnimationJob* QQuickSequentialAnimation::transition(QQuickStateActions
/*!
\qmlclass ParallelAnimation QQuickParallelAnimation
\inqmlmodule QtQuick 2
- \ingroup qtquick-animation-define
+ \ingroup qtquick-transitions-animations
\inherits Animation
\brief Enables animations to be run in parallel
diff --git a/src/quick/util/qquickbehavior.cpp b/src/quick/util/qquickbehavior.cpp
index 0de99d4db1..ee8a1e494d 100644
--- a/src/quick/util/qquickbehavior.cpp
+++ b/src/quick/util/qquickbehavior.cpp
@@ -75,7 +75,8 @@ public:
/*!
\qmlclass Behavior QQuickBehavior
\inqmlmodule QtQuick 2
- \ingroup qtquick-animation-define
+ \ingroup qtquick-transitions-animations
+ \ingroup qtquick-interceptors
\brief Defines a default animation for a property change
A Behavior defines the default animation to be applied whenever a
diff --git a/src/quick/util/qquickbind.cpp b/src/quick/util/qquickbind.cpp
index bd57efb29b..0a1cd27a76 100644
--- a/src/quick/util/qquickbind.cpp
+++ b/src/quick/util/qquickbind.cpp
@@ -77,7 +77,7 @@ public:
/*!
\qmlclass Binding QQuickBind
\inqmlmodule QtQuick 2
- \ingroup qtquick-utility
+ \ingroup qtquick-interceptors
\brief Enables the arbitrary creation of property bindings
\section1 Binding to an inaccessible property
diff --git a/src/quick/util/qquickconnections.cpp b/src/quick/util/qquickconnections.cpp
index be3d9539c5..9b086b9e03 100644
--- a/src/quick/util/qquickconnections.cpp
+++ b/src/quick/util/qquickconnections.cpp
@@ -73,7 +73,7 @@ public:
/*!
\qmlclass Connections QQuickConnections
\inqmlmodule QtQuick 2
- \ingroup qtquick-utility
+ \ingroup qtquick-interceptors
\brief Describes generalized connections to signals
A Connections object creates a connection to a QML signal.
diff --git a/src/quick/util/qquickfontloader.cpp b/src/quick/util/qquickfontloader.cpp
index 7e5f3de9af..1d982ce14c 100644
--- a/src/quick/util/qquickfontloader.cpp
+++ b/src/quick/util/qquickfontloader.cpp
@@ -148,7 +148,7 @@ QHash<QUrl, QQuickFontObject*> QQuickFontLoaderPrivate::fonts;
/*!
\qmlclass FontLoader QQuickFontLoader
\inqmlmodule QtQuick 2
- \ingroup qtquick-utility
+ \ingroup qtquick-text-utility
\brief Allows fonts to be loaded by name or URL
The FontLoader element is used to load fonts by name or URL.
diff --git a/src/quick/util/qquickimageprovider.cpp b/src/quick/util/qquickimageprovider.cpp
index b0bbf46489..42da519f58 100644
--- a/src/quick/util/qquickimageprovider.cpp
+++ b/src/quick/util/qquickimageprovider.cpp
@@ -189,7 +189,7 @@ QImage QQuickTextureFactory::image() const
\image imageprovider.png
A complete example is available in Qt's
- \l {declarative/cppextensions/imageprovider}{examples/qml/cppextensions/imageprovider}
+ \l {qml/cppextensions/imageprovider}{examples/qml/cppextensions/imageprovider}
directory. Note the example registers the provider via a \l{QQmlExtensionPlugin}{plugin}
instead of registering it in the application \c main() function as shown above.
diff --git a/src/quick/util/qquickpackage.cpp b/src/quick/util/qquickpackage.cpp
index 059a55ea88..33632357e9 100644
--- a/src/quick/util/qquickpackage.cpp
+++ b/src/quick/util/qquickpackage.cpp
@@ -72,7 +72,7 @@ QT_BEGIN_NAMESPACE
\snippet examples/quick/modelviews/package/view.qml 0
- \sa {declarative/modelviews/package}{Package example}, {declarative/photoviewer}{Photo Viewer example}, QtQml
+ \sa {quick/modelviews/package}{Package example}, {declarative/photoviewer}{Photo Viewer example}, QtQml
*/
/*!
diff --git a/src/quick/util/qquickpath.cpp b/src/quick/util/qquickpath.cpp
index b1adfe3d68..ff220c61df 100644
--- a/src/quick/util/qquickpath.cpp
+++ b/src/quick/util/qquickpath.cpp
@@ -55,7 +55,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass PathElement QQuickPathElement
\inqmlmodule QtQuick 2
- \ingroup qtquick-paths
+ \ingroup qtquick-animation-paths
\brief PathElement is the base path type
This type is the base for all path types. It cannot
@@ -67,7 +67,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass Path QQuickPath
\inqmlmodule QtQuick 2
- \ingroup qtquick-paths
+ \ingroup qtquick-animation-paths
\brief Defines a path for use by \l PathView
A Path is composed of one or more path segments - PathLine, PathQuad,
@@ -805,7 +805,7 @@ bool QQuickCurve::hasRelativeY()
/*!
\qmlclass PathAttribute QQuickPathAttribute
\inqmlmodule QtQuick 2
- \ingroup qtquick-paths
+ \ingroup qtquick-animation-paths
\brief Specifies how to set an attribute at a given position in a Path
The PathAttribute object allows attributes consisting of a name and
@@ -921,7 +921,7 @@ void QQuickPathAttribute::setValue(qreal value)
/*!
\qmlclass PathLine QQuickPathLine
\inqmlmodule QtQuick 2
- \ingroup qtquick-paths
+ \ingroup qtquick-animation-paths
\brief Defines a straight line
The example below creates a path consisting of a straight line from
@@ -979,7 +979,7 @@ void QQuickPathLine::addToPath(QPainterPath &path, const QQuickPathData &data)
/*!
\qmlclass PathQuad QQuickPathQuad
\inqmlmodule QtQuick 2
- \ingroup qtquick-paths
+ \ingroup qtquick-animation-paths
\brief Defines a quadratic Bezier curve with a control point
The following QML produces the path shown below:
@@ -1130,7 +1130,7 @@ void QQuickPathQuad::addToPath(QPainterPath &path, const QQuickPathData &data)
/*!
\qmlclass PathCubic QQuickPathCubic
\inqmlmodule QtQuick 2
- \ingroup qtquick-paths
+ \ingroup qtquick-animation-paths
\brief Defines a cubic Bezier curve with two control points
The following QML produces the path shown below:
@@ -1353,7 +1353,7 @@ void QQuickPathCubic::addToPath(QPainterPath &path, const QQuickPathData &data)
/*!
\qmlclass PathCurve QQuickPathCurve
\inqmlmodule QtQuick 2
- \ingroup qtquick-paths
+ \ingroup qtquick-animation-paths
\brief Defines a point on a Catmull-Rom curve
PathCurve provides an easy way to specify a curve passing directly through a set of points.
@@ -1498,7 +1498,7 @@ void QQuickPathCatmullRomCurve::addToPath(QPainterPath &path, const QQuickPathDa
/*!
\qmlclass PathArc QQuickPathArc
\inqmlmodule QtQuick 2
- \ingroup qtquick-paths
+ \ingroup qtquick-animation-paths
\brief Defines an arc with the given radius
PathArc provides a simple way of specifying an arc that ends at a given position
@@ -1668,7 +1668,7 @@ void QQuickPathArc::addToPath(QPainterPath &path, const QQuickPathData &data)
/*!
\qmlclass PathSvg QQuickPathSvg
\inqmlmodule QtQuick 2
- \ingroup qtquick-paths
+ \ingroup qtquick-animation-paths
\brief Defines a path using an SVG path data string
The following QML produces the path shown below:
@@ -1720,7 +1720,7 @@ void QQuickPathSvg::addToPath(QPainterPath &path, const QQuickPathData &)
/*!
\qmlclass PathPercent QQuickPathPercent
\inqmlmodule QtQuick 2
- \ingroup qtquick-paths
+ \ingroup qtquick-animation-paths
\brief Manipulates the way a path is interpreted
PathPercent allows you to manipulate the spacing between items on a
diff --git a/src/quick/util/qquicksmoothedanimation.cpp b/src/quick/util/qquicksmoothedanimation.cpp
index b4986c0479..49dce04db3 100644
--- a/src/quick/util/qquicksmoothedanimation.cpp
+++ b/src/quick/util/qquicksmoothedanimation.cpp
@@ -309,7 +309,7 @@ void QSmoothedAnimation::init()
/*!
\qmlclass SmoothedAnimation QQuickSmoothedAnimation
\inqmlmodule QtQuick 2
- \ingroup qtquick-animation-properties
+ \ingroup qtquick-transitions-animations
\inherits NumberAnimation
\brief Allows a property to smoothly track a value
diff --git a/src/quick/util/qquickspringanimation.cpp b/src/quick/util/qquickspringanimation.cpp
index 3e0a1ce755..413f95edb3 100644
--- a/src/quick/util/qquickspringanimation.cpp
+++ b/src/quick/util/qquickspringanimation.cpp
@@ -342,7 +342,7 @@ void QQuickSpringAnimationPrivate::updateMode()
/*!
\qmlclass SpringAnimation QQuickSpringAnimation
\inqmlmodule QtQuick 2
- \ingroup qtquick-animation-properties
+ \ingroup qtquick-transitions-animations
\inherits NumberAnimation
\brief Allows a property to track a value in a spring-like motion
diff --git a/src/quick/util/qquicksystempalette.cpp b/src/quick/util/qquicksystempalette.cpp
index 1cbde6ef5a..b500f204f0 100644
--- a/src/quick/util/qquicksystempalette.cpp
+++ b/src/quick/util/qquicksystempalette.cpp
@@ -59,7 +59,7 @@ public:
/*!
\qmlclass SystemPalette QQuickSystemPalette
\inqmlmodule QtQuick 2
- \ingroup qtquick-utility
+ \ingroup qtquick-visual-utility
\brief Provides access to the Qt palettes
The SystemPalette element provides access to the Qt application
diff --git a/src/quick/util/qquicktimer.cpp b/src/quick/util/qquicktimer.cpp
index 84ede7b038..88dc0790d9 100644
--- a/src/quick/util/qquicktimer.cpp
+++ b/src/quick/util/qquicktimer.cpp
@@ -75,7 +75,7 @@ public:
/*!
\qmlclass Timer QQuickTimer
\inqmlmodule QtQuick 2
- \ingroup qtquick-utility
+ \ingroup qtquick-interceptors
\brief Triggers a handler at a specified interval
A Timer can be used to trigger an action either once, or repeatedly
diff --git a/src/quick/util/qquicktransition.cpp b/src/quick/util/qquicktransition.cpp
index 2431642082..de32fefd18 100644
--- a/src/quick/util/qquicktransition.cpp
+++ b/src/quick/util/qquicktransition.cpp
@@ -55,7 +55,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass Transition QQuickTransition
\inqmlmodule QtQuick 2
- \ingroup qtquick-animation-define
+ \ingroup qtquick-transitions-animations
\brief Defines animated transitions that occur on state changes
A Transition defines the animations to be applied when a \l State change occurs.