diff options
Diffstat (limited to 'src/quick')
62 files changed, 116 insertions, 116 deletions
diff --git a/src/quick/handlers/qquickdraghandler.cpp b/src/quick/handlers/qquickdraghandler.cpp index 041780257a..5e540b3615 100644 --- a/src/quick/handlers/qquickdraghandler.cpp +++ b/src/quick/handlers/qquickdraghandler.cpp @@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE \inherits SinglePointHandler \inqmlmodule Qt.labs.handlers \ingroup qtquick-handlers - \brief Handler for dragging + \brief Handler for dragging. DragHandler is a handler that is used to interactively move an Item. Like other Pointer Handlers, by default it is fully functional, and diff --git a/src/quick/handlers/qquickpinchhandler.cpp b/src/quick/handlers/qquickpinchhandler.cpp index fc69accffc..57d851ed59 100644 --- a/src/quick/handlers/qquickpinchhandler.cpp +++ b/src/quick/handlers/qquickpinchhandler.cpp @@ -58,7 +58,7 @@ Q_LOGGING_CATEGORY(lcPinchHandler, "qt.quick.handler.pinch") \inherits MultiPointHandler \inqmlmodule Qt.labs.handlers \ingroup qtquick-handlers - \brief Handler for pinch gestures + \brief Handler for pinch gestures. PinchHandler is a handler that interprets a multi-finger gesture to interactively rotate, zoom, and drag an Item. Like other Pointer Handlers, diff --git a/src/quick/handlers/qquicksinglepointhandler.cpp b/src/quick/handlers/qquicksinglepointhandler.cpp index 1a5537b732..9df20390e4 100644 --- a/src/quick/handlers/qquicksinglepointhandler.cpp +++ b/src/quick/handlers/qquicksinglepointhandler.cpp @@ -269,7 +269,7 @@ void QQuickSinglePointHandler::reset() \instantiates QQuickHandlerPoint \inqmlmodule Qt.labs.handlers \ingroup qtquick-handlers - \brief An event point + \brief An event point. A QML representation of a QQuickEventPoint. diff --git a/src/quick/items/context2d/qquickcanvasitem.cpp b/src/quick/items/context2d/qquickcanvasitem.cpp index 59917ce531..eee64c9663 100644 --- a/src/quick/items/context2d/qquickcanvasitem.cpp +++ b/src/quick/items/context2d/qquickcanvasitem.cpp @@ -213,7 +213,7 @@ QQuickCanvasItemPrivate::~QQuickCanvasItemPrivate() \inherits Item \ingroup qtquick-canvas \ingroup qtquick-visual - \brief Provides a 2D canvas item enabling drawing via JavaScript + \brief Provides a 2D canvas item enabling drawing via JavaScript. The Canvas item allows drawing of straight and curved lines, simple and complex shapes, graphs, and referenced graphic images. It can also add diff --git a/src/quick/items/context2d/qquickcontext2d.cpp b/src/quick/items/context2d/qquickcontext2d.cpp index addcf9b540..2c115f4d3c 100644 --- a/src/quick/items/context2d/qquickcontext2d.cpp +++ b/src/quick/items/context2d/qquickcontext2d.cpp @@ -95,7 +95,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick \ingroup qtquick-canvas \since 5.0 - \brief Provides 2D context for shapes on a 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: @@ -3044,7 +3044,7 @@ QV4::ReturnedValue QQuickJSContext2DPrototype::method_drawImage(const QV4::Funct \qmltype CanvasImageData \inqmlmodule QtQuick \ingroup qtquick-canvas - \brief Contains image pixel data in RGBA order + \brief Contains image pixel data in RGBA order. The CanvasImageData object holds the image pixel data. @@ -3106,7 +3106,7 @@ QV4::ReturnedValue QQuickJSContext2DImageData::method_get_data(const QV4::Functi \qmltype CanvasPixelArray \inqmlmodule QtQuick \ingroup qtquick-canvas - \brief Provides ordered and indexed access to the components of each pixel in image data + \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. @@ -3372,7 +3372,7 @@ QV4::ReturnedValue QQuickJSContext2DPrototype::method_putImageData(const QV4::Fu \inqmlmodule QtQuick \since 5.0 \ingroup qtquick-canvas - \brief Provides an opaque CanvasGradient interface + \brief Provides an opaque CanvasGradient interface. */ /*! diff --git a/src/quick/items/qquickaccessibleattached.cpp b/src/quick/items/qquickaccessibleattached.cpp index 252d6538e2..0168c3160c 100644 --- a/src/quick/items/qquickaccessibleattached.cpp +++ b/src/quick/items/qquickaccessibleattached.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype Accessible \instantiates QQuickAccessibleAttached - \brief Enables accessibility of QML items + \brief Enables accessibility of QML items. \inqmlmodule QtQuick \ingroup qtquick-visual-utility diff --git a/src/quick/items/qquickanimatedimage.cpp b/src/quick/items/qquickanimatedimage.cpp index 075c4a7d72..fe445425e7 100644 --- a/src/quick/items/qquickanimatedimage.cpp +++ b/src/quick/items/qquickanimatedimage.cpp @@ -86,7 +86,7 @@ QQuickPixmap* QQuickAnimatedImagePrivate::infoForCurrentFrame(QQmlEngine *engine \instantiates QQuickAnimatedImage \inqmlmodule QtQuick \inherits Image - \brief Plays animations stored as a series of images + \brief Plays animations stored as a series of images. \ingroup qtquick-visual The AnimatedImage type extends the features of the \l Image type, providing diff --git a/src/quick/items/qquickanimatedsprite.cpp b/src/quick/items/qquickanimatedsprite.cpp index 887c30f999..603d5a3120 100644 --- a/src/quick/items/qquickanimatedsprite.cpp +++ b/src/quick/items/qquickanimatedsprite.cpp @@ -63,7 +63,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick \inherits Item \ingroup qtquick-visual - \brief 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 4bf34f0417..d49829096f 100644 --- a/src/quick/items/qquickborderimage.cpp +++ b/src/quick/items/qquickborderimage.cpp @@ -60,7 +60,7 @@ QT_BEGIN_NAMESPACE \qmltype BorderImage \instantiates QQuickBorderImage \inqmlmodule QtQuick - \brief Paints a border based on an image + \brief Paints a border based on an image. \inherits Item \ingroup qtquick-visual diff --git a/src/quick/items/qquickdrag.cpp b/src/quick/items/qquickdrag.cpp index d377b1dad4..91f45894a0 100644 --- a/src/quick/items/qquickdrag.cpp +++ b/src/quick/items/qquickdrag.cpp @@ -123,7 +123,7 @@ public: \instantiates QQuickDrag \inqmlmodule QtQuick \ingroup qtquick-input - \brief For specifying 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 be 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 b77fb40cb1..cb87bdce76 100644 --- a/src/quick/items/qquickdroparea.cpp +++ b/src/quick/items/qquickdroparea.cpp @@ -93,7 +93,7 @@ QQuickDropAreaPrivate::~QQuickDropAreaPrivate() \instantiates QQuickDropArea \inqmlmodule QtQuick \ingroup qtquick-input - \brief For specifying drag and drop handling in an area + \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. @@ -339,7 +339,7 @@ void QQuickDropArea::dropEvent(QDropEvent *event) \instantiates QQuickDropEvent \inqmlmodule QtQuick \ingroup qtquick-input-events - \brief 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 d020ad7c4c..d4aba31e28 100644 --- a/src/quick/items/qquickevents.cpp +++ b/src/quick/items/qquickevents.cpp @@ -57,7 +57,7 @@ Q_LOGGING_CATEGORY(lcPointerGrab, "qt.quick.pointer.grab") \inqmlmodule QtQuick \ingroup qtquick-input-events - \brief 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: @@ -182,7 +182,7 @@ Item { \inqmlmodule QtQuick \ingroup qtquick-input-events - \brief Provides information about a mouse event + \brief Provides information about a mouse event. The position of the mouse can be found via the \l {Item::x} {x} and \l {Item::y} {y} properties. The button that caused the event is available via the \l button property. @@ -349,7 +349,7 @@ Item { \instantiates QQuickWheelEvent \inqmlmodule QtQuick \ingroup qtquick-input-events - \brief 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 {Item::x} {x} and \l {Item::y} {y} properties. @@ -474,7 +474,7 @@ Item { \inqmlmodule QtQuick \ingroup qtquick-input-events - \brief Provides information about a pointing device + \brief Provides information about a pointing device. A pointing device can be a mouse, a touchscreen, or a stylus on a graphics tablet. @@ -668,7 +668,7 @@ QQuickPointerDevice *QQuickPointerDevice::tabletDevice(qint64 id) \instantiates QQuickEventPoint \inqmlmodule QtQuick \ingroup qtquick-input-events - \brief Provides information about an individual point within a PointerEvent + \brief Provides information about an individual point within a PointerEvent. A PointerEvent contains an EventPoint for each point of contact: one corresponding to the mouse cursor, or one for each finger touching a touchscreen. @@ -1031,7 +1031,7 @@ void QQuickEventPoint::setAccepted(bool accepted) \instantiates QQuickEventTouchPoint \inqmlmodule QtQuick \ingroup qtquick-input-events - \brief Provides information about an individual touch point within a PointerEvent + \brief Provides information about an individual touch point within a PointerEvent. \sa PointerEvent, PointerHandler */ @@ -1186,7 +1186,7 @@ QVector2D QQuickEventPoint::estimatedVelocity() const \inqmlmodule QtQuick \ingroup qtquick-input-events - \brief Provides information about an event from a pointing device + \brief Provides information about an event from a pointing device. A PointerEvent is an event describing contact or movement across a surface, provided by a mouse, a touchpoint (single finger on a touchscreen), or a diff --git a/src/quick/items/qquickflickable.cpp b/src/quick/items/qquickflickable.cpp index d11f6ea720..d892e3b490 100644 --- a/src/quick/items/qquickflickable.cpp +++ b/src/quick/items/qquickflickable.cpp @@ -594,7 +594,7 @@ void QQuickFlickablePrivate::updateBeginningEnd() \ingroup qtquick-input \ingroup qtquick-containers - \brief Provides a surface that can be "flicked" + \brief Provides 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 fbba8eed89..a338985622 100644 --- a/src/quick/items/qquickflipable.cpp +++ b/src/quick/items/qquickflipable.cpp @@ -91,7 +91,7 @@ public: \inherits Item \ingroup qtquick-input \ingroup qtquick-containers - \brief Provides a surface that can be flipped + \brief Provides a surface that can be flipped. Flipable is an item that can be visibly "flipped" between its front and back sides, like a card. It may used together with \l Rotation, \l State diff --git a/src/quick/items/qquickfocusscope.cpp b/src/quick/items/qquickfocusscope.cpp index de4494a521..667d4d7b1d 100644 --- a/src/quick/items/qquickfocusscope.cpp +++ b/src/quick/items/qquickfocusscope.cpp @@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick \ingroup qtquick-input - \brief 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/qquickgraphicsinfo.cpp b/src/quick/items/qquickgraphicsinfo.cpp index e809bdd827..cd1012c690 100644 --- a/src/quick/items/qquickgraphicsinfo.cpp +++ b/src/quick/items/qquickgraphicsinfo.cpp @@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE \ingroup qtquick-visual \since 5.8 \since QtQuick 2.8 - \brief Provides information about the used Qt Quick backend + \brief Provides information about the used Qt Quick backend. The GraphicsInfo attached type provides information about the scenegraph backend used to render the contents of the associated window. diff --git a/src/quick/items/qquickgridview.cpp b/src/quick/items/qquickgridview.cpp index 1f5cda9d18..f2fa66332c 100644 --- a/src/quick/items/qquickgridview.cpp +++ b/src/quick/items/qquickgridview.cpp @@ -1114,7 +1114,7 @@ bool QQuickGridViewPrivate::flick(AxisData &data, qreal minExtent, qreal maxExte \ingroup qtquick-views \inherits Flickable - \brief For specifying 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 types 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 db5cfd2526..49e5b7b1fa 100644 --- a/src/quick/items/qquickimage.cpp +++ b/src/quick/items/qquickimage.cpp @@ -107,7 +107,7 @@ QQuickImagePrivate::QQuickImagePrivate() \inqmlmodule QtQuick \ingroup qtquick-visual \inherits Item - \brief Displays an image + \brief Displays an image. The Image type displays an image. diff --git a/src/quick/items/qquickitem.cpp b/src/quick/items/qquickitem.cpp index 70bb7db2b0..9be8b7f2b9 100644 --- a/src/quick/items/qquickitem.cpp +++ b/src/quick/items/qquickitem.cpp @@ -114,7 +114,7 @@ void debugFocusTree(QQuickItem *item, QQuickItem *scope = nullptr, int depth = 1 \instantiates QQuickTransform \inqmlmodule QtQuick \ingroup qtquick-visual-transforms - \brief For specifying advanced transformations on Items + \brief For specifying advanced transformations on Items. The Transform type is a base type which cannot be instantiated directly. The following concrete Transform types are available: @@ -357,7 +357,7 @@ void QQuickItemKeyFilter::componentComplete() \instantiates QQuickKeyNavigationAttached \inqmlmodule QtQuick \ingroup qtquick-input - \brief 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 @@ -816,7 +816,7 @@ bool QQuickKeysAttached::isConnected(const char *signalName) const \instantiates QQuickKeysAttached \inqmlmodule QtQuick \ingroup qtquick-input - \brief 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 @@ -1507,7 +1507,7 @@ QQuickKeysAttached *QQuickKeysAttached::qmlAttachedProperties(QObject *obj) \inqmlmodule QtQuick \ingroup qtquick-positioners \ingroup qml-utility-elements - \brief Property 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{Item Positioners}{positioner} types (such as \l Row and \l Grid) @@ -1924,7 +1924,7 @@ void QQuickItemPrivate::updateSubFocusItem(QQuickItem *scope, bool focus) \inherits QtObject \inqmlmodule QtQuick \ingroup qtquick-visual - \brief A basic visual QML type + \brief A basic visual QML type. The Item type is the base type for all visual items in Qt Quick. diff --git a/src/quick/items/qquickitemanimation.cpp b/src/quick/items/qquickitemanimation.cpp index e913e5ba05..8251282736 100644 --- a/src/quick/items/qquickitemanimation.cpp +++ b/src/quick/items/qquickitemanimation.cpp @@ -61,7 +61,7 @@ QT_BEGIN_NAMESPACE \ingroup qtquick-animation-properties \since 5.0 \inherits Animation - \brief 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 \ingroup qtquick-animation-properties \inherits Animation - \brief Animates changes in anchor values + \brief Animates changes in anchor values. AnchorAnimation is used to animate an anchor change. @@ -565,7 +565,7 @@ QAbstractAnimationJob* QQuickAnchorAnimation::transition(QQuickStateActions &act \ingroup qtquick-animation-properties \inherits Animation \since 5.0 - \brief 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 5cd28d0acb..c06dcce0d9 100644 --- a/src/quick/items/qquickitemviewtransition.cpp +++ b/src/quick/items/qquickitemviewtransition.cpp @@ -571,7 +571,7 @@ QQuickViewTransitionAttached::QQuickViewTransitionAttached(QObject *parent) \instantiates QQuickViewTransitionAttached \inqmlmodule QtQuick \ingroup qtquick-transitions-animations - \brief Specifies 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 60f7efae12..19033e03f1 100644 --- a/src/quick/items/qquicklistview.cpp +++ b/src/quick/items/qquicklistview.cpp @@ -1743,7 +1743,7 @@ bool QQuickListViewPrivate::flick(AxisData &data, qreal minExtent, qreal maxExte \inqmlmodule QtQuick \ingroup qtquick-views \inherits Flickable - \brief 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 types 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 cd48896e58..ea6a63559a 100644 --- a/src/quick/items/qquickloader.cpp +++ b/src/quick/items/qquickloader.cpp @@ -170,7 +170,7 @@ qreal QQuickLoaderPrivate::getImplicitHeight() const \ingroup qtquick-dynamic \inherits Item - \brief Allows dynamic loading of a subtree from a URL or Component + \brief Allows dynamic loading of a subtree from a URL or Component. Loader is used to dynamically load QML components. diff --git a/src/quick/items/qquickmousearea.cpp b/src/quick/items/qquickmousearea.cpp index c9316c0406..0b345697ec 100644 --- a/src/quick/items/qquickmousearea.cpp +++ b/src/quick/items/qquickmousearea.cpp @@ -196,7 +196,7 @@ bool QQuickMouseAreaPrivate::propagateHelper(QQuickMouseEvent *ev, QQuickItem *i \instantiates QQuickMouseArea \inqmlmodule QtQuick \ingroup qtquick-input - \brief 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 dc168073e4..b1438d7541 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) \instantiates QQuickTouchPoint \inqmlmodule QtQuick \ingroup qtquick-input-events - \brief Describes a touch point in a MultiPointTouchArea + \brief Describes a touch point in a MultiPointTouchArea. The TouchPoint type contains information about a touch point, such as the current position, pressure, and area. @@ -291,7 +291,7 @@ void QQuickTouchPoint::setUniqueId(const QPointingDeviceUniqueId &id) \instantiates QQuickGrabGestureEvent \inqmlmodule QtQuick \ingroup qtquick-input-events - \brief The parameter given with the gestureStarted signal + \brief The parameter given with the gestureStarted signal. The GestureEvent object has the current touch points, which you may choose to interpret as a gesture, and an invokable method to grab the involved @@ -328,7 +328,7 @@ void QQuickTouchPoint::setUniqueId(const QPointingDeviceUniqueId &id) \inqmlmodule QtQuick \inherits Item \ingroup qtquick-input - \brief Enables handling of multiple touch points + \brief Enables handling of multiple touch points. A MultiPointTouchArea is an invisible item that is used to track multiple touch points. diff --git a/src/quick/items/qquickopenglinfo.cpp b/src/quick/items/qquickopenglinfo.cpp index 73f9c85e94..3e634725f4 100644 --- a/src/quick/items/qquickopenglinfo.cpp +++ b/src/quick/items/qquickopenglinfo.cpp @@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick \ingroup qtquick-effects \since 5.4 - \brief Provides information about the used OpenGL version + \brief Provides information about the used OpenGL version. The OpenGLInfo attached type provides information about the OpenGL version being used to render the surface of the attachee item. diff --git a/src/quick/items/qquickpathview.cpp b/src/quick/items/qquickpathview.cpp index be94cdef42..74c8eaa169 100644 --- a/src/quick/items/qquickpathview.cpp +++ b/src/quick/items/qquickpathview.cpp @@ -475,7 +475,7 @@ void QQuickPathViewPrivate::setDragging(bool d) \ingroup qtquick-paths \ingroup qtquick-views \inherits Item - \brief Lays out model-provided items on a path + \brief Lays out model-provided items on a path. A PathView displays data from models created from built-in QML types like ListModel and XmlListModel, or custom model classes defined in C++ that inherit from diff --git a/src/quick/items/qquickpincharea.cpp b/src/quick/items/qquickpincharea.cpp index 7ae0f9b7e3..3d4f195380 100644 --- a/src/quick/items/qquickpincharea.cpp +++ b/src/quick/items/qquickpincharea.cpp @@ -58,7 +58,7 @@ QT_BEGIN_NAMESPACE \instantiates QQuickPinchEvent \inqmlmodule QtQuick \ingroup qtquick-input-events - \brief For specifying information about a pinch event + \brief For specifying information about a pinch event. \b {The PinchEvent type was added in QtQuick 1.1} @@ -169,7 +169,7 @@ QQuickPinchAreaPrivate::~QQuickPinchAreaPrivate() \inqmlmodule QtQuick \ingroup qtquick-input \inherits Item - \brief Enables simple pinch gesture handling + \brief Enables simple pinch gesture handling. \b {The PinchArea type was added in QtQuick 1.1} diff --git a/src/quick/items/qquickpositioners.cpp b/src/quick/items/qquickpositioners.cpp index 493db51666..55bafd9f83 100644 --- a/src/quick/items/qquickpositioners.cpp +++ b/src/quick/items/qquickpositioners.cpp @@ -705,7 +705,7 @@ void QQuickBasePositionerPrivate::setBottomPadding(qreal value, bool reset) \instantiates QQuickPositionerAttached \inqmlmodule QtQuick \ingroup qtquick-positioners - \brief 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. An object of type Positioner 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 @@ -789,7 +789,7 @@ void QQuickPositionerAttached::setIsLastItem(bool isLastItem) \inqmlmodule QtQuick \inherits Item \ingroup qtquick-positioners - \brief Positions its children in a column + \brief Positions its children in a column. Column is a type that positions its child items along a single column. It can be used as a convenient way to vertically position a series of items without @@ -993,7 +993,7 @@ void QQuickColumn::reportConflictingAnchors() \inqmlmodule QtQuick \inherits Item \ingroup qtquick-positioners - \brief Positions its children in a row + \brief Positions its children in a row. Row is a type that positions its child items along a single row. It can be used as a convenient way to horizontally position a series of items without @@ -1281,7 +1281,7 @@ void QQuickRow::reportConflictingAnchors() \inqmlmodule QtQuick \inherits Item \ingroup qtquick-positioners - \brief Positions its children in grid formation + \brief Positions its children in grid formation. Grid is a type that positions its child items in grid formation. @@ -1885,7 +1885,7 @@ void QQuickGrid::reportConflictingAnchors() \inqmlmodule QtQuick \inherits Item \ingroup qtquick-positioners - \brief Positions its children side by side, wrapping as necessary + \brief Positions its children side by side, wrapping as necessary. The Flow item positions its child items like words on a page, wrapping them to create rows or columns of items. diff --git a/src/quick/items/qquickrectangle.cpp b/src/quick/items/qquickrectangle.cpp index 3895f59ae1..bf030b9d80 100644 --- a/src/quick/items/qquickrectangle.cpp +++ b/src/quick/items/qquickrectangle.cpp @@ -132,7 +132,7 @@ bool QQuickPen::isValid() const \instantiates QQuickGradientStop \inqmlmodule QtQuick \ingroup qtquick-visual-utility - \brief Defines the color at a position in a Gradient + \brief Defines the color at a position in a Gradient. \sa Gradient */ @@ -184,7 +184,7 @@ void QQuickGradientStop::updateGradient() \instantiates QQuickGradient \inqmlmodule QtQuick \ingroup qtquick-visual-utility - \brief 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; \inqmlmodule QtQuick \inherits Item \ingroup qtquick-visual - \brief Paints a filled rectangle with an optional border + \brief Paints a filled rectangle with an optional border. Rectangle items are used to fill areas with solid color or gradients, and/or to provide a rectangular border. diff --git a/src/quick/items/qquickrepeater.cpp b/src/quick/items/qquickrepeater.cpp index b95fa3c410..805b6fe190 100644 --- a/src/quick/items/qquickrepeater.cpp +++ b/src/quick/items/qquickrepeater.cpp @@ -72,7 +72,7 @@ QQuickRepeaterPrivate::~QQuickRepeaterPrivate() \ingroup qtquick-models \ingroup qtquick-positioning \inherits Item - \brief Instantiates a number of Item-based components using a provided model + \brief Instantiates a number of Item-based components using a provided model. The Repeater type is used to create a large number of similar items. Like other view types, 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 592485d6fa..ab79b69c8c 100644 --- a/src/quick/items/qquickshadereffect.cpp +++ b/src/quick/items/qquickshadereffect.cpp @@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick \inherits Item \ingroup qtquick-effects - \brief Applies custom shaders to a rectangle + \brief Applies custom shaders to a rectangle. The ShaderEffect type applies a custom \l{vertexShader}{vertex} and \l{fragmentShader}{fragment (pixel)} shader to a diff --git a/src/quick/items/qquickshadereffectmesh.cpp b/src/quick/items/qquickshadereffectmesh.cpp index 4ea976a272..77b7cbc78d 100644 --- a/src/quick/items/qquickshadereffectmesh.cpp +++ b/src/quick/items/qquickshadereffectmesh.cpp @@ -70,7 +70,7 @@ QQuickShaderEffectMesh::QQuickShaderEffectMesh(QObject *parent) \inqmlmodule QtQuick \since 5.0 \ingroup qtquick-effects - \brief 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 4782672858..505940e673 100644 --- a/src/quick/items/qquickshadereffectsource.cpp +++ b/src/quick/items/qquickshadereffectsource.cpp @@ -102,7 +102,7 @@ public: \since 5.0 \inherits Item \ingroup qtquick-effects - \brief Renders a \l {Qt Quick} item into a texture and displays it + \brief Renders a \l {Qt Quick} item into a texture and displays it. The ShaderEffectSource type renders \l sourceItem into a texture and displays it in the scene. \l sourceItem is drawn into the texture as though diff --git a/src/quick/items/qquicksprite.cpp b/src/quick/items/qquicksprite.cpp index 8c59a68982..58f3de8b7b 100644 --- a/src/quick/items/qquicksprite.cpp +++ b/src/quick/items/qquicksprite.cpp @@ -50,7 +50,7 @@ QT_BEGIN_NAMESPACE \instantiates QQuickSprite \inqmlmodule QtQuick \ingroup qtquick-visual-utility - \brief Specifies sprite animations + \brief Specifies sprite animations. Sprite defines a series of one or more frames to be animated and rendered by SpriteSequence. 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 df6a6e336e..cff9b6ab02 100644 --- a/src/quick/items/qquickspritesequence.cpp +++ b/src/quick/items/qquickspritesequence.cpp @@ -61,7 +61,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick \ingroup qtquick-visual-utility \inherits Item - \brief Draws a sprite animation + \brief Draws a sprite animation. SpriteSequence renders and controls a list of animations defined by \l Sprite types. diff --git a/src/quick/items/qquickstateoperations.cpp b/src/quick/items/qquickstateoperations.cpp index a85b9663d3..fe1dfd349e 100644 --- a/src/quick/items/qquickstateoperations.cpp +++ b/src/quick/items/qquickstateoperations.cpp @@ -149,7 +149,7 @@ void QQuickParentChangePrivate::doChange(QQuickItem *targetParent, QQuickItem *s \instantiates QQuickParentChange \inqmlmodule QtQuick \ingroup qtquick-states - \brief Specifies how 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 @@ -555,7 +555,7 @@ void QQuickParentChange::rewind() \instantiates QQuickAnchorChanges \inqmlmodule QtQuick \ingroup qtquick-states - \brief Specifies how 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 type 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 9eaf9f8d6d..76720e5c5d 100644 --- a/src/quick/items/qquicktext.cpp +++ b/src/quick/items/qquicktext.cpp @@ -1236,7 +1236,7 @@ void QQuickTextPrivate::ensureDoc() \inqmlmodule QtQuick \ingroup qtquick-visual \inherits Item - \brief Specifies how to add formatted text to a scene + \brief Specifies how to add formatted text to a scene. Text items can display both plain and rich text. For example, red text with a specific font and size can be defined like this: diff --git a/src/quick/items/qquicktextdocument.cpp b/src/quick/items/qquicktextdocument.cpp index 5d2034defe..06ac5804c4 100644 --- a/src/quick/items/qquicktextdocument.cpp +++ b/src/quick/items/qquicktextdocument.cpp @@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE /*! \class QQuickTextDocument \since 5.1 - \brief The QQuickTextDocument class provides access to the QTextDocument of QQuickTextEdit + \brief The QQuickTextDocument class provides access to the QTextDocument of QQuickTextEdit. \inmodule QtQuick This class provides access to the QTextDocument of QQuickTextEdit elements. diff --git a/src/quick/items/qquicktextedit.cpp b/src/quick/items/qquicktextedit.cpp index 352fc48970..bfc9f4c769 100644 --- a/src/quick/items/qquicktextedit.cpp +++ b/src/quick/items/qquicktextedit.cpp @@ -73,7 +73,7 @@ QT_BEGIN_NAMESPACE \ingroup qtquick-visual \ingroup qtquick-input \inherits Item - \brief Displays multiple lines of editable formatted text + \brief Displays multiple lines of editable formatted text. 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 b19c13c5ee..a0ac884fef 100644 --- a/src/quick/items/qquicktextinput.cpp +++ b/src/quick/items/qquicktextinput.cpp @@ -75,7 +75,7 @@ DEFINE_BOOL_CONFIG_OPTION(qmlDisableDistanceField, QML_DISABLE_DISTANCEFIELD) \ingroup qtquick-visual \ingroup qtquick-input \inherits Item - \brief Displays an editable line of text + \brief Displays an editable line of text. The TextInput type displays a single line of editable plain text. diff --git a/src/quick/items/qquicktranslate.cpp b/src/quick/items/qquicktranslate.cpp index 1c8dd02b92..872fe25a18 100644 --- a/src/quick/items/qquicktranslate.cpp +++ b/src/quick/items/qquicktranslate.cpp @@ -58,7 +58,7 @@ public: \instantiates QQuickTranslate \inqmlmodule QtQuick \ingroup qtquick-visual-transforms - \brief 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 type provides independent control over position in addition to the Item's x and y properties. @@ -162,7 +162,7 @@ public: \instantiates QQuickScale \inqmlmodule QtQuick \ingroup qtquick-visual-transforms - \brief Provides a way to scale an Item + \brief Provides a way to scale an Item. The Scale type provides a way to scale an \l Item through a scale-type transform. @@ -304,7 +304,7 @@ public: \instantiates QQuickRotation \inqmlmodule QtQuick \ingroup qtquick-visual-transforms - \brief Provides a way to rotate an Item + \brief Provides a way to rotate an Item. The Rotation type provides a way to rotate an \l Item through a rotation-type transform. @@ -468,7 +468,7 @@ public: \inqmlmodule QtQuick \ingroup qtquick-visual-transforms \since 5.3 - \brief Provides a way to apply a 4x4 tranformation matrix to an \l Item + \brief Provides a way to apply a 4x4 tranformation matrix to an \l Item. The Matrix4x4 type provides a way to apply a transformation to an \l Item through a 4x4 matrix. diff --git a/src/quick/items/qquickwindow.cpp b/src/quick/items/qquickwindow.cpp index 535770e9f9..d9db8b56b4 100644 --- a/src/quick/items/qquickwindow.cpp +++ b/src/quick/items/qquickwindow.cpp @@ -1138,7 +1138,7 @@ void QQuickWindowPrivate::cleanup(QSGNode *n) \instantiates QQuickWindow \inqmlmodule QtQuick.Window \ingroup qtquick-visual - \brief Creates a new top-level window + \brief Creates a new top-level window. The Window object creates a new top-level window for a Qt Quick scene. It automatically sets up the window for use with \c {QtQuick 2.x} graphical types. @@ -1175,7 +1175,7 @@ void QQuickWindowPrivate::cleanup(QSGNode *n) \inmodule QtQuick - \brief The QQuickWindow class provides the window for displaying a graphical QML scene + \brief The QQuickWindow class provides the window for displaying a graphical QML scene. QQuickWindow provides the graphical scene management needed to interact with and display a scene of QQuickItems. @@ -3632,7 +3632,7 @@ bool QQuickWindow::isSceneGraphInitialized() const \instantiates QQuickCloseEvent \inqmlmodule QtQuick.Window \ingroup qtquick-visual - \brief Notification that a \l Window is about to be closed + \brief Notification that a \l Window is about to be closed. \since 5.1 Notification that a window is about to be closed by the windowing system diff --git a/src/quick/scenegraph/coreapi/qsggeometry.cpp b/src/quick/scenegraph/coreapi/qsggeometry.cpp index 226709094d..dd701fba5f 100644 --- a/src/quick/scenegraph/coreapi/qsggeometry.cpp +++ b/src/quick/scenegraph/coreapi/qsggeometry.cpp @@ -115,7 +115,7 @@ const QSGGeometry::AttributeSet &QSGGeometry::defaultAttributes_ColoredPoint2D() /*! \class QSGGeometry::Attribute - \brief The QSGGeometry::Attribute describes a single vertex attribute in a QSGGeometry + \brief The QSGGeometry::Attribute describes a single vertex attribute in a QSGGeometry. \inmodule QtQuick The QSGGeometry::Attribute struct describes the attribute register position, diff --git a/src/quick/scenegraph/coreapi/qsgnode.cpp b/src/quick/scenegraph/coreapi/qsgnode.cpp index 9717862baa..1976538aec 100644 --- a/src/quick/scenegraph/coreapi/qsgnode.cpp +++ b/src/quick/scenegraph/coreapi/qsgnode.cpp @@ -1144,7 +1144,7 @@ void QSGClipNode::setClipRect(const QRectF &rect) /*! \class QSGTransformNode - \brief The QSGTransformNode class implements transformations in the scene graph + \brief The QSGTransformNode class implements transformations in the scene graph. \inmodule QtQuick \ingroup qtquick-scenegraph-nodes diff --git a/src/quick/util/qquickanimation.cpp b/src/quick/util/qquickanimation.cpp index a89f237499..9ee1a323e5 100644 --- a/src/quick/util/qquickanimation.cpp +++ b/src/quick/util/qquickanimation.cpp @@ -74,7 +74,7 @@ QT_BEGIN_NAMESPACE \instantiates QQuickAbstractAnimation \inqmlmodule QtQuick \ingroup qtquick-transitions-animations - \brief Is the base of all QML animations + \brief Is the base of all QML animations. The Animation type cannot be used directly in a QML file. It exists to provide a set of common properties and methods, available across all the @@ -669,7 +669,7 @@ QQuickAbstractAnimation::ThreadingModel QQuickAbstractAnimation::threadingModel( \inqmlmodule QtQuick \ingroup qtquick-transitions-animations \inherits Animation - \brief 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. @@ -740,7 +740,7 @@ QAbstractAnimationJob* QQuickPauseAnimation::transition(QQuickStateActions &acti \inqmlmodule QtQuick \ingroup qtquick-animation-properties \inherits PropertyAnimation - \brief 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. @@ -898,7 +898,7 @@ void QActionAnimation::debugAnimation(QDebug d) const \inqmlmodule QtQuick \ingroup qtquick-transitions-animations \inherits Animation - \brief Defines 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. @@ -1041,7 +1041,7 @@ QAbstractAnimationJob* QQuickScriptAction::transition(QQuickStateActions &action \inqmlmodule QtQuick \ingroup qtquick-transitions-animations \inherits Animation - \brief Specifies 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. @@ -1302,7 +1302,7 @@ QAbstractAnimationJob* QQuickPropertyAction::transition(QQuickStateActions &acti \inqmlmodule QtQuick \ingroup qtquick-animation-properties \inherits PropertyAnimation - \brief 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. @@ -1415,7 +1415,7 @@ void QQuickNumberAnimation::setTo(qreal t) \inqmlmodule QtQuick \ingroup qtquick-animation-properties \inherits PropertyAnimation - \brief 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. @@ -1492,7 +1492,7 @@ void QQuickVector3dAnimation::setTo(QVector3D t) \inqmlmodule QtQuick \ingroup qtquick-animation-properties \inherits PropertyAnimation - \brief 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. @@ -1734,7 +1734,7 @@ QQmlListProperty<QQuickAbstractAnimation> QQuickAnimationGroup::animations() \inqmlmodule QtQuick \ingroup qtquick-transitions-animations \inherits Animation - \brief Allows animations to be run sequentially + \brief Allows animations to be run sequentially. The SequentialAnimation and ParallelAnimation types allow multiple animations to be run together. Animations defined in a SequentialAnimation @@ -1828,7 +1828,7 @@ QAbstractAnimationJob* QQuickSequentialAnimation::transition(QQuickStateActions \inqmlmodule QtQuick \ingroup qtquick-transitions-animations \inherits Animation - \brief Enables animations to be run in parallel + \brief Enables animations to be run in parallel. The SequentialAnimation and ParallelAnimation types allow multiple animations to be run together. Animations defined in a SequentialAnimation @@ -1991,7 +1991,7 @@ void QQuickBulkValueAnimator::debugAnimation(QDebug d) const \inqmlmodule QtQuick \ingroup qtquick-animation-properties \inherits Animation - \brief Animates changes in property values + \brief Animates changes in property values. PropertyAnimation provides a way to animate changes to a property's value. diff --git a/src/quick/util/qquickanimationcontroller.cpp b/src/quick/util/qquickanimationcontroller.cpp index 63373541a6..bfe96755c5 100644 --- a/src/quick/util/qquickanimationcontroller.cpp +++ b/src/quick/util/qquickanimationcontroller.cpp @@ -96,7 +96,7 @@ void QQuickAnimationControllerPrivate::animationCurrentTimeChanged(QAbstractAnim \instantiates QQuickAnimationController \inqmlmodule QtQuick \ingroup qtquick-animation-control - \brief Enables manual control of animations + \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. diff --git a/src/quick/util/qquickbehavior.cpp b/src/quick/util/qquickbehavior.cpp index 8a4ff6a779..d024c0099b 100644 --- a/src/quick/util/qquickbehavior.cpp +++ b/src/quick/util/qquickbehavior.cpp @@ -77,7 +77,7 @@ public: \inqmlmodule QtQuick \ingroup qtquick-transitions-animations \ingroup qtquick-interceptors - \brief Defines 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/qquickfontloader.cpp b/src/quick/util/qquickfontloader.cpp index 2da541304d..2de9768243 100644 --- a/src/quick/util/qquickfontloader.cpp +++ b/src/quick/util/qquickfontloader.cpp @@ -198,7 +198,7 @@ static void q_QFontLoaderFontsStaticReset() \instantiates QQuickFontLoader \inqmlmodule QtQuick \ingroup qtquick-text-utility - \brief Allows fonts to be loaded by name or URL + \brief Allows fonts to be loaded by name or URL. The FontLoader type is used to load fonts by name or URL. diff --git a/src/quick/util/qquickfontmetrics.cpp b/src/quick/util/qquickfontmetrics.cpp index 8c44150486..f1278c366f 100644 --- a/src/quick/util/qquickfontmetrics.cpp +++ b/src/quick/util/qquickfontmetrics.cpp @@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick \since 5.4 \ingroup qtquick-text-utility - \brief Provides metrics for a given font + \brief Provides metrics for a given font. FontMetrics calculates the size of characters and strings for a given font. diff --git a/src/quick/util/qquickpath.cpp b/src/quick/util/qquickpath.cpp index 56eafcd12a..53b72d1e58 100644 --- a/src/quick/util/qquickpath.cpp +++ b/src/quick/util/qquickpath.cpp @@ -55,7 +55,7 @@ QT_BEGIN_NAMESPACE \instantiates QQuickPathElement \inqmlmodule QtQuick \ingroup qtquick-animation-paths - \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. @@ -69,7 +69,7 @@ QT_BEGIN_NAMESPACE \instantiates QQuickPath \inqmlmodule QtQuick \ingroup qtquick-animation-paths - \brief Defines a path for use by \l PathView and \l Shape + \brief Defines a path for use by \l PathView and \l Shape. A Path is composed of one or more path segments - PathLine, PathQuad, PathCubic, PathArc, PathAngleArc, PathCurve, PathSvg. @@ -998,7 +998,7 @@ bool QQuickCurve::hasRelativeY() \instantiates QQuickPathAttribute \inqmlmodule QtQuick \ingroup qtquick-animation-paths - \brief Specifies how to set 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 @@ -1115,7 +1115,7 @@ void QQuickPathAttribute::setValue(qreal value) \instantiates QQuickPathLine \inqmlmodule QtQuick \ingroup qtquick-animation-paths - \brief 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: @@ -1174,7 +1174,7 @@ void QQuickPathLine::addToPath(QPainterPath &path, const QQuickPathData &data) \instantiates QQuickPathMove \inqmlmodule QtQuick \ingroup qtquick-animation-paths - \brief Moves the Path's position + \brief Moves the Path's position. The example below creates a path consisting of two horizontal lines with some empty space between them. All three segments have a width of 100: @@ -1232,7 +1232,7 @@ void QQuickPathMove::addToPath(QPainterPath &path, const QQuickPathData &data) \instantiates QQuickPathQuad \inqmlmodule QtQuick \ingroup qtquick-animation-paths - \brief 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 @@ -1384,7 +1384,7 @@ void QQuickPathQuad::addToPath(QPainterPath &path, const QQuickPathData &data) \instantiates QQuickPathCubic \inqmlmodule QtQuick \ingroup qtquick-animation-paths - \brief 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 @@ -1608,7 +1608,7 @@ void QQuickPathCubic::addToPath(QPainterPath &path, const QQuickPathData &data) \instantiates QQuickPathCatmullRomCurve \inqmlmodule QtQuick \ingroup qtquick-animation-paths - \brief 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: @@ -1754,7 +1754,7 @@ void QQuickPathCatmullRomCurve::addToPath(QPainterPath &path, const QQuickPathDa \instantiates QQuickPathArc \inqmlmodule QtQuick \ingroup qtquick-animation-paths - \brief 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. @@ -1965,7 +1965,7 @@ void QQuickPathArc::addToPath(QPainterPath &path, const QQuickPathData &data) \instantiates QQuickPathAngleArc \inqmlmodule QtQuick \ingroup qtquick-animation-paths - \brief Defines an arc with the given radii and center + \brief Defines an arc with the given radii and center. PathAngleArc provides a simple way of specifying an arc. While PathArc is designed to work as part of a larger path (specifying start and end), PathAngleArc is designed @@ -2138,7 +2138,7 @@ void QQuickPathAngleArc::addToPath(QPainterPath &path, const QQuickPathData &) \instantiates QQuickPathSvg \inqmlmodule QtQuick \ingroup qtquick-animation-paths - \brief 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 @@ -2197,7 +2197,7 @@ void QQuickPathSvg::addToPath(QPainterPath &path, const QQuickPathData &) \instantiates QQuickPathPercent \inqmlmodule QtQuick \ingroup qtquick-animation-paths - \brief 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 bb47ca0205..c27ca795e8 100644 --- a/src/quick/util/qquickpathinterpolator.cpp +++ b/src/quick/util/qquickpathinterpolator.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \instantiates QQuickPathInterpolator \inqmlmodule QtQuick \ingroup qtquick-animation-control - \brief Specifies how 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/qquickshortcut.cpp b/src/quick/util/qquickshortcut.cpp index 78dc855326..730a14369e 100644 --- a/src/quick/util/qquickshortcut.cpp +++ b/src/quick/util/qquickshortcut.cpp @@ -51,7 +51,7 @@ \inqmlmodule QtQuick \since 5.5 \ingroup qtquick-input - \brief Provides keyboard shortcuts + \brief Provides keyboard shortcuts. The Shortcut type provides a way of handling keyboard shortcuts. The shortcut can be set to one of the \l{QKeySequence::StandardKey}{standard keyboard shortcuts}, diff --git a/src/quick/util/qquicksmoothedanimation.cpp b/src/quick/util/qquicksmoothedanimation.cpp index 607f39768b..bae57172d1 100644 --- a/src/quick/util/qquicksmoothedanimation.cpp +++ b/src/quick/util/qquicksmoothedanimation.cpp @@ -324,7 +324,7 @@ void QSmoothedAnimation::debugAnimation(QDebug d) const \inqmlmodule QtQuick \ingroup qtquick-transitions-animations \inherits NumberAnimation - \brief 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 4389d941fd..9012d20f9a 100644 --- a/src/quick/util/qquickspringanimation.cpp +++ b/src/quick/util/qquickspringanimation.cpp @@ -352,7 +352,7 @@ void QQuickSpringAnimationPrivate::updateMode() \ingroup qtquick-transitions-animations \inherits NumberAnimation - \brief 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 be8300f531..b953ad1c7f 100644 --- a/src/quick/util/qquickstate.cpp +++ b/src/quick/util/qquickstate.cpp @@ -121,7 +121,7 @@ QQuickStateOperation::QQuickStateOperation(QObjectPrivate &dd, QObject *parent) \instantiates QQuickState \inqmlmodule QtQuick \ingroup qtquick-states - \brief 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 a70fa1a676..f971d7e551 100644 --- a/src/quick/util/qquickstatechangescript.cpp +++ b/src/quick/util/qquickstatechangescript.cpp @@ -69,7 +69,7 @@ public: \instantiates QQuickStateChangeScript \inqmlmodule QtQuick \ingroup qtquick-states - \brief Specifies how 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 1b99baed9a..c852c16509 100644 --- a/src/quick/util/qquickstategroup.cpp +++ b/src/quick/util/qquickstategroup.cpp @@ -94,7 +94,7 @@ public: \instantiates QQuickStateGroup \inqmlmodule QtQuick \ingroup qtquick-states - \brief Provides built-in state support for non-Item types + \brief Provides built-in state support for non-Item types. Item (and all derived types) 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 c5768a5d9f..413b87aa93 100644 --- a/src/quick/util/qquicksystempalette.cpp +++ b/src/quick/util/qquicksystempalette.cpp @@ -58,7 +58,7 @@ public: \instantiates QQuickSystemPalette \inqmlmodule QtQuick \ingroup qtquick-visual-utility - \brief Provides access to the Qt palettes + \brief Provides access to the Qt palettes. The SystemPalette type provides access to the Qt application palettes. This provides information about the standard colors used diff --git a/src/quick/util/qquicktextmetrics.cpp b/src/quick/util/qquicktextmetrics.cpp index 43945b0f5a..81088b5cd6 100644 --- a/src/quick/util/qquicktextmetrics.cpp +++ b/src/quick/util/qquicktextmetrics.cpp @@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick \since 5.4 \ingroup qtquick-text-utility - \brief Provides metrics for a given font and text + \brief Provides metrics for a given font and text. TextMetrics calculates various properties of a given string of text for a particular font. diff --git a/src/quick/util/qquicktransition.cpp b/src/quick/util/qquicktransition.cpp index fd6415dffb..c8699426f2 100644 --- a/src/quick/util/qquicktransition.cpp +++ b/src/quick/util/qquicktransition.cpp @@ -57,7 +57,7 @@ QT_BEGIN_NAMESPACE \instantiates QQuickTransition \inqmlmodule QtQuick \ingroup qtquick-transitions-animations - \brief 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. diff --git a/src/quick/util/qquickvalidator.cpp b/src/quick/util/qquickvalidator.cpp index c3ce149dcf..b2b773cd94 100644 --- a/src/quick/util/qquickvalidator.cpp +++ b/src/quick/util/qquickvalidator.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \instantiates QIntValidator \inqmlmodule QtQuick \ingroup qtquick-text-utility - \brief Defines a validator for integer values + \brief Defines a validator for integer values. The IntValidator type provides a validator for integer values. @@ -111,7 +111,7 @@ void QQuickIntValidator::resetLocaleName() \instantiates QDoubleValidator \inqmlmodule QtQuick \ingroup qtquick-text-utility - \brief Defines a validator for non-integer numbers + \brief Defines a validator for non-integer numbers. The DoubleValidator type provides a validator for non-integer numbers. @@ -205,7 +205,7 @@ void QQuickDoubleValidator::resetLocaleName() \instantiates QRegExpValidator \inqmlmodule QtQuick \ingroup qtquick-text-utility - \brief Provides a string validator + \brief Provides a string validator. The RegExpValidator type provides a validator, which counts as valid any string which matches a specified regular expression. |