diff options
| author | Nico Vertriest <nico.vertriest@nokia.com> | 2012-05-18 15:19:55 +0200 |
|---|---|---|
| committer | Qt by Nokia <qt-info@nokia.com> | 2012-05-24 15:41:16 +0200 |
| commit | 6112c0f57177ee813271da54200a2d9f3ef20238 (patch) | |
| tree | b0cb10f46fb8c6b2b13516ab8e0e97c675b506a3 /src | |
| parent | b13827d77e9a3d64a728036b3804638da62bbe40 (diff) | |
Doc: Sanitized QML types
-modified \brief
-checked QML modules
-added qml directory to the qdocconf file
-added particles directory to the qdocconf file
Change-Id: I589e32d3106cda37c7fa4d55a941afd9876fc2b2
Reviewed-by: Geir Vattekar <geir.vattekar@nokia.com>
Diffstat (limited to 'src')
97 files changed, 188 insertions, 172 deletions
diff --git a/src/imports/localstorage/plugin.cpp b/src/imports/localstorage/plugin.cpp index ac007f2849..e3e9fa4cd3 100644 --- a/src/imports/localstorage/plugin.cpp +++ b/src/imports/localstorage/plugin.cpp @@ -456,7 +456,7 @@ through the data. \inqmlmodule QtQuick.LocalStorage 2 \since QtQuick 2.0 - \brief The LocalStorage module API provides the ability to access local offline storage in an SQL database. + \brief Provides a JavaScript module API for accessing a local SQLite database These databases are user-specific and QML-specific, but accessible to all QML applications. They are stored in the \c Databases subdirectory diff --git a/src/imports/testlib/signalspy.qdoc b/src/imports/testlib/signalspy.qdoc index 504ab8de5e..743c0e2aed 100644 --- a/src/imports/testlib/signalspy.qdoc +++ b/src/imports/testlib/signalspy.qdoc @@ -41,7 +41,7 @@ /*! \qmlclass SignalSpy SignalSpy - \brief The SignalSpy item enables introspection of signal emission. + \brief Enables introspection of signal emission \since 4.8 \ingroup qtest::qml diff --git a/src/imports/testlib/testcase.qdoc b/src/imports/testlib/testcase.qdoc index 29f7a2d287..3f47c237e2 100644 --- a/src/imports/testlib/testcase.qdoc +++ b/src/imports/testlib/testcase.qdoc @@ -41,7 +41,7 @@ /*! \qmlclass TestCase TestCase - \brief The TestCase item represents a unit test case. + \brief Represents a unit test case \since 4.8 \ingroup qtest::qml diff --git a/src/imports/xmllistmodel/qqmlxmllistmodel.cpp b/src/imports/xmllistmodel/qqmlxmllistmodel.cpp index e95fd26f79..221fdaea42 100644 --- a/src/imports/xmllistmodel/qqmlxmllistmodel.cpp +++ b/src/imports/xmllistmodel/qqmlxmllistmodel.cpp @@ -72,7 +72,7 @@ typedef QPair<int, int> QQuickXmlListRange; \qmlclass XmlRole QQuickXmlListModelRole \inqmlmodule QtQuick 2 \ingroup qml-working-with-data - \brief The XmlRole element allows you to specify a role for an XmlListModel. + \brief For specifying a role to an XmlListModel \sa {QtQml} */ @@ -597,7 +597,7 @@ void QQuickXmlListModelPrivate::clear_role(QQmlListProperty<QQuickXmlListModelRo \qmlclass XmlListModel QQuickXmlListModel \inqmlmodule QtQuick 2 \ingroup qml-working-with-data - \brief The XmlListModel element is used to specify a read-only model using XPath expressions. + \brief For specifying a read-only model using XPath expressions To use this element, you will need to import the module with the following line: diff --git a/src/particles/qquickage.cpp b/src/particles/qquickage.cpp index 9f24cba3cc..c69f33acc8 100644 --- a/src/particles/qquickage.cpp +++ b/src/particles/qquickage.cpp @@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE \qmlclass Age QQuickAgeAffector \inqmlmodule QtQuick.Particles 2 \inherits Affector - \brief The Age affector allows you to prematurely age particles + \brief For altering particle ages The Age affector allows you to alter where the particle is in its lifecycle. Common uses are to expire particles prematurely, possibly giving them time to animate out. diff --git a/src/particles/qquickangledirection.cpp b/src/particles/qquickangledirection.cpp index e77c47362c..e30984e50f 100644 --- a/src/particles/qquickangledirection.cpp +++ b/src/particles/qquickangledirection.cpp @@ -51,7 +51,7 @@ const qreal CONV = 0.017453292519943295; \qmlclass AngleDirection QQuickAngleDirection \inqmlmodule QtQuick.Particles 2 \inherits Direction - \brief The AngleDirection element allows you to specify a direction that varies in angle + \brief For specifying a direction that varies in angle The AngledDirection element allows both the specification of a direction by angle and magnitude, as well as varying the parameters by angle or magnitude. diff --git a/src/particles/qquickcumulativedirection.cpp b/src/particles/qquickcumulativedirection.cpp index d7c4094297..c187251343 100644 --- a/src/particles/qquickcumulativedirection.cpp +++ b/src/particles/qquickcumulativedirection.cpp @@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE \qmlclass CumulativeDirection QQuickCumulativeDirection \inqmlmodule QtQuick.Particles 2 \inherits Direction - \brief The CumulativeDirection element allows you to specify a direction made of other directions + \brief For specifying a direction made of other directions The CumulativeDirection element will act as a direction that sums the directions within it. */ diff --git a/src/particles/qquickcustomparticle.cpp b/src/particles/qquickcustomparticle.cpp index 7d27e48c6b..798a00c54d 100644 --- a/src/particles/qquickcustomparticle.cpp +++ b/src/particles/qquickcustomparticle.cpp @@ -124,7 +124,7 @@ struct PlainVertices { \qmlclass CustomParticle QQuickCustomParticle \inqmlmodule QtQuick.Particles 2 \inherits ParticlePainter - \brief The CustomParticle element allows you to specify your own shader to paint particles. + \brief For specifying shaders to paint particles */ diff --git a/src/particles/qquickdirection.cpp b/src/particles/qquickdirection.cpp index 4127d06be0..aa45c12c88 100644 --- a/src/particles/qquickdirection.cpp +++ b/src/particles/qquickdirection.cpp @@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE /*! \qmlclass Direction QQuickDirection \inqmlmodule QtQuick.Particles 2 - \brief The Direction elements allow you to specify a vector space. + \brief For specifying a vector space */ diff --git a/src/particles/qquickellipseextruder.cpp b/src/particles/qquickellipseextruder.cpp index 083564e5cb..d7feccba4a 100644 --- a/src/particles/qquickellipseextruder.cpp +++ b/src/particles/qquickellipseextruder.cpp @@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE \qmlclass EllipseShape QQuickEllipseExtruder \inqmlmodule QtQuick.Particles 2 \inherits Shape - \brief The EllipseShape represents an ellipse to other particle system elements + \brief Represents an ellipse to other particle system elements This shape can be used by Emitter subclasses and Affector subclasses to have them act upon an ellipse shaped area. diff --git a/src/particles/qquickfriction.cpp b/src/particles/qquickfriction.cpp index d37d109f48..465c70ae1e 100644 --- a/src/particles/qquickfriction.cpp +++ b/src/particles/qquickfriction.cpp @@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE \qmlclass Friction QQuickFrictionAffector \inqmlmodule QtQuick.Particles 2 \inherits Affector - \brief The Friction affector slows down movement proportional to the particle's current speed. + \brief For applying friction proportional to the particle's current speed */ diff --git a/src/particles/qquickgravity.cpp b/src/particles/qquickgravity.cpp index cf4f35eb72..ae68f32f7d 100644 --- a/src/particles/qquickgravity.cpp +++ b/src/particles/qquickgravity.cpp @@ -47,7 +47,7 @@ const qreal CONV = 0.017453292520444443; \qmlclass Gravity QQuickGravityAffector \inqmlmodule QtQuick.Particles 2 \inherits Affector - \brief The Gravity element allows you to set an accleration in an angle + \brief For applying accleration in an angle This element will accelerate all affected particles to a vector of the specified magnitude in the specified angle. If the angle and acceleration do diff --git a/src/particles/qquickgroupgoal.cpp b/src/particles/qquickgroupgoal.cpp index 0d7f15a9e1..614a2f8c64 100644 --- a/src/particles/qquickgroupgoal.cpp +++ b/src/particles/qquickgroupgoal.cpp @@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE \qmlclass GroupGoal QQuickGroupGoalAffector \inqmlmodule QtQuick.Particles 2 \inherits Affector - \brief The GroupGoal Affector allows you to change the state of a group of a particle. + \brief For changing the state of a group of a particle */ /*! diff --git a/src/particles/qquickimageparticle.cpp b/src/particles/qquickimageparticle.cpp index 80420ee4c2..d83d2f8d60 100644 --- a/src/particles/qquickimageparticle.cpp +++ b/src/particles/qquickimageparticle.cpp @@ -587,7 +587,7 @@ void fillUniformArrayFromImage(float* array, const QImage& img, int size) \qmlclass ImageParticle QQuickImageParticle \inqmlmodule QtQuick.Particles 2 \inherits ParticlePainter - \brief The ImageParticle element visualizes logical particles using an image + \brief For visualizing logical particles using an image This element renders a logical particle as an image. The image can be \list diff --git a/src/particles/qquickitemparticle.cpp b/src/particles/qquickitemparticle.cpp index 91ef06fcb2..d347ca07f1 100644 --- a/src/particles/qquickitemparticle.cpp +++ b/src/particles/qquickitemparticle.cpp @@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE \qmlclass ItemParticle QQuickItemParticle \inqmlmodule QtQuick.Particles 2 \inherits ParticlePainter - \brief The ItemParticle element allows you to specify your own delegate to paint particles. + \brief For specifying a delegate to paint particles */ diff --git a/src/particles/qquicklineextruder.cpp b/src/particles/qquicklineextruder.cpp index f555de3f72..4cefa386bd 100644 --- a/src/particles/qquicklineextruder.cpp +++ b/src/particles/qquicklineextruder.cpp @@ -46,7 +46,7 @@ \qmlclass LineShape QQuickLineExtruder \inqmlmodule QtQuick.Particles 2 \inherits Shape - \brief The LineShape represents a line to Affectors and Emitter + \brief Represents a line for affectors and emitters */ diff --git a/src/particles/qquickmaskextruder.cpp b/src/particles/qquickmaskextruder.cpp index 161a60ca8f..d294c6d04b 100644 --- a/src/particles/qquickmaskextruder.cpp +++ b/src/particles/qquickmaskextruder.cpp @@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE \qmlclass MaskShape QQuickMaskExtruder \inqmlmodule QtQuick.Particles 2 \inherits Shape - \brief The MaskShape element allows you to represent an image as a shape to affectors and emitters. + \brief For representing an image as a shape to affectors and emitters */ /*! diff --git a/src/particles/qquickparticleaffector.cpp b/src/particles/qquickparticleaffector.cpp index e2be8771d4..f0a4874b5d 100644 --- a/src/particles/qquickparticleaffector.cpp +++ b/src/particles/qquickparticleaffector.cpp @@ -47,7 +47,8 @@ QT_BEGIN_NAMESPACE /*! \qmlclass Affector QQuickParticleAffector \inqmlmodule QtQuick.Particles 2 - \brief Affector elements can alter the attributes of logical particles at any point in their lifetime. + \brief Applies alterations to the attributes of logical particles at any + point in their lifetime The base Affector does not alter any attributes, but can be used to emit a signal when a particle meets certain conditions. diff --git a/src/particles/qquickparticleemitter.cpp b/src/particles/qquickparticleemitter.cpp index 8181e8b4f1..23364a2c25 100644 --- a/src/particles/qquickparticleemitter.cpp +++ b/src/particles/qquickparticleemitter.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE /*! \qmlclass Emitter QQuickParticleEmitter \inqmlmodule QtQuick.Particles 2 - \brief The Emitter element allows you to emit logical particles. + \brief Emits logical particles This element emits logical particles into the ParticleSystem, with the given starting attributes. diff --git a/src/particles/qquickparticleextruder.cpp b/src/particles/qquickparticleextruder.cpp index 279f7c05f3..6a28a3ddd5 100644 --- a/src/particles/qquickparticleextruder.cpp +++ b/src/particles/qquickparticleextruder.cpp @@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE /*! \qmlclass Shape QQuickParticleExtruder \inqmlmodule QtQuick.Particles 2 - \brief The Shape element allows you to specify an area for affectors and emitter. + \brief For specifying an area for affectors and emitters The base class is just a rectangle. */ diff --git a/src/particles/qquickparticlegroup.cpp b/src/particles/qquickparticlegroup.cpp index 9a165074a1..e6e217982a 100644 --- a/src/particles/qquickparticlegroup.cpp +++ b/src/particles/qquickparticlegroup.cpp @@ -44,7 +44,7 @@ /*! \qmlclass ParticleGroup QQuickParticleGroup \inqmlmodule QtQuick.Particles 2 - \brief ParticleGroup elements allow you to set attributes on a logical particle group. + \brief For setting attributes on a logical particle group This element allows you to set timed transitions on particle groups. diff --git a/src/particles/qquickparticlepainter.cpp b/src/particles/qquickparticlepainter.cpp index e490b70240..3c4d5982ca 100644 --- a/src/particles/qquickparticlepainter.cpp +++ b/src/particles/qquickparticlepainter.cpp @@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE \qmlclass ParticlePainter QQuickParticlePainter \inqmlmodule QtQuick.Particles 2 \inherits ParticlePainter - \brief ParticlePainter elements allow you to specify how to paint particles. + \brief For specifying how to paint particles The default implementation paints nothing. See the subclasses if you want to paint something visible. diff --git a/src/particles/qquickparticlesystem.cpp b/src/particles/qquickparticlesystem.cpp index 4fd6108f2f..f5a25ffbee 100644 --- a/src/particles/qquickparticlesystem.cpp +++ b/src/particles/qquickparticlesystem.cpp @@ -103,7 +103,7 @@ DEFINE_BOOL_CONFIG_OPTION(qmlParticlesDebug, QML_PARTICLES_DEBUG) /*! \qmlclass ParticleSystem QQuickParticleSystem \inqmlmodule QtQuick.Particles 2 - \brief The ParticleSystem brings together ParticlePainter, Emitter and Affector elements. + \brief A system which includes particle painter, emitter, and affector types */ diff --git a/src/particles/qquickpointattractor.cpp b/src/particles/qquickpointattractor.cpp index a54ee41c1e..ce6fb1887c 100644 --- a/src/particles/qquickpointattractor.cpp +++ b/src/particles/qquickpointattractor.cpp @@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE \qmlclass Attractor QQuickAttractorAffector \inqmlmodule QtQuick.Particles 2 \inherits Affector - \brief The Attractor allows you to attract particles towards a specific point. + \brief For attracting particles towards a specific point Note that the size and position of this element affects which particles it affects. The size of the point attracted to is always 0x0, and the location of that point diff --git a/src/particles/qquickpointdirection.cpp b/src/particles/qquickpointdirection.cpp index e35eb4854c..8106a6445d 100644 --- a/src/particles/qquickpointdirection.cpp +++ b/src/particles/qquickpointdirection.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \qmlclass PointDirection QQuickPointDirection \inqmlmodule QtQuick.Particles 2 \inherits Direction - \brief The PointDirection element allows you to specify a direction that varies in x and y components + \brief For specifying a direction that varies in x and y components The PointDirection element allows both the specification of a direction by x and y components, as well as varying the parameters by x or y component. diff --git a/src/particles/qquickrectangleextruder.cpp b/src/particles/qquickrectangleextruder.cpp index ad2207ca9a..9d95dcce63 100644 --- a/src/particles/qquickrectangleextruder.cpp +++ b/src/particles/qquickrectangleextruder.cpp @@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE /*! \qmlclass RectangleShape QQuickRectangleExtruder \inqmlmodule QtQuick.Particles 2 - \brief The RectangleShape element allows you to specify an area for affectors and emitter. + \brief For specifying an area for affectors and emitter Just a rectangle. */ diff --git a/src/particles/qquickspritegoal.cpp b/src/particles/qquickspritegoal.cpp index 95d913cafa..7b58bece76 100644 --- a/src/particles/qquickspritegoal.cpp +++ b/src/particles/qquickspritegoal.cpp @@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE \qmlclass SpriteGoal QQuickSpriteGoalAffector \inqmlmodule QtQuick.Particles 2 \inherits Affector - \brief The SpriteGoal Affector allows you to change the state of a sprite particle. + \brief For changing the the state of a sprite particle */ /*! diff --git a/src/particles/qquicktargetdirection.cpp b/src/particles/qquicktargetdirection.cpp index 695684dfde..086149191e 100644 --- a/src/particles/qquicktargetdirection.cpp +++ b/src/particles/qquicktargetdirection.cpp @@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE \qmlclass TargetDirection QQuickTargetDirection \inqmlmodule QtQuick.Particles 2 \inherits Direction - \brief The TargetDirection element allows you to specify a direction towards the target point + \brief For specifying a direction towards the target point */ /*! diff --git a/src/particles/qquicktrailemitter.cpp b/src/particles/qquicktrailemitter.cpp index 3ea68ce681..cd202f6ed9 100644 --- a/src/particles/qquicktrailemitter.cpp +++ b/src/particles/qquicktrailemitter.cpp @@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE \qmlclass TrailEmitter QQuickTrailEmitter \inqmlmodule QtQuick.Particles 2 \inherits QQuickParticleEmitter - \brief The TrailEmitter element allows you to emit logical particles from other logical particles. + \brief Emits logical particles from other logical particles This element emits logical particles into the ParticleSystem, with the starting positions based on those of other logical particles. diff --git a/src/particles/qquickturbulence.cpp b/src/particles/qquickturbulence.cpp index 18ecc6a4cd..dac67df031 100644 --- a/src/particles/qquickturbulence.cpp +++ b/src/particles/qquickturbulence.cpp @@ -50,7 +50,7 @@ QT_BEGIN_NAMESPACE \qmlclass Turbulence QQuickTurbulenceAffector \inqmlmodule QtQuick.Particles 2 \inherits Affector - \brief Turbulence provides fluid like forces based on a noise image. + \brief Provides fluid-like forces from a noise image The Turbulence Element scales the noise source over the area it affects, and uses the curl of that source to generate force vectors. diff --git a/src/particles/qquickv8particledata.cpp b/src/particles/qquickv8particledata.cpp index 8e50e41091..8cbbcabf3a 100644 --- a/src/particles/qquickv8particledata.cpp +++ b/src/particles/qquickv8particledata.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE /*! \qmlclass Particle \inqmlmodule QtQuick.Particles 2 - \brief Particle elements can be manipulated in custom emitters and affectors. + \brief Represents particles manipulated by emitters and affectors Particle elements are always managed internally by the ParticleSystem and cannot be created in QML. However, sometimes they are exposed via signals so as to allow arbitrary changes to the particle state diff --git a/src/particles/qquickwander.cpp b/src/particles/qquickwander.cpp index 0f9a5f069b..8d2556d4b1 100644 --- a/src/particles/qquickwander.cpp +++ b/src/particles/qquickwander.cpp @@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE \qmlclass Wander QQuickWanderAffector \inqmlmodule QtQuick.Particles 2 \inherits Affector - \brief The Wander affector allows particles to randomly vary their trajectory. + \brief For applying random particle trajectory */ /*! diff --git a/src/qml/doc/src/types/qmldate.qdoc b/src/qml/doc/src/types/qmldate.qdoc index 3931aa6e45..802f977503 100644 --- a/src/qml/doc/src/types/qmldate.qdoc +++ b/src/qml/doc/src/types/qmldate.qdoc @@ -28,7 +28,7 @@ /*! \qmlclass Date \inqmlmodule QtQuick 2 - \brief The Date object provides date functions + \brief Provides date functions The QML Date object extends the JS Date object with locale aware functions. diff --git a/src/qml/qml/qqmlcomponent.cpp b/src/qml/qml/qqmlcomponent.cpp index f82f1d281e..1ade6988f7 100644 --- a/src/qml/qml/qqmlcomponent.cpp +++ b/src/qml/qml/qqmlcomponent.cpp @@ -112,10 +112,11 @@ static inline QString buildTypeNameForDebug(const QMetaObject *metaObject) /*! \class QQmlComponent \since 5.0 - \brief The QQmlComponent class encapsulates a QML component definition. \inmodule QtQml \mainclass + \brief The QQmlComponent class encapsulates a QML component definition + Components are reusable, encapsulated QML elements with well-defined interfaces. They are often defined in \l {qdeclarativedocuments.html}{Component Files}. @@ -190,7 +191,8 @@ static inline QString buildTypeNameForDebug(const QMetaObject *metaObject) \qmlclass Component QQmlComponent \ingroup qml-utility-elements \since 4.7 - \brief The Component element encapsulates a QML component definition. + \inqmlmodule QtQuick 2 + \brief Encapsulates a QML component definition Components are reusable, encapsulated QML elements with well-defined interfaces. diff --git a/src/qml/qml/qqmlengine.cpp b/src/qml/qml/qqmlengine.cpp index e3fc083914..4a3e30793c 100644 --- a/src/qml/qml/qqmlengine.cpp +++ b/src/qml/qml/qqmlengine.cpp @@ -109,9 +109,10 @@ void qmlRegisterBaseTypes(const char *uri, int versionMajor, int versionMinor) /*! \qmlclass QtObject QObject + \inqmlmodule QtQuick 2 \ingroup qml-utility-elements \since 4.7 - \brief The QtObject element is the most basic element in QML. + \brief A basic QML type The QtObject element is a non-visual element which contains only the objectName property. diff --git a/src/qml/qml/qqmllocale.cpp b/src/qml/qml/qqmllocale.cpp index 0371d0ea0a..7d2dafe3b3 100644 --- a/src/qml/qml/qqmllocale.cpp +++ b/src/qml/qml/qqmllocale.cpp @@ -748,7 +748,7 @@ V8_DEFINE_EXTENSION(QV8LocaleDataDeletable, localeV8Data); /*! \qmlclass Locale QQmlLocale \inqmlmodule QtQuick 2 - \brief The Locale object provides locale specific properties and formatted data. + \brief Provides locale specific properties and formatted data The Locale object may only be created via the \l{QML:Qt::locale()}{Qt.locale()} function. It cannot be created directly. diff --git a/src/qml/qml/qquicklistmodel.cpp b/src/qml/qml/qquicklistmodel.cpp index 15b39b2cb4..389394652a 100644 --- a/src/qml/qml/qquicklistmodel.cpp +++ b/src/qml/qml/qquicklistmodel.cpp @@ -1357,7 +1357,7 @@ QQuickListModelParser::ListInstruction *QQuickListModelParser::ListModelData::in \qmlclass ListModel QQuickListModel \inqmlmodule QtQuick 2 \ingroup qml-working-with-data - \brief The ListModel element defines a free-form list data source. + \brief Defines a free-form list data source The ListModel is a simple container of ListElement definitions, each containing data roles. The contents can be defined dynamically, or explicitly in QML. @@ -2428,7 +2428,7 @@ bool QQuickListModelParser::definesEmptyList(const QString &s) \qmlclass ListElement QQuickListElement \inqmlmodule QtQuick 2 \ingroup qml-working-with-data - \brief The ListElement element defines a data item in a ListModel. + \brief Defines a data item in a ListModel List elements are defined inside ListModel definitions, and represent items in a list that will be displayed using ListView or \l Repeater items. diff --git a/src/qml/qml/qquickworkerscript.cpp b/src/qml/qml/qquickworkerscript.cpp index 03433124d0..81ebb1fed4 100644 --- a/src/qml/qml/qquickworkerscript.cpp +++ b/src/qml/qml/qquickworkerscript.cpp @@ -562,7 +562,8 @@ void QQuickWorkerScriptEngine::run() /*! \qmlclass WorkerScript QQuickWorkerScript \ingroup qml-utility-elements - \brief The WorkerScript element enables the use of threads in QML. + \inqmlmodule QtQuick 2 + \brief Enables the use of threads in QML Use WorkerScript to run operations in a new thread. This is useful for running operations in the background so diff --git a/src/quick/doc/qtquick.qdocconf b/src/quick/doc/qtquick.qdocconf index 551bf926b7..8b0f9a43b3 100644 --- a/src/quick/doc/qtquick.qdocconf +++ b/src/quick/doc/qtquick.qdocconf @@ -96,3 +96,7 @@ exampledirs += ../../qml/snippets \ ../../qml imagedirs += ../../qml + +#add particles sources +headerdirs += ../../particles +sourcedirs += ../../particles diff --git a/src/quick/doc/src/particles/particles.qdoc b/src/quick/doc/src/particles/particles.qdoc index d2806bac5a..2f5432b39a 100644 --- a/src/quick/doc/src/particles/particles.qdoc +++ b/src/quick/doc/src/particles/particles.qdoc @@ -29,14 +29,14 @@ \qmlmodule QtQuick.Particles 2 \title QML Module QtQuick.Particles 2 - \brief Elements for the Qt Quick particle system + \brief Contains types for particle effects - This QML module contains a particle system for Qt Quick. To use these elements, you will need to import the module with the following line: + This QML module contains a particle system for Qt Quick. To use these types, import the module with the following line: \code import QtQuick.Particles 2.0 \endcode - For a simple overview of how the system can be used, see \l{qml-particlesystem.html}{Using the Qt Quick Particle System}. + For a simple overview of how the system can be used, see \l{Using the Qt Quick Particle System}. For details on the performance characteristics see \l{qml-particlesystem-performance.html}{Qt Quick Particle System Performance}. diff --git a/src/quick/doc/src/qtquick2.qdoc b/src/quick/doc/src/qtquick2.qdoc index 20361adb16..93f564025d 100644 --- a/src/quick/doc/src/qtquick2.qdoc +++ b/src/quick/doc/src/qtquick2.qdoc @@ -29,10 +29,10 @@ \qmlmodule QtQuick 2 \title QML Module QtQuick 2 - \brief The QML Elements + \brief Contains QML types for creating applications - This QML module contains all the QML elements that are + This QML module contains all the QML types that are instantiated as objects of C++ classes in the QtQml - module. These elements work with the Scenegraph renderer and + module. These types work with the Scenegraph renderer and their own canvas. */ diff --git a/src/quick/items/context2d/qquickcanvasitem.cpp b/src/quick/items/context2d/qquickcanvasitem.cpp index 41f4ff4d1b..7d2a85cb35 100644 --- a/src/quick/items/context2d/qquickcanvasitem.cpp +++ b/src/quick/items/context2d/qquickcanvasitem.cpp @@ -138,7 +138,7 @@ QQuickCanvasItemPrivate::~QQuickCanvasItemPrivate() \qmlclass Canvas QQuickCanvasItem \inqmlmodule QtQuick 2 \since QtQuick 2.0 - \brief The Canvas item provides a 2D canvas element which enables drawing via Javascript. + \brief For specifying a 2D canvas element which enables drawing via Javascript \inherits Item \ingroup qml-basic-visual-elements diff --git a/src/quick/items/context2d/qquickcontext2d.cpp b/src/quick/items/context2d/qquickcontext2d.cpp index 0e29492d5b..ec457fa242 100644 --- a/src/quick/items/context2d/qquickcontext2d.cpp +++ b/src/quick/items/context2d/qquickcontext2d.cpp @@ -71,8 +71,7 @@ QT_BEGIN_NAMESPACE \qmlclass Context2D QQuickContext2D \inqmlmodule QtQuick 2 \since QtQuick 2.0 - \brief The Context2D API allows you to draw 2d graphic shapes on the \c - Canvas item. + \brief Provides 2D context for shapes on a Canvas item The Context2D object can be created by \c Canvas item's \c getContext() method: @@ -2188,10 +2187,11 @@ static v8::Handle<v8::Value> ctx2d_strokeText(const v8::Arguments &args) return args.This(); } /*! - \qmlclass QtQuick2::TextMetrics + \qmlclass TextMetrics \inqmlmodule QtQuick 2 \since QtQuick 2.0 - \brief The Context2D TextMetrics interface. + \brief Provides a Context2D TextMetrics interface + The TextMetrics object can be created by QtQuick2::Context2D::measureText method. See {http://www.w3.org/TR/2dcontext/#textmetrics}{W3C 2d context TexMetrics} for more details. @@ -2380,7 +2380,10 @@ static v8::Handle<v8::Value> ctx2d_drawImage(const v8::Arguments &args) // pixel manipulation /*! - \qmlclass QtQuick2::CanvasImageData + \qmlclass CanvasImageData + \inqmlmodule QtQuick 2 + \brief Contains image pixel data in RGBA order + The \a QtQuick2::CanvasImageData object holds the image pixel data. The \a QtQuick2::CanvasImageData object has the actual dimensions of the data stored in @@ -2429,7 +2432,10 @@ v8::Handle<v8::Value> ctx2d_imageData_data(v8::Local<v8::String>, const v8::Acce } /*! - \qmlclass QtQuick2::CanvasPixelArray + \qmlclass CanvasPixelArray + \inqmlmodule QtQuick 2 + \brief Provides ordered and indexed access to the components of each pixel in image data + The CanvasPixelArray object provides ordered, indexed access to the color components of each pixel of the image data. The CanvasPixelArray can be accessed as normal Javascript array. \sa QtQuick2::CanvasImageData @@ -2664,10 +2670,10 @@ static v8::Handle<v8::Value> ctx2d_putImageData(const v8::Arguments &args) } /*! - \qmlclass QtQuick2::CanvasGradient + \qmlclass CanvasGradient \inqmlmodule QtQuick 2 \since QtQuick 2.0 - \brief The Context2D opaque CanvasGradient interface. + \brief Provides an opaque CanvasGradient interface */ /*! diff --git a/src/quick/items/qquickaccessibleattached.cpp b/src/quick/items/qquickaccessibleattached.cpp index 27efebca0c..0ab96c184b 100644 --- a/src/quick/items/qquickaccessibleattached.cpp +++ b/src/quick/items/qquickaccessibleattached.cpp @@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE /*! \qmlclass Accessible QQuickAccessibleAttached - \brief Attached property to enable accessibility of QML items. + \brief Enables accessibility of QML items \inqmlmodule QtQuick 2 \ingroup qml-basic-interaction-elements diff --git a/src/quick/items/qquickanimatedimage.cpp b/src/quick/items/qquickanimatedimage.cpp index 1c1c253513..4fd7b99190 100644 --- a/src/quick/items/qquickanimatedimage.cpp +++ b/src/quick/items/qquickanimatedimage.cpp @@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick 2 \inherits Image \ingroup basic-visual-elements + \brief Plays animations stored as a series of images The AnimatedImage element extends the features of the \l Image element, providing a way to play animations stored as images containing a series of frames, diff --git a/src/quick/items/qquickanimatedsprite.cpp b/src/quick/items/qquickanimatedsprite.cpp index 8d89c22fa6..0e370202cf 100644 --- a/src/quick/items/qquickanimatedsprite.cpp +++ b/src/quick/items/qquickanimatedsprite.cpp @@ -210,7 +210,7 @@ struct AnimatedSpriteVertices { \qmlclass AnimatedSprite QQuickAnimatedSprite \inqmlmodule QtQuick 2 \inherits Item - \brief The AnimatedSprite element draws a sprite animation + \brief Draws a sprite animation AnimatedSprite provides rendering and control over animations which are provided as multiple frames in the same image file. You can play it at a fixed speed, at the diff --git a/src/quick/items/qquickborderimage.cpp b/src/quick/items/qquickborderimage.cpp index 5b48a6fc85..9c3992792e 100644 --- a/src/quick/items/qquickborderimage.cpp +++ b/src/quick/items/qquickborderimage.cpp @@ -57,7 +57,7 @@ QT_BEGIN_NAMESPACE /*! \qmlclass BorderImage QQuickBorderImage \inqmlmodule QtQuick 2 - \brief The BorderImage element provides an image that can be used as a border. + \brief For specifying an image that can be used as a border \inherits Item \ingroup qml-basic-visual-elements diff --git a/src/quick/items/qquickcanvas.cpp b/src/quick/items/qquickcanvas.cpp index c3aecce372..b538dba99a 100644 --- a/src/quick/items/qquickcanvas.cpp +++ b/src/quick/items/qquickcanvas.cpp @@ -746,7 +746,7 @@ void QQuickCanvasPrivate::cleanup(QSGNode *n) /*! \qmlclass Window QQuickCanvas \inqmlmodule QtQuick.Window 2 - \brief The Window object creates a new top-level window. + \brief Creates a new top-level window The Window object creates a new top-level window for a QtQuick scene. It automatically sets up the window for use with QtQuick 2.0 graphical elements. diff --git a/src/quick/items/qquickdrag.cpp b/src/quick/items/qquickdrag.cpp index 0aee026533..ca7b716ef2 100644 --- a/src/quick/items/qquickdrag.cpp +++ b/src/quick/items/qquickdrag.cpp @@ -92,7 +92,7 @@ public: /*! \qmlclass Drag QQuickDrag \inqmlmodule QtQuick 2 - \brief The Drag attached property provides drag and drop events for moved Items. + \brief For specifying drag and drop events for moved Items Using the Drag attached property any Item can made a source of drag and drop events within a scene. diff --git a/src/quick/items/qquickdroparea.cpp b/src/quick/items/qquickdroparea.cpp index 053a133609..368ba39a98 100644 --- a/src/quick/items/qquickdroparea.cpp +++ b/src/quick/items/qquickdroparea.cpp @@ -91,7 +91,7 @@ QQuickDropAreaPrivate::~QQuickDropAreaPrivate() /*! \qmlclass DropArea QQuickDropArea \inqmlmodule QtQuick 2 - \brief The DropArea item provides drag and drop handling. + \brief For specifying drag and drop handling in an area A DropArea is an invisible item which receives events when other items are dragged over it. @@ -326,7 +326,7 @@ void QQuickDropArea::dropEvent(QDropEvent *event) /*! \qmlclass DragEvent QQuickDragEvent \inqmlmodule QtQuick 2 - \brief The DragEvent object provides information about a drag event. + \brief Provides information about a drag event The position of the drag event can be obtained from the \l x and \l y properties, and the \l keys property identifies the drag keys of the event diff --git a/src/quick/items/qquickevents.cpp b/src/quick/items/qquickevents.cpp index bf58e4411d..3053e1e280 100644 --- a/src/quick/items/qquickevents.cpp +++ b/src/quick/items/qquickevents.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick 2 \ingroup qml-event-elements - \brief The KeyEvent object provides information about a key event. + \brief Provides information about a key event For example, the following changes the Item's state property when the Enter key is pressed: @@ -143,7 +143,7 @@ Item { \inqmlmodule QtQuick 2 \ingroup qml-event-elements - \brief The MouseEvent object provides information about a mouse event. + \brief Provides information about a mouse event The position of the mouse can be found via the \l x and \l y properties. The button that caused the event is available via the \l button property. @@ -241,7 +241,7 @@ Item { \inqmlmodule QtQuick 2 \ingroup qml-event-elements - \brief The WheelEvent object provides information about a mouse wheel event. + \brief Provides information about a mouse wheel event The position of the mouse can be found via the \l x and \l y properties. diff --git a/src/quick/items/qquickflickable.cpp b/src/quick/items/qquickflickable.cpp index e4e0799d89..ba61ca4972 100644 --- a/src/quick/items/qquickflickable.cpp +++ b/src/quick/items/qquickflickable.cpp @@ -506,7 +506,7 @@ is finished. \inqmlmodule QtQuick 2 \ingroup qml-basic-interaction-elements - \brief The Flickable item provides a surface that can be "flicked". + \brief For specifying a surface that can be "flicked" \inherits Item The Flickable item places its children on a surface that can be dragged diff --git a/src/quick/items/qquickflipable.cpp b/src/quick/items/qquickflipable.cpp index 39e5765a7a..0231e84cf7 100644 --- a/src/quick/items/qquickflipable.cpp +++ b/src/quick/items/qquickflipable.cpp @@ -91,7 +91,7 @@ public: \qmlclass Flipable QQuickFlipable \inqmlmodule QtQuick 2 \ingroup qml-basic-interaction-elements - \brief The Flipable item provides a surface that can be flipped. + \brief For specifying a surface that can be flipped \inherits Item Flipable is an item that can be visibly "flipped" between its front and diff --git a/src/quick/items/qquickfocusscope.cpp b/src/quick/items/qquickfocusscope.cpp index 7ef2476b30..3a8c1aaae1 100644 --- a/src/quick/items/qquickfocusscope.cpp +++ b/src/quick/items/qquickfocusscope.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick 2 \ingroup qml-basic-interaction-elements - \brief The FocusScope object explicitly creates a focus scope. + \brief Explicitly creates a focus scope \inherits Item Focus scopes assist in keyboard focus handling when building reusable QML diff --git a/src/quick/items/qquickgridview.cpp b/src/quick/items/qquickgridview.cpp index 1be285bcf6..d7fa0ed5d4 100644 --- a/src/quick/items/qquickgridview.cpp +++ b/src/quick/items/qquickgridview.cpp @@ -1153,7 +1153,7 @@ void QQuickGridViewPrivate::flick(AxisData &data, qreal minExtent, qreal maxExte \ingroup qml-view-elements \inherits Flickable - \brief The GridView item provides a grid view of items provided by a model. + \brief For specifying a grid view of items provided by a model A GridView displays data from models created from built-in QML elements like ListModel and XmlListModel, or custom model classes defined in C++ that inherit from diff --git a/src/quick/items/qquickimage.cpp b/src/quick/items/qquickimage.cpp index cc4a95ddde..8331d14d0a 100644 --- a/src/quick/items/qquickimage.cpp +++ b/src/quick/items/qquickimage.cpp @@ -99,7 +99,7 @@ QQuickImagePrivate::QQuickImagePrivate() \qmlclass Image QQuickImage \inqmlmodule QtQuick 2 \ingroup qml-basic-visual-elements - \brief The Image element displays an image in a declarative user interface + \brief Displays an image in a declarative user interface \inherits Item The Image element is used to display images in a declarative user interface. diff --git a/src/quick/items/qquickitem.cpp b/src/quick/items/qquickitem.cpp index e83fee3583..47bfc98b13 100644 --- a/src/quick/items/qquickitem.cpp +++ b/src/quick/items/qquickitem.cpp @@ -130,7 +130,7 @@ void QQuickItemPrivate::registerAccessorProperties() \qmlclass Transform QQuickTransform \inqmlmodule QtQuick 2 \ingroup qml-transform-elements - \brief The Transform elements provide a way of building advanced transformations on Items. + \brief For specifying advanced transformations on Items The Transform element is a base type which cannot be instantiated directly. The following concrete Transform types are available: @@ -152,7 +152,7 @@ void QQuickItemPrivate::registerAccessorProperties() \qmlclass Translate QQuickTranslate \inqmlmodule QtQuick 2 \ingroup qml-transform-elements - \brief The Translate object provides a way to move an Item without changing its x or y properties. + \brief Provides a way to move an Item without changing its x or y properties The Translate object provides independent control over position in addition to the Item's x and y properties. @@ -194,7 +194,7 @@ void QQuickItemPrivate::registerAccessorProperties() \qmlclass Scale QQuickScale \inqmlmodule QtQuick 2 \ingroup qml-transform-elements - \brief The Scale element provides a way to scale an Item. + \brief Provides a way to scale an Item The Scale element gives more control over scaling than using \l Item's \l{Item::scale}{scale} property. Specifically, it allows a different scale for the x and y axes, and allows the scale to be relative to an @@ -236,7 +236,7 @@ void QQuickItemPrivate::registerAccessorProperties() \qmlclass Rotation QQuickRotation \inqmlmodule QtQuick 2 \ingroup qml-transform-elements - \brief The Rotation object provides a way to rotate an Item. + \brief Provides a way to rotate an Item The Rotation object gives more control over rotation than using \l Item's \l{Item::rotation}{rotation} property. Specifically, it allows (z axis) rotation to be relative to an arbitrary point. @@ -504,7 +504,7 @@ void QQuickItemKeyFilter::componentComplete() \qmlclass KeyNavigation QQuickKeyNavigationAttached \inqmlmodule QtQuick 2 \ingroup qml-basic-interaction-elements - \brief The KeyNavigation attached property supports key navigation by arrow keys. + \brief Supports key navigation by arrow keys Key-based user interfaces commonly allow the use of arrow keys to navigate between focusable items. The KeyNavigation attached property enables this behavior by providing a @@ -920,7 +920,7 @@ bool QQuickKeysAttached::isConnected(const char *signalName) \qmlclass Keys QQuickKeysAttached \inqmlmodule QtQuick 2 \ingroup qml-basic-interaction-elements - \brief The Keys attached property provides key handling to Items. + \brief Provides key handling to Items All visual primitives support key handling via the Keys attached property. Keys can be handled via the onPressed @@ -1466,7 +1466,7 @@ QQuickKeysAttached *QQuickKeysAttached::qmlAttachedProperties(QObject *obj) \qmlclass LayoutMirroring QQuickLayoutMirroringAttached \inqmlmodule QtQuick 2 \ingroup qml-utility-elements - \brief The LayoutMirroring attached property is used to mirror layout behavior. + \brief Property used to mirror layout behavior The LayoutMirroring attached property is used to horizontally mirror \l {anchor-layout}{Item anchors}, \l{Using QML Positioner and Repeater Items}{positioner} elements (such as \l Row and \l Grid) @@ -1674,7 +1674,7 @@ void QQuickItemPrivate::updateSubFocusItem(QQuickItem *scope, bool focus) /*! \class QQuickItem - \brief The QQuickItem class provides the most basic of all visual items in QML. + \brief Provides the most basic of all visual items in QML \inmodule QtQuick @@ -1724,7 +1724,7 @@ void QQuickItemPrivate::updateSubFocusItem(QQuickItem *scope, bool focus) \inherits QtObject \inqmlmodule QtQuick 2 \ingroup qml-basic-visual-elements - \brief The Item is the most basic of all visual items in QML. + \brief A basic visual QML type All visual items in Qt Quick inherit from Item. Although Item has no visual appearance, it defines all the properties that are @@ -2742,7 +2742,7 @@ void QQuickItemPrivate::transform_clear(QQmlListProperty<QQuickTransform> *prop) /*! \property QQuickItem::childrenRect - \brief The geometry of an item's children. + \brief Specifies the geometry of an item's children This property holds the (collective) position and size of the item's children. */ @@ -2961,7 +2961,7 @@ void QQuickItemPrivate::transform_clear(QQmlListProperty<QQuickTransform> *prop) /*! \property QQuickItem::baselineOffset - \brief The position of the item's baseline in local coordinates. + \brief Speciifies the position of the item's baseline in local coordinates The baseline of a \l Text item is the imaginary line on which the text sits. Controls containing text usually set their baseline to the @@ -4468,7 +4468,7 @@ void QQuickItemPrivate::itemChange(QQuickItem::ItemChange change, const QQuickIt /*! \property QQuickItem::smooth - \brief whether the item is smoothed or not. + \brief Specifies whether the item is smoothed or not Primarily used in image based elements to decide if the item should use smooth sampling or not. Smooth sampling is performed using linear interpolation, while diff --git a/src/quick/items/qquickitemanimation.cpp b/src/quick/items/qquickitemanimation.cpp index dec8e1151e..35a46eee96 100644 --- a/src/quick/items/qquickitemanimation.cpp +++ b/src/quick/items/qquickitemanimation.cpp @@ -60,7 +60,7 @@ QT_BEGIN_NAMESPACE \ingroup qml-animation-transition \since QtQuick 2.0 \inherits Animation - \brief The ParentAnimation element animates changes in parent values. + \brief Animates changes in parent values ParentAnimation is used to animate a parent change for an \l Item. @@ -418,7 +418,7 @@ QAbstractAnimationJob* QQuickParentAnimation::transition(QQuickStateActions &act \inqmlmodule QtQuick 2 \ingroup qml-animation-transition \inherits Animation - \brief The AnchorAnimation element animates changes in anchor values. + \brief Animates changes in anchor values AnchorAnimation is used to animate an anchor change. @@ -491,7 +491,7 @@ void QQuickAnchorAnimation::setDuration(int duration) \qmlproperty real QtQuick2::AnchorAnimation::easing.amplitude \qmlproperty real QtQuick2::AnchorAnimation::easing.overshoot \qmlproperty real QtQuick2::AnchorAnimation::easing.period - \brief the easing curve used for the animation. + \brief Specifies the easing curve used for the animation To specify an easing curve you need to specify at least the type. For some curves you can also specify amplitude, period and/or overshoot. The default easing curve is @@ -562,7 +562,7 @@ QAbstractAnimationJob* QQuickAnchorAnimation::transition(QQuickStateActions &act \ingroup qml-animation-transition \inherits Animation \since QtQuick 2.0 - \brief The PathAnimation element animates an item along a path. + \brief Animates an item along a path When used in a transition, the path can be specified without start or end points, for example: diff --git a/src/quick/items/qquickitemviewtransition.cpp b/src/quick/items/qquickitemviewtransition.cpp index 954a0f6dfa..aec4de43b6 100644 --- a/src/quick/items/qquickitemviewtransition.cpp +++ b/src/quick/items/qquickitemviewtransition.cpp @@ -569,7 +569,7 @@ QQuickViewTransitionAttached::QQuickViewTransitionAttached(QObject *parent) \qmlclass ViewTransition QQuickViewTransitionAttached \inqmlmodule QtQuick 2 \ingroup qml-view-elements - \brief The ViewTransition attached property provides details on items under transition in a view. + \brief Specifies items under transition in a view With ListView and GridView, it is possible to specify transitions that should be applied whenever the items in the view change as a result of modifications to the view's model. They both have the diff --git a/src/quick/items/qquicklistview.cpp b/src/quick/items/qquicklistview.cpp index a7f267a969..09abd63830 100644 --- a/src/quick/items/qquicklistview.cpp +++ b/src/quick/items/qquicklistview.cpp @@ -1645,7 +1645,7 @@ void QQuickListViewPrivate::flick(AxisData &data, qreal minExtent, qreal maxExte \inqmlmodule QtQuick 2 \ingroup qml-view-elements \inherits Flickable - \brief The ListView item provides a list view of items provided by a model. + \brief Provides a list view of items provided by a model A ListView displays data from models created from built-in QML elements like ListModel and XmlListModel, or custom model classes defined in C++ that inherit from diff --git a/src/quick/items/qquickloader.cpp b/src/quick/items/qquickloader.cpp index fdc3db9fb7..2cde9effdc 100644 --- a/src/quick/items/qquickloader.cpp +++ b/src/quick/items/qquickloader.cpp @@ -158,8 +158,7 @@ qreal QQuickLoaderPrivate::getImplicitHeight() const \ingroup qml-utility-elements \inherits Item - \brief The Loader item allows dynamically loading an Item-based - subtree from a URL or Component. + \brief Allows dynamical loading of an item-based subtree from a URL or Component Loader is used to dynamically load visual QML components. For loading non-visual components, see \l {Dynamic Object Management in QML}. diff --git a/src/quick/items/qquickmousearea.cpp b/src/quick/items/qquickmousearea.cpp index 1d768a531a..0ef19633df 100644 --- a/src/quick/items/qquickmousearea.cpp +++ b/src/quick/items/qquickmousearea.cpp @@ -312,7 +312,7 @@ bool QQuickMouseAreaPrivate::propagateHelper(QQuickMouseEvent *ev, QQuickItem *i \qmlclass MouseArea QQuickMouseArea \inqmlmodule QtQuick 2 \ingroup qml-basic-interaction-elements - \brief The MouseArea item enables simple mouse handling. + \brief Enables simple mouse handling \inherits Item A MouseArea is an invisible item that is typically used in conjunction with diff --git a/src/quick/items/qquickmultipointtoucharea.cpp b/src/quick/items/qquickmultipointtoucharea.cpp index b35ca83423..369a0691ba 100644 --- a/src/quick/items/qquickmultipointtoucharea.cpp +++ b/src/quick/items/qquickmultipointtoucharea.cpp @@ -56,7 +56,7 @@ DEFINE_BOOL_CONFIG_OPTION(qmlVisualTouchDebugging, QML_VISUAL_TOUCH_DEBUGGING) \qmlclass TouchPoint QQuickTouchPoint \inqmlmodule QtQuick 2 \ingroup qml-event-elements - \brief The TouchPoint element describes a touch point in a MultiPointTouchArea. + \brief Describes a touch point in a MultiPointTouchArea The TouchPoint element contains information about a touch point, such as the current position, pressure, and area. @@ -224,7 +224,7 @@ void QQuickTouchPoint::setSceneY(qreal sceneY) /*! \qmlclass MultiPointTouchArea QQuickMultiPointTouchArea \inqmlmodule QtQuick 2 - \brief The MultiPointTouchArea item enables handling of multiple touch points. + \brief Enables handling of multiple touch points \inherits Item A MultiPointTouchArea is an invisible item that is used to track multiple touch points. diff --git a/src/quick/items/qquickpathview.cpp b/src/quick/items/qquickpathview.cpp index 18c8cee349..fa281cb245 100644 --- a/src/quick/items/qquickpathview.cpp +++ b/src/quick/items/qquickpathview.cpp @@ -441,7 +441,7 @@ void QQuickPathViewPrivate::regenerate() \qmlclass PathView QQuickPathView \inqmlmodule QtQuick 2 \ingroup qml-view-elements - \brief The PathView element lays out model-provided items on a path. + \brief Lays out model-provided items on a path \inherits Item A PathView displays data from models created from built-in QML elements like ListModel diff --git a/src/quick/items/qquickpincharea.cpp b/src/quick/items/qquickpincharea.cpp index ba0a429c87..59cfeaaad1 100644 --- a/src/quick/items/qquickpincharea.cpp +++ b/src/quick/items/qquickpincharea.cpp @@ -55,7 +55,7 @@ QT_BEGIN_NAMESPACE \qmlclass PinchEvent QQuickPinchEvent \inqmlmodule QtQuick 2 \ingroup qml-event-elements - \brief The PinchEvent object provides information about a pinch event. + \brief For specifying information about a pinch event \b {The PinchEvent element was added in QtQuick 1.1} @@ -163,7 +163,7 @@ QQuickPinchAreaPrivate::~QQuickPinchAreaPrivate() /*! \qmlclass PinchArea QQuickPinchArea \inqmlmodule QtQuick 2 - \brief The PinchArea item enables simple pinch gesture handling. + \brief Enables simple pinch gesture handling \inherits Item \b {The PinchArea element was added in QtQuick 1.1} diff --git a/src/quick/items/qquickpositioners.cpp b/src/quick/items/qquickpositioners.cpp index a51cb86c29..52450b181d 100644 --- a/src/quick/items/qquickpositioners.cpp +++ b/src/quick/items/qquickpositioners.cpp @@ -135,7 +135,7 @@ QQuickBasePositioner::QQuickBasePositioner(PositionerType at, QQuickItem *parent /*! \internal \class QQuickBasePositioner - \brief The QQuickBasePositioner class provides a base for QQuickGraphics layouts. + \brief For specifying a base for QQuickGraphics layouts To create a QQuickGraphics Positioner, simply subclass QQuickBasePositioner and implement doLayout(), which is automatically called when the layout might need @@ -496,7 +496,7 @@ void QQuickBasePositioner::updateAttachedProperties(QQuickPositionerAttached *sp \qmlclass Positioner QQuickPositionerAttached \inqmlmodule QtQuick 2 \ingroup qml-positioning-elements - \brief The Positioner type provides attached properties that contain details on where an item exists in a positioner. + \brief Provides attached properties that contain details on where an item exists in a positioner Positioner is an attached property that is attached to the top-level child item within a Column, Row, Flow or Grid. It provides properties that allow a child item to determine @@ -578,7 +578,7 @@ void QQuickPositionerAttached::setIsLastItem(bool isLastItem) \qmlclass Column QQuickColumn \inqmlmodule QtQuick 2 \ingroup qml-positioning-elements - \brief The Column element positions its children in a column. + \brief Positions its children in a column \inherits Item Column is an element that positions its child items along a single column. @@ -746,7 +746,7 @@ void QQuickColumn::reportConflictingAnchors() \qmlclass Row QQuickRow \inqmlmodule QtQuick 2 \ingroup qml-positioning-elements - \brief The Row element positions its children in a row. + \brief Positions its children in a row \inherits Item Row is an element that positions its child items along a single row. @@ -977,7 +977,7 @@ void QQuickRow::reportConflictingAnchors() \qmlclass Grid QQuickGrid \inqmlmodule QtQuick 2 \ingroup qml-positioning-elements - \brief The Grid element positions its children in grid formation. + \brief Positions its children in grid formation \inherits Item Grid is an element that positions its child items in grid formation. @@ -1418,7 +1418,7 @@ void QQuickGrid::reportConflictingAnchors() \qmlclass Flow QQuickFlow \inqmlmodule QtQuick 2 \ingroup qml-positioning-elements - \brief The Flow element positions its children side by side, wrapping as necessary. + \brief Positions its children side by side, wrapping as necessary \inherits Item The Flow item positions its child items like words on a page, wrapping them diff --git a/src/quick/items/qquickrectangle.cpp b/src/quick/items/qquickrectangle.cpp index a3948f1041..b5a03e88af 100644 --- a/src/quick/items/qquickrectangle.cpp +++ b/src/quick/items/qquickrectangle.cpp @@ -55,7 +55,7 @@ QT_BEGIN_NAMESPACE /*! \internal \class QQuickPen - \brief The QQuickPen class provides a pen used for drawing rectangle borders on a QQuickView. + \brief For specifying a pen used for drawing rectangle borders on a QQuickView By default, the pen is invalid and nothing is drawn. You must either set a color (then the default width is 1) or a width (then the default color is black). @@ -130,7 +130,7 @@ bool QQuickPen::isValid() const \qmlclass GradientStop QQuickGradientStop \inqmlmodule QtQuick 2 \ingroup qml-basic-visual-elements - \brief The GradientStop item defines the color at a position in a Gradient. + \brief Defines the color at a position in a Gradient \sa Gradient */ @@ -181,7 +181,7 @@ void QQuickGradientStop::updateGradient() \qmlclass Gradient QQuickGradient \inqmlmodule QtQuick 2 \ingroup qml-basic-visual-elements - \brief The Gradient item defines a gradient fill. + \brief Defines a gradient fill A gradient is defined by two or more colors, which will be blended seamlessly. @@ -280,7 +280,7 @@ int QQuickRectanglePrivate::doUpdateSlotIdx = -1; \qmlclass Rectangle QQuickRectangle \inqmlmodule QtQuick 2 \ingroup qml-basic-visual-elements - \brief The Rectangle item provides a filled rectangle with an optional border. + \brief Describes a filled rectangle with an optional border \inherits Item Rectangle items are used to fill areas with solid color or gradients, and are diff --git a/src/quick/items/qquickrepeater.cpp b/src/quick/items/qquickrepeater.cpp index 97ab386841..ec8dc9d231 100644 --- a/src/quick/items/qquickrepeater.cpp +++ b/src/quick/items/qquickrepeater.cpp @@ -66,8 +66,7 @@ QQuickRepeaterPrivate::~QQuickRepeaterPrivate() \inqmlmodule QtQuick 2 \ingroup qml-utility-elements \inherits Item - - \brief The Repeater element allows you to repeat an Item-based component using a model. + \brief Specifies how to repeately create an Item-based component using a model The Repeater element is used to create a large number of similar items. Like other view elements, a Repeater has a \l model and a \l delegate: diff --git a/src/quick/items/qquickshadereffect.cpp b/src/quick/items/qquickshadereffect.cpp index 952ecef75f..0bf119f28e 100644 --- a/src/quick/items/qquickshadereffect.cpp +++ b/src/quick/items/qquickshadereffect.cpp @@ -534,7 +534,7 @@ void QQuickShaderEffectCommon::propertyChanged(QQuickItem *item, int mappedId, \qmlclass ShaderEffect QQuickShaderEffect \inqmlmodule QtQuick 2 \ingroup qml-basic-visual-elements - \brief The ShaderEffect element applies custom shaders to a rectangle. + \brief Applies custom shaders to a rectangle \inherits Item The ShaderEffect element applies a custom OpenGL diff --git a/src/quick/items/qquickshadereffectmesh.cpp b/src/quick/items/qquickshadereffectmesh.cpp index 582e1ce92f..1d3f0d7bc2 100644 --- a/src/quick/items/qquickshadereffectmesh.cpp +++ b/src/quick/items/qquickshadereffectmesh.cpp @@ -54,7 +54,7 @@ QQuickShaderEffectMesh::QQuickShaderEffectMesh(QObject *parent) \qmlclass GridMesh QQuickGridMesh \inqmlmodule QtQuick 2 \ingroup qml-utility-elements - \brief GridMesh defines a mesh with vertices arranged in a grid. + \brief Defines a mesh with vertices arranged in a grid GridMesh defines a rectangular mesh consisting of vertices arranged in an evenly spaced grid. It is used to generate \l{QSGGeometry}{geometry}. diff --git a/src/quick/items/qquickshadereffectsource.cpp b/src/quick/items/qquickshadereffectsource.cpp index 4513263ed3..1864acc2da 100644 --- a/src/quick/items/qquickshadereffectsource.cpp +++ b/src/quick/items/qquickshadereffectsource.cpp @@ -456,8 +456,7 @@ QImage QQuickShaderEffectTexture::toImage() const \qmlclass ShaderEffectSource QQuickShaderEffectSource \since 5.0 \ingroup qml-basic-visual-elements - \brief The ShaderEffectSource element renders a QML element into a texture - and displays it. + \brief Renders a QML element into a texture and displays it \inherits Item The ShaderEffectSource element renders \l sourceItem into a texture and diff --git a/src/quick/items/qquicksprite.cpp b/src/quick/items/qquicksprite.cpp index 8b77d23270..25d77d2e29 100644 --- a/src/quick/items/qquicksprite.cpp +++ b/src/quick/items/qquicksprite.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE /*! \qmlclass Sprite QQuickSprite \inqmlmodule QtQuick 2 - \brief The Sprite element represents a sprite animation + \brief Specifies sprite animations QQuickSprite renders sprites of one or more frames and animates them. The sprites can be in the middle of an image file, or split along multiple rows, as long as they form diff --git a/src/quick/items/qquickspritesequence.cpp b/src/quick/items/qquickspritesequence.cpp index 28849ac82c..1e31735b0d 100644 --- a/src/quick/items/qquickspritesequence.cpp +++ b/src/quick/items/qquickspritesequence.cpp @@ -209,7 +209,7 @@ struct SpriteVertices { \qmlclass SpriteSequence QQuickSpriteSequence \inqmlmodule QtQuick 2 \inherits Item - \brief The SpriteSequence element draws a sprite animation + \brief Draws a sprite animation SpriteSequence renders and controls a list of animations defined by \l Sprite elements. diff --git a/src/quick/items/qquickstateoperations.cpp b/src/quick/items/qquickstateoperations.cpp index 1985da8deb..b6b055c359 100644 --- a/src/quick/items/qquickstateoperations.cpp +++ b/src/quick/items/qquickstateoperations.cpp @@ -150,7 +150,7 @@ void QQuickParentChangePrivate::doChange(QQuickItem *targetParent, QQuickItem *s \qmlclass ParentChange QQuickParentChange \inqmlmodule QtQuick 2 \ingroup qml-state-elements - \brief The ParentChange element allows you to reparent an Item in a state change. + \brief Specifies how to reparent an Item in a state change ParentChange reparents an item while preserving its visual appearance (position, size, rotation, and scale) on screen. You can then specify a transition to move/resize/rotate/scale @@ -561,7 +561,7 @@ void QQuickParentChange::rewind() \qmlclass AnchorChanges QQuickAnchorChanges \inqmlmodule QtQuick 2 \ingroup qml-state-elements - \brief The AnchorChanges element allows you to change the anchors of an item in a state. + \brief Specifies how to change the anchors of an item in a state The AnchorChanges element is used to modify the anchors of an item in a \l State. diff --git a/src/quick/items/qquicktext.cpp b/src/quick/items/qquicktext.cpp index b61d329e5f..642409e84a 100644 --- a/src/quick/items/qquicktext.cpp +++ b/src/quick/items/qquicktext.cpp @@ -1140,7 +1140,7 @@ void QQuickTextPrivate::ensureDoc() \qmlclass Text QQuickText \inqmlmodule QtQuick 2 \ingroup qml-basic-visual-elements - \brief The Text item allows you to add formatted text to a scene. + \brief Specifies how to add formatted text to a scene \inherits Item Text items can display both plain and rich text. For example, red text with diff --git a/src/quick/items/qquicktextedit.cpp b/src/quick/items/qquicktextedit.cpp index a3dd772718..de5cff217d 100644 --- a/src/quick/items/qquicktextedit.cpp +++ b/src/quick/items/qquicktextedit.cpp @@ -68,7 +68,7 @@ QT_BEGIN_NAMESPACE \qmlclass TextEdit QQuickTextEdit \inqmlmodule QtQuick 2 \ingroup qml-basic-visual-elements - \brief The TextEdit item displays multiple lines of editable formatted text. + \brief Displays multiple lines of editable formatted text \inherits Item The TextEdit item displays a block of editable, formatted text. diff --git a/src/quick/items/qquicktextinput.cpp b/src/quick/items/qquicktextinput.cpp index 3e92568db3..06a572681a 100644 --- a/src/quick/items/qquicktextinput.cpp +++ b/src/quick/items/qquicktextinput.cpp @@ -69,8 +69,8 @@ DEFINE_BOOL_CONFIG_OPTION(qmlDisableDistanceField, QML_DISABLE_DISTANCEFIELD) \qmlclass TextInput QQuickTextInput \inqmlmodule QtQuick 2 \ingroup qml-basic-visual-elements - \brief The TextInput item displays an editable line of text. \inherits Item + \brief Displays an editable line of text The TextInput element displays a single line of editable plain text. @@ -845,6 +845,7 @@ void QQuickTextInput::setAutoScroll(bool b) \qmlclass IntValidator QIntValidator \inqmlmodule QtQuick 2 \ingroup qml-basic-visual-elements + \brief Defines a validator for integer values This element provides a validator for integer values. @@ -907,6 +908,7 @@ void QQuickIntValidator::resetLocaleName() \qmlclass DoubleValidator QDoubleValidator \inqmlmodule QtQuick 2 \ingroup qml-basic-visual-elements + \brief Defines a validator for non-integer numbers This element provides a validator for non-integer numbers. @@ -999,6 +1001,7 @@ void QQuickDoubleValidator::resetLocaleName() \qmlclass RegExpValidator QRegExpValidator \inqmlmodule QtQuick 2 \ingroup qml-basic-visual-elements + \brief Provides a string validator This element provides a validator, which counts as valid any string which matches a specified regular expression. diff --git a/src/quick/items/qquickvisualdatamodel.cpp b/src/quick/items/qquickvisualdatamodel.cpp index d202c61112..0b0dbf0afb 100644 --- a/src/quick/items/qquickvisualdatamodel.cpp +++ b/src/quick/items/qquickvisualdatamodel.cpp @@ -81,7 +81,7 @@ QQuickVisualDataModelParts::QQuickVisualDataModelParts(QQuickVisualDataModel *pa \qmlclass VisualDataModel QQuickVisualDataModel \inqmlmodule QtQuick 2 \ingroup qml-working-with-data - \brief The VisualDataModel encapsulates a model and delegate + \brief Encapsulates a model and delegate A VisualDataModel encapsulates a model and the delegate that will be instantiated for items in the model. @@ -2026,7 +2026,7 @@ void QQuickVisualDataGroupPrivate::destroyingPackage(QQuickPackage *package) \qmlclass VisualDataGroup QQuickVisualDataGroup \inqmlmodule QtQuick 2 \ingroup qml-working-with-data - \brief The VisualDataGroup encapsulates a filtered set of visual data items. + \brief Encapsulates a filtered set of visual data items */ diff --git a/src/quick/items/qquickvisualitemmodel.cpp b/src/quick/items/qquickvisualitemmodel.cpp index b1fce55d7d..df274e1d42 100644 --- a/src/quick/items/qquickvisualitemmodel.cpp +++ b/src/quick/items/qquickvisualitemmodel.cpp @@ -120,7 +120,7 @@ public: \qmlclass VisualItemModel QQuickVisualItemModel \inqmlmodule QtQuick 2 \ingroup qml-working-with-data - \brief The VisualItemModel allows items to be provided to a view. + \brief Defines items to be used added to a view A VisualItemModel contains the visual items to be used in a view. When a VisualItemModel is used in a view, the view does not require diff --git a/src/quick/util/qquickanimation.cpp b/src/quick/util/qquickanimation.cpp index 4544df23fa..c04018c794 100644 --- a/src/quick/util/qquickanimation.cpp +++ b/src/quick/util/qquickanimation.cpp @@ -73,7 +73,7 @@ QT_BEGIN_NAMESPACE \qmlclass Animation QQuickAbstractAnimation \inqmlmodule QtQuick 2 \ingroup qml-animation-transition - \brief The Animation element is the base of all QML animations. + \brief Is the base of all QML animations The Animation element cannot be used directly in a QML file. It exists to provide a set of common properties and methods, available across all the @@ -442,7 +442,7 @@ void QQuickAbstractAnimation::setGroup(QQuickAnimationGroup *g) /*! \qmlmethod QtQuick2::Animation::start() - \brief Starts the animation. + \brief Starts the animation If the animation is already running, calling this method has no effect. The \c running property will be true following a call to \c start(). @@ -454,7 +454,7 @@ void QQuickAbstractAnimation::start() /*! \qmlmethod QtQuick2::Animation::pause() - \brief Pauses the animation. + \brief Pauses the animation If the animation is already paused or not \c running, calling this method has no effect. The \c paused property will be true following a call to \c pause(). @@ -466,7 +466,7 @@ void QQuickAbstractAnimation::pause() /*! \qmlmethod QtQuick2::Animation::resume() - \brief Resumes a paused animation. + \brief Resumes a paused animation If the animation is not paused or not \c running, calling this method has no effect. The \c paused property will be false following a call to \c resume(). @@ -478,7 +478,7 @@ void QQuickAbstractAnimation::resume() /*! \qmlmethod QtQuick2::Animation::stop() - \brief Stops the animation. + \brief Stops the animation If the animation is not running, calling this method has no effect. Both the \c running and \c paused properties will be false following a call to \c stop(). @@ -503,7 +503,7 @@ void QQuickAbstractAnimation::stop() /*! \qmlmethod QtQuick2::Animation::restart() - \brief Restarts the animation. + \brief Restarts the animation This is a convenience method, and is equivalent to calling \c stop() and then \c start(). @@ -516,7 +516,7 @@ void QQuickAbstractAnimation::restart() /*! \qmlmethod QtQuick2::Animation::complete() - \brief Stops the animation, jumping to the final property values. + \brief Stops the animation, jumping to the final property values If the animation is not running, calling this method has no effect. The \c running property will be false following a call to \c complete(). @@ -618,7 +618,7 @@ void QQuickAbstractAnimationPrivate::animationFinished(QAbstractAnimationJob*) \inqmlmodule QtQuick 2 \ingroup qml-animation-transition \inherits Animation - \brief The PauseAnimation element provides a pause for an animation. + \brief Provides a pause for an animation When used in a SequentialAnimation, PauseAnimation is a step when nothing happens, for a specified duration. @@ -686,9 +686,9 @@ QAbstractAnimationJob* QQuickPauseAnimation::transition(QQuickStateActions &acti /*! \qmlclass ColorAnimation QQuickColorAnimation \inqmlmodule QtQuick 2 - \ingroup qml-animation-transition + \ingroup qml-animation-transition \inherits PropertyAnimation - \brief The ColorAnimation element animates changes in color values. + \brief Animates changes in color values ColorAnimation is a specialized PropertyAnimation that defines an animation to be applied when a color value changes. @@ -832,7 +832,7 @@ void QActionAnimation::updateState(State newState, State oldState) \inqmlmodule QtQuick 2 \ingroup qml-animation-transition \inherits Animation - \brief The ScriptAction element allows scripts to be run during an animation. + \brief Defines scripts to be run during an animation ScriptAction can be used to run a script at a specific point in an animation. @@ -958,7 +958,7 @@ QAbstractAnimationJob* QQuickScriptAction::transition(QQuickStateActions &action \inqmlmodule QtQuick 2 \ingroup qml-animation-transition \inherits Animation - \brief The PropertyAction element allows immediate property changes during animation. + \brief Specifies immediate property changes during animation PropertyAction is used to specify an immediate property change during an animation. The property change is not animated. @@ -1210,7 +1210,7 @@ QAbstractAnimationJob* QQuickPropertyAction::transition(QQuickStateActions &acti \inqmlmodule QtQuick 2 \ingroup qml-animation-transition \inherits PropertyAnimation - \brief The NumberAnimation element animates changes in qreal-type values. + \brief Animates changes in qreal-type values NumberAnimation is a specialized PropertyAnimation that defines an animation to be applied when a numerical value changes. @@ -1322,7 +1322,7 @@ void QQuickNumberAnimation::setTo(qreal t) \inqmlmodule QtQuick 2 \ingroup qml-animation-transition \inherits PropertyAnimation - \brief The Vector3dAnimation element animates changes in QVector3d values. + \brief Animates changes in QVector3d values Vector3dAnimation is a specialized PropertyAnimation that defines an animation to be applied when a Vector3d value changes. @@ -1398,7 +1398,7 @@ void QQuickVector3dAnimation::setTo(QVector3D t) \inqmlmodule QtQuick 2 \ingroup qml-animation-transition \inherits PropertyAnimation - \brief The RotationAnimation element animates changes in rotation values. + \brief Animates changes in rotation values RotationAnimation is a specialized PropertyAnimation that gives control over the direction of rotation during an animation. @@ -1634,7 +1634,7 @@ QQmlListProperty<QQuickAbstractAnimation> QQuickAnimationGroup::animations() \inqmlmodule QtQuick 2 \ingroup qml-animation-transition \inherits Animation - \brief The SequentialAnimation element allows animations to be run sequentially. + \brief Allows animations to be run sequentially The SequentialAnimation and ParallelAnimation elements allow multiple animations to be run together. Animations defined in a SequentialAnimation @@ -1706,7 +1706,7 @@ QAbstractAnimationJob* QQuickSequentialAnimation::transition(QQuickStateActions \inqmlmodule QtQuick 2 \ingroup qml-animation-transition \inherits Animation - \brief The ParallelAnimation element allows animations to be run in parallel. + \brief Enables animations to be run in parallel The SequentialAnimation and ParallelAnimation elements allow multiple animations to be run together. Animations defined in a SequentialAnimation @@ -1831,7 +1831,7 @@ void QQuickBulkValueAnimator::topLevelAnimationLoopChanged() \inqmlmodule QtQuick 2 \ingroup qml-animation-transition \inherits Animation - \brief The PropertyAnimation element animates changes in property values. + \brief Animates changes in property values PropertyAnimation provides a way to animate changes to a property's value. @@ -1988,7 +1988,7 @@ void QQuickPropertyAnimation::setTo(const QVariant &t) \qmlproperty real QtQuick2::PropertyAnimation::easing.overshoot \qmlproperty real QtQuick2::PropertyAnimation::easing.period \qmlproperty list<real> QtQuick2::PropertyAnimation::easing.bezierCurve - \brief the easing curve used for the animation. + \brief Specifies the easing curve used for the animation To specify an easing curve you need to specify at least the type. For some curves you can also specify amplitude, period and/or overshoot (more details provided after the table). The default easing curve is diff --git a/src/quick/util/qquickanimationcontroller.cpp b/src/quick/util/qquickanimationcontroller.cpp index 52a58339a6..3013127500 100644 --- a/src/quick/util/qquickanimationcontroller.cpp +++ b/src/quick/util/qquickanimationcontroller.cpp @@ -95,7 +95,7 @@ void QQuickAnimationControllerPrivate::animationCurrentTimeChanged(QAbstractAnim \qmlclass AnimationController QQuickAnimationController \inqmlmodule QtQuick 2 \ingroup qml-animation-transition - \brief The AnimationController element allows you to control animations manually. + \brief Enables manual control of animations Normally animations are driven by an internal timer, but the AnimationController allows the given \a animation to be driven by a \a progress value explicitly. @@ -185,7 +185,7 @@ void QQuickAnimationController::setAnimation(QQuickAbstractAnimation *animation) /*! \qmlmethod QtQuick2::AnimationController::reload() - \brief Reloads the animation properties. + \brief Reloads the animation properties If the animation properties changed, calling this method to reload the animation definations. */ diff --git a/src/quick/util/qquickbehavior.cpp b/src/quick/util/qquickbehavior.cpp index 93e64ecdbc..d201dfad66 100644 --- a/src/quick/util/qquickbehavior.cpp +++ b/src/quick/util/qquickbehavior.cpp @@ -76,7 +76,7 @@ public: \qmlclass Behavior QQuickBehavior \inqmlmodule QtQuick 2 \ingroup qml-animation-transition - \brief The Behavior element allows you to specify a default animation for a property change. + \brief Defines a default animation for a property change A Behavior defines the default animation to be applied whenever a particular property value changes. diff --git a/src/quick/util/qquickbind.cpp b/src/quick/util/qquickbind.cpp index e298632edd..622965de23 100644 --- a/src/quick/util/qquickbind.cpp +++ b/src/quick/util/qquickbind.cpp @@ -78,7 +78,7 @@ public: \qmlclass Binding QQuickBind \inqmlmodule QtQuick 2 \ingroup qml-working-with-data - \brief The Binding element allows arbitrary property bindings to be created. + \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 934c59bc0f..bbc7a8dec8 100644 --- a/src/quick/util/qquickconnections.cpp +++ b/src/quick/util/qquickconnections.cpp @@ -74,7 +74,7 @@ public: \qmlclass Connections QQuickConnections \inqmlmodule QtQuick 2 \ingroup qml-utility-elements - \brief A Connections element describes generalized connections to signals. + \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 dfdad9ec14..e2863776f5 100644 --- a/src/quick/util/qquickfontloader.cpp +++ b/src/quick/util/qquickfontloader.cpp @@ -149,7 +149,7 @@ QHash<QUrl, QQuickFontObject*> QQuickFontLoaderPrivate::fonts; \qmlclass FontLoader QQuickFontLoader \inqmlmodule QtQuick 2 \ingroup qml-utility-elements - \brief The FontLoader element allows fonts to be loaded by name or URL. + \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/qquickpackage.cpp b/src/quick/util/qquickpackage.cpp index 1939de62e1..94e4fe5428 100644 --- a/src/quick/util/qquickpackage.cpp +++ b/src/quick/util/qquickpackage.cpp @@ -50,7 +50,7 @@ QT_BEGIN_NAMESPACE \qmlclass Package QQuickPackage \inqmlmodule QtQuick 2 \ingroup qml-working-with-data - \brief Package provides a collection of named items. + \brief Specifies a collection of named items The Package class is used in conjunction with VisualDataModel to enable delegates with a shared context diff --git a/src/quick/util/qquickpath.cpp b/src/quick/util/qquickpath.cpp index c4c5bf6dfe..32dd9cca88 100644 --- a/src/quick/util/qquickpath.cpp +++ b/src/quick/util/qquickpath.cpp @@ -56,7 +56,7 @@ QT_BEGIN_NAMESPACE \qmlclass PathElement QQuickPathElement \inqmlmodule QtQuick 2 \ingroup qml-view-elements - \brief PathElement is the base path type. + \brief PathElement is the base path type This type is the base for all path types. It cannot be instantiated. @@ -68,7 +68,7 @@ QT_BEGIN_NAMESPACE \qmlclass Path QQuickPath \inqmlmodule QtQuick 2 \ingroup qml-view-elements - \brief A Path object defines a path for use by \l PathView. + \brief Defines a path for use by \l PathView A Path is composed of one or more path segments - PathLine, PathQuad, PathCubic, PathArc, PathCurve, PathSvg. @@ -806,7 +806,7 @@ bool QQuickCurve::hasRelativeY() \qmlclass PathAttribute QQuickPathAttribute \inqmlmodule QtQuick 2 \ingroup qml-view-elements - \brief The PathAttribute allows setting an attribute at a given position in a Path. + \brief Specifies how to set an attribute at a given position in a Path The PathAttribute object allows attributes consisting of a name and a value to be specified for various points along a path. The @@ -922,7 +922,7 @@ void QQuickPathAttribute::setValue(qreal value) \qmlclass PathLine QQuickPathLine \inqmlmodule QtQuick 2 \ingroup qml-view-elements - \brief The PathLine defines a straight line. + \brief Defines a straight line The example below creates a path consisting of a straight line from 0,100 to 200,100: @@ -980,7 +980,7 @@ void QQuickPathLine::addToPath(QPainterPath &path, const QQuickPathData &data) \qmlclass PathQuad QQuickPathQuad \inqmlmodule QtQuick 2 \ingroup qml-view-elements - \brief The PathQuad defines a quadratic Bezier curve with a control point. + \brief Defines a quadratic Bezier curve with a control point The following QML produces the path shown below: \table @@ -1131,7 +1131,7 @@ void QQuickPathQuad::addToPath(QPainterPath &path, const QQuickPathData &data) \qmlclass PathCubic QQuickPathCubic \inqmlmodule QtQuick 2 \ingroup qml-view-elements - \brief The PathCubic defines a cubic Bezier curve with two control points. + \brief Defines a cubic Bezier curve with two control points The following QML produces the path shown below: \table @@ -1354,7 +1354,7 @@ void QQuickPathCubic::addToPath(QPainterPath &path, const QQuickPathData &data) \qmlclass PathCurve QQuickPathCurve \inqmlmodule QtQuick 2 \ingroup qml-view-elements - \brief The PathCurve defines a point on a Catmull-Rom curve. + \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. Typically multiple PathCurves are used in a series, as the following example demonstrates: @@ -1499,7 +1499,7 @@ void QQuickPathCatmullRomCurve::addToPath(QPainterPath &path, const QQuickPathDa \qmlclass PathArc QQuickPathArc \inqmlmodule QtQuick 2 \ingroup qml-view-elements - \brief The PathArc defines an arc with the given radius. + \brief Defines an arc with the given radius PathArc provides a simple way of specifying an arc that ends at a given position and uses the specified radius. It is modeled after the SVG elliptical arc command. @@ -1669,7 +1669,7 @@ void QQuickPathArc::addToPath(QPainterPath &path, const QQuickPathData &data) \qmlclass PathSvg QQuickPathSvg \inqmlmodule QtQuick 2 \ingroup qml-view-elements - \brief The PathSvg defines a path using an SVG path data string. + \brief Defines a path using an SVG path data string The following QML produces the path shown below: \table @@ -1721,7 +1721,7 @@ void QQuickPathSvg::addToPath(QPainterPath &path, const QQuickPathData &) \qmlclass PathPercent QQuickPathPercent \inqmlmodule QtQuick 2 \ingroup qml-view-elements - \brief The PathPercent manipulates the way a path is interpreted. + \brief Manipulates the way a path is interpreted PathPercent allows you to manipulate the spacing between items on a PathView's path. You can use it to bunch together items on part of diff --git a/src/quick/util/qquickpathinterpolator.cpp b/src/quick/util/qquickpathinterpolator.cpp index a02589a393..4328305cd0 100644 --- a/src/quick/util/qquickpathinterpolator.cpp +++ b/src/quick/util/qquickpathinterpolator.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE /*! \qmlclass PathInterpolator QQuickPathInterpolator \inqmlmodule QtQuick 2 - \brief The PathInterpolator element provides a way to manually animate along a path. + \brief Specifies how to manually animate along a path PathInterpolator provides \c x, \c y, and \c angle information for a particular \c progress along a path. diff --git a/src/quick/util/qquickpropertychanges.cpp b/src/quick/util/qquickpropertychanges.cpp index 4fbe5f82d5..5252f625ad 100644 --- a/src/quick/util/qquickpropertychanges.cpp +++ b/src/quick/util/qquickpropertychanges.cpp @@ -67,7 +67,7 @@ QT_BEGIN_NAMESPACE \qmlclass PropertyChanges QQuickPropertyChanges \inqmlmodule QtQuick 2 \ingroup qml-state-elements - \brief The PropertyChanges element describes new property bindings or values for a state. + \brief Describes new property bindings or values for a state PropertyChanges is used to define the property values or bindings in a \l State. This enables an item's property values to be changed when it diff --git a/src/quick/util/qquicksmoothedanimation.cpp b/src/quick/util/qquicksmoothedanimation.cpp index cb359481a4..75682152f1 100644 --- a/src/quick/util/qquicksmoothedanimation.cpp +++ b/src/quick/util/qquicksmoothedanimation.cpp @@ -311,7 +311,7 @@ void QSmoothedAnimation::init() \inqmlmodule QtQuick 2 \ingroup qml-animation-transition \inherits NumberAnimation - \brief The SmoothedAnimation element allows a property to smoothly track a value. + \brief Allows a property to smoothly track a value A SmoothedAnimation animates a property's value to a set target value using an ease in/out quad easing curve. When the target value changes, diff --git a/src/quick/util/qquickspringanimation.cpp b/src/quick/util/qquickspringanimation.cpp index ad83bf158c..1f5b15cf77 100644 --- a/src/quick/util/qquickspringanimation.cpp +++ b/src/quick/util/qquickspringanimation.cpp @@ -345,7 +345,7 @@ void QQuickSpringAnimationPrivate::updateMode() \ingroup qml-animation-transition \inherits NumberAnimation - \brief The SpringAnimation element allows a property to track a value in a spring-like motion. + \brief Allows a property to track a value in a spring-like motion SpringAnimation mimics the oscillatory behavior of a spring, with the appropriate \l spring constant to control the acceleration and the \l damping to control how quickly the effect dies away. diff --git a/src/quick/util/qquickstate.cpp b/src/quick/util/qquickstate.cpp index f41deb0054..7cbd16a51b 100644 --- a/src/quick/util/qquickstate.cpp +++ b/src/quick/util/qquickstate.cpp @@ -123,7 +123,7 @@ QQuickStateOperation::QQuickStateOperation(QObjectPrivate &dd, QObject *parent) \qmlclass State QQuickState \inqmlmodule QtQuick 2 \ingroup qml-state-elements - \brief The State element defines configurations of objects and properties. + \brief Defines configurations of objects and properties A \e state is a set of batched changes from the default configuration. diff --git a/src/quick/util/qquickstatechangescript.cpp b/src/quick/util/qquickstatechangescript.cpp index f2735353a6..4865859a91 100644 --- a/src/quick/util/qquickstatechangescript.cpp +++ b/src/quick/util/qquickstatechangescript.cpp @@ -71,7 +71,7 @@ public: \qmlclass StateChangeScript QQuickStateChangeScript \inqmlmodule QtQuick 2 \ingroup qml-state-elements - \brief The StateChangeScript element allows you to run a script in a state. + \brief Specifies how to run a script in a state A StateChangeScript is run upon entering a state. You can optionally use ScriptAction to specify the point in the transition at which diff --git a/src/quick/util/qquickstategroup.cpp b/src/quick/util/qquickstategroup.cpp index 45af0e8934..6e88ec55aa 100644 --- a/src/quick/util/qquickstategroup.cpp +++ b/src/quick/util/qquickstategroup.cpp @@ -95,7 +95,7 @@ public: \qmlclass StateGroup QQuickStateGroup \inqmlmodule QtQuick 2 \ingroup qml-state-elements - \brief The StateGroup element provides state support for non-Item elements. + \brief Provides built-in state support for non-Item elements Item (and all derived elements) provides built in support for states and transitions via its \l{Item::state}{state}, \l{Item::states}{states} and \l{Item::transitions}{transitions} properties. StateGroup provides an easy way to diff --git a/src/quick/util/qquicksystempalette.cpp b/src/quick/util/qquicksystempalette.cpp index 220d3f8c37..cf5098e8ec 100644 --- a/src/quick/util/qquicksystempalette.cpp +++ b/src/quick/util/qquicksystempalette.cpp @@ -60,7 +60,7 @@ public: \qmlclass SystemPalette QQuickSystemPalette \inqmlmodule QtQuick 2 \ingroup qml-utility-elements - \brief The SystemPalette element provides access to the Qt palettes. + \brief Provides access to the Qt palettes The SystemPalette element provides access to the Qt application palettes. This provides information about the standard colors used diff --git a/src/quick/util/qquicktimer.cpp b/src/quick/util/qquicktimer.cpp index 151f1f8b48..fff3e80202 100644 --- a/src/quick/util/qquicktimer.cpp +++ b/src/quick/util/qquicktimer.cpp @@ -76,7 +76,7 @@ public: \qmlclass Timer QQuickTimer \inqmlmodule QtQuick 2 \ingroup qml-utility-elements - \brief The Timer item triggers a handler at a specified interval. + \brief Triggers a handler at a specified interval A Timer can be used to trigger an action either once, or repeatedly at a given interval. @@ -233,7 +233,7 @@ void QQuickTimer::setTriggeredOnStart(bool triggeredOnStart) /*! \qmlmethod QtQuick2::Timer::start() - \brief Starts the timer. + \brief Starts the timer If the timer is already running, calling this method has no effect. The \c running property will be true following a call to \c start(). @@ -245,7 +245,7 @@ void QQuickTimer::start() /*! \qmlmethod QtQuick2::Timer::stop() - \brief Stops the timer. + \brief Stops the timer If the timer is not running, calling this method has no effect. The \c running property will be false following a call to \c stop(). @@ -257,7 +257,7 @@ void QQuickTimer::stop() /*! \qmlmethod QtQuick2::Timer::restart() - \brief Restarts the timer. + \brief Restarts the timer If the Timer is not running it will be started, otherwise it will be stopped, reset to initial state and started. The \c running property diff --git a/src/quick/util/qquicktransition.cpp b/src/quick/util/qquicktransition.cpp index b88584900c..edad787b6e 100644 --- a/src/quick/util/qquicktransition.cpp +++ b/src/quick/util/qquicktransition.cpp @@ -56,7 +56,7 @@ QT_BEGIN_NAMESPACE \qmlclass Transition QQuickTransition \inqmlmodule QtQuick 2 \ingroup qml-animation-transition - \brief The Transition element defines animated transitions that occur on state changes. + \brief Defines animated transitions that occur on state changes A Transition defines the animations to be applied when a \l State change occurs. |