From 6112c0f57177ee813271da54200a2d9f3ef20238 Mon Sep 17 00:00:00 2001 From: Nico Vertriest Date: Fri, 18 May 2012 15:19:55 +0200 Subject: 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 --- src/quick/util/qquickanimation.cpp | 38 ++++++++++++++-------------- src/quick/util/qquickanimationcontroller.cpp | 4 +-- src/quick/util/qquickbehavior.cpp | 2 +- src/quick/util/qquickbind.cpp | 2 +- src/quick/util/qquickconnections.cpp | 2 +- src/quick/util/qquickfontloader.cpp | 2 +- src/quick/util/qquickpackage.cpp | 2 +- src/quick/util/qquickpath.cpp | 20 +++++++-------- src/quick/util/qquickpathinterpolator.cpp | 2 +- src/quick/util/qquickpropertychanges.cpp | 2 +- src/quick/util/qquicksmoothedanimation.cpp | 2 +- src/quick/util/qquickspringanimation.cpp | 2 +- src/quick/util/qquickstate.cpp | 2 +- src/quick/util/qquickstatechangescript.cpp | 2 +- src/quick/util/qquickstategroup.cpp | 2 +- src/quick/util/qquicksystempalette.cpp | 2 +- src/quick/util/qquicktimer.cpp | 8 +++--- src/quick/util/qquicktransition.cpp | 2 +- 18 files changed, 49 insertions(+), 49 deletions(-) (limited to 'src/quick/util') 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 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 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 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. -- cgit v1.2.3