From cd483db1be2ef7cd5c768fa37c7f8333b04e84b1 Mon Sep 17 00:00:00 2001 From: Damian Jansen Date: Fri, 4 Nov 2011 15:32:58 +1000 Subject: [PATCH] Documentation fixes MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Change-Id: If30f98aafcedc5119e305dcb48b610a459780344 Reviewed-by: Thorbjørn Lund Martsum Reviewed-by: Glenn Watson --- src/declarative/items/qquickanimatedimage.cpp | 4 ++-- src/declarative/items/qquickborderimage.cpp | 2 +- src/declarative/items/qquickdrag.cpp | 4 ++-- src/declarative/items/qquickflickable.cpp | 4 ++-- src/declarative/items/qquickimage.cpp | 4 ++-- src/declarative/items/qquickitem.cpp | 4 ++-- src/declarative/items/qquicklistview.cpp | 2 +- src/declarative/items/qquickpincharea.cpp | 2 +- src/declarative/items/qquickpositioners.cpp | 6 +++--- src/declarative/items/qquickrectangle.cpp | 4 ++-- src/declarative/items/qquicktextedit.cpp | 2 +- src/declarative/items/qquicktextinput.cpp | 4 ++-- src/declarative/util/qdeclarativepath.cpp | 4 ++-- .../util/qdeclarativepropertychanges.cpp | 2 +- 14 files changed, 24 insertions(+), 24 deletions(-) diff --git a/src/declarative/items/qquickanimatedimage.cpp b/src/declarative/items/qquickanimatedimage.cpp index d4b08dd..3a11bb4 100644 --- a/src/declarative/items/qquickanimatedimage.cpp +++ b/src/declarative/items/qquickanimatedimage.cpp @@ -62,7 +62,7 @@ QT_BEGIN_NAMESPACE a way to play animations stored as images containing a series of frames, such as those stored in GIF files. - Information about the current frame and totla length of the animation can be + Information about the current frame and total length of the animation can be obtained using the \l currentFrame and \l frameCount properties. You can start, pause and stop the animation by changing the values of the \l playing and \l paused properties. @@ -110,7 +110,7 @@ QT_BEGIN_NAMESPACE Note that this property is only valid for images read from the local filesystem. Images loaded via a network resource (e.g. HTTP) - are always loaded asynchonously. + are always loaded asynchronously. */ /*! diff --git a/src/declarative/items/qquickborderimage.cpp b/src/declarative/items/qquickborderimage.cpp index 3f8e093..4e713c0 100644 --- a/src/declarative/items/qquickborderimage.cpp +++ b/src/declarative/items/qquickborderimage.cpp @@ -161,7 +161,7 @@ QT_BEGIN_NAMESPACE Note that this property is only valid for images read from the local filesystem. Images loaded via a network resource (e.g. HTTP) - are always loaded asynchonously. + are always loaded asynchronously. */ QQuickBorderImage::QQuickBorderImage(QQuickItem *parent) : QQuickImageBase(*(new QQuickBorderImagePrivate), parent) diff --git a/src/declarative/items/qquickdrag.cpp b/src/declarative/items/qquickdrag.cpp index d3439b0..9dcc4ac 100644 --- a/src/declarative/items/qquickdrag.cpp +++ b/src/declarative/items/qquickdrag.cpp @@ -105,7 +105,7 @@ public: \snippet doc/src/snippets/declarative/drag.qml 0 - A drag can be terminated either by cancelling it with Drag.cancel() or setting + A drag can be terminated either by canceling it with Drag.cancel() or setting Drag.active to false, or it can be terminated with a drop event by calling Drag.drop(). If the drop event is accepted Drag.drop() will return the \l {supportedActions}{drop action} chosen by the recipient of the event, @@ -217,7 +217,7 @@ void QQuickDragAttached::resetSource() When a drag is not active this property holds the object that accepted the drop event that ended the drag, if no object accepted the drop or - the drag was cancelled the target will then be null. + the drag was canceled the target will then be null. */ QObject *QQuickDragAttached::target() const diff --git a/src/declarative/items/qquickflickable.cpp b/src/declarative/items/qquickflickable.cpp index 6554720..0c24aa3 100644 --- a/src/declarative/items/qquickflickable.cpp +++ b/src/declarative/items/qquickflickable.cpp @@ -684,7 +684,7 @@ qreal QQuickFlickable::verticalVelocity() const \qmlproperty bool QtQuick2::Flickable::atYEnd These properties are true if the flickable view is positioned at the beginning, - or end respecively. + or end respectively. */ bool QQuickFlickable::isAtXEnd() const { @@ -1315,7 +1315,7 @@ QDeclarativeListProperty QQuickFlickable::flickableChildren() /*! \qmlproperty enumeration QtQuick2::Flickable::boundsBehavior This property holds whether the surface may be dragged - beyond the Fickable's boundaries, or overshoot the + beyond the Flickable's boundaries, or overshoot the Flickable's boundaries when flicked. This enables the feeling that the edges of the view are soft, diff --git a/src/declarative/items/qquickimage.cpp b/src/declarative/items/qquickimage.cpp index 11de584..5f706ac 100644 --- a/src/declarative/items/qquickimage.cpp +++ b/src/declarative/items/qquickimage.cpp @@ -404,7 +404,7 @@ qreal QQuickImage::paintedHeight() const other dimension is set in proportion to preserve the source image's aspect ratio. (The \l fillMode is independent of this.) - If the source is an instrinsically scalable image (eg. SVG), this property + If the source is an intrinsically scalable image (eg. SVG), this property determines the size of the loaded image regardless of intrinsic size. Avoid changing this property dynamically; rendering an SVG is \e slow compared to an image. @@ -442,7 +442,7 @@ qreal QQuickImage::paintedHeight() const Note that this property is only valid for images read from the local filesystem. Images loaded via a network resource (e.g. HTTP) - are always loaded asynchonously. + are always loaded asynchronously. */ /*! diff --git a/src/declarative/items/qquickitem.cpp b/src/declarative/items/qquickitem.cpp index f50a4f1..91e6831 100644 --- a/src/declarative/items/qquickitem.cpp +++ b/src/declarative/items/qquickitem.cpp @@ -4626,7 +4626,7 @@ void QQuickItem::setKeepTouchGrab(bool keep) Maps the point (\a x, \a y), which is in \a item's coordinate system, to this item's coordinate system, and returns an object with \c x and \c y - properties matching the mapped cooordinate. + properties matching the mapped coordinate. If \a item is a \c null value, this maps the point from the coordinate system of the root QML view. @@ -4636,7 +4636,7 @@ void QQuickItem::setKeepTouchGrab(bool keep) Maps the point (\a x, \a y), which is in this item's coordinate system, to \a item's coordinate system, and returns an object with \c x and \c y - properties matching the mapped cooordinate. + properties matching the mapped coordinate. If \a item is a \c null value, this maps \a x and \a y to the coordinate system of the root QML view. diff --git a/src/declarative/items/qquicklistview.cpp b/src/declarative/items/qquicklistview.cpp index 0b3460e..9dc9130 100644 --- a/src/declarative/items/qquicklistview.cpp +++ b/src/declarative/items/qquicklistview.cpp @@ -1673,7 +1673,7 @@ QQuickListView::~QQuickListView() The ListView will lay out the items based on the size of the root item in the delegate. - It is recommended that the delagate's size be a whole number to avoid sub-pixel + It is recommended that the delegate's size be a whole number to avoid sub-pixel alignment of items. \note Delegates are instantiated as needed and may be destroyed at any time. diff --git a/src/declarative/items/qquickpincharea.cpp b/src/declarative/items/qquickpincharea.cpp index c1f60ae..beacbe3 100644 --- a/src/declarative/items/qquickpincharea.cpp +++ b/src/declarative/items/qquickpincharea.cpp @@ -194,7 +194,7 @@ QQuickPinchAreaPrivate::~QQuickPinchAreaPrivate() including the scale, center and angle of the pinch. To ignore this gesture set the \c pinch.accepted property to false. The gesture - will be cancelled and no further events will be sent. + will be canceled and no further events will be sent. */ /*! diff --git a/src/declarative/items/qquickpositioners.cpp b/src/declarative/items/qquickpositioners.cpp index 15cd35c..8d20493 100644 --- a/src/declarative/items/qquickpositioners.cpp +++ b/src/declarative/items/qquickpositioners.cpp @@ -616,7 +616,7 @@ void QQuickColumn::reportConflictingAnchors() will not change. If you manually change the x or y properties in script, bind the x or y properties, use anchors on a child of a positioner, or have the width of a child depend on the position of a child, then the - positioner may exhibit strange behaviour. If you need to perform any of these + positioner may exhibit strange behavior. If you need to perform any of these actions, consider positioning the items without the use of a Row. Items with a width or height of 0 will not be positioned. @@ -851,7 +851,7 @@ void QQuickRow::reportConflictingAnchors() will not change. If you manually change the x or y properties in script, bind the x or y properties, use anchors on a child of a positioner, or have the width or height of a child depend on the position of a child, then the - positioner may exhibit strange behaviour. If you need to perform any of these + positioner may exhibit strange behavior. If you need to perform any of these actions, consider positioning the items without the use of a Grid. Items with a width or height of 0 will not be positioned. @@ -1282,7 +1282,7 @@ void QQuickGrid::reportConflictingAnchors() will not change. If you manually change the x or y properties in script, bind the x or y properties, use anchors on a child of a positioner, or have the width or height of a child depend on the position of a child, then the - positioner may exhibit strange behaviour. If you need to perform any of these + positioner may exhibit strange behavior. If you need to perform any of these actions, consider positioning the items without the use of a Flow. Items with a width or height of 0 will not be positioned. diff --git a/src/declarative/items/qquickrectangle.cpp b/src/declarative/items/qquickrectangle.cpp index a7f592e..a09202c 100644 --- a/src/declarative/items/qquickrectangle.cpp +++ b/src/declarative/items/qquickrectangle.cpp @@ -294,7 +294,7 @@ int QQuickRectanglePrivate::doUpdateSlotIdx = -1; the gradient is used. You can add an optional border to a rectangle with its own color and thickness - by settting the \l border.color and \l border.width properties. + by setting the \l border.color and \l border.width properties. You can also create rounded rectangles using the \l radius property. Since this introduces curved edges to the corners of a rectangle, it may be appropriate to @@ -542,7 +542,7 @@ QSGNode *QQuickRectangle::updatePaintNode(QSGNode *oldNode, UpdatePaintNodeData filtering at the beginning of the animation and reenable it at the conclusion. \image rect-smooth.png - On this image, smooth is turned off on the top half and on on the bottom half. + On this image, smooth is turned off for the top half and on for the bottom half. */ QRectF QQuickRectangle::boundingRect() const diff --git a/src/declarative/items/qquicktextedit.cpp b/src/declarative/items/qquicktextedit.cpp index 0c13c6d..6d66ed9 100644 --- a/src/declarative/items/qquicktextedit.cpp +++ b/src/declarative/items/qquicktextedit.cpp @@ -717,7 +717,7 @@ int QQuickTextEdit::positionAt(int x, int y) const \o TextEdit.SelectCharacters - Sets either the selectionStart or selectionEnd (whichever was at the previous cursor position) to the specified position. \o TextEdit.SelectWords - Sets the selectionStart and selectionEnd to include all - words between the specified postion and the previous cursor position. Words partially in the + words between the specified position and the previous cursor position. Words partially in the range are included. \endlist diff --git a/src/declarative/items/qquicktextinput.cpp b/src/declarative/items/qquicktextinput.cpp index 473dcd2..69f6994 100644 --- a/src/declarative/items/qquicktextinput.cpp +++ b/src/declarative/items/qquicktextinput.cpp @@ -871,7 +871,7 @@ void QQuickTextInputPrivate::updateInputMethodHints() Specifies how the text should be displayed in the TextInput. \list \o TextInput.Normal - Displays the text as it is. (Default) - \o TextInput.Password - Displays asterixes instead of characters. + \o TextInput.Password - Displays asterisks instead of characters. \o TextInput.NoEcho - Displays nothing. \o TextInput.PasswordEchoOnEdit - Displays characters as they are entered while editing, otherwise displays asterisks. @@ -1609,7 +1609,7 @@ void QQuickTextInput::moveCursorSelection(int position) \o TextEdit.SelectCharacters - Sets either the selectionStart or selectionEnd (whichever was at the previous cursor position) to the specified position. \o TextEdit.SelectWords - Sets the selectionStart and selectionEnd to include all - words between the specified postion and the previous cursor position. Words partially in the + words between the specified position and the previous cursor position. Words partially in the range are included. \endlist diff --git a/src/declarative/util/qdeclarativepath.cpp b/src/declarative/util/qdeclarativepath.cpp index 146fbf9..0b8349c 100644 --- a/src/declarative/util/qdeclarativepath.cpp +++ b/src/declarative/util/qdeclarativepath.cpp @@ -1396,7 +1396,7 @@ void QDeclarativePathSvg::addToPath(QPainterPath &path, const QDeclarativePathDa PathView's path. You can use it to bunch together items on part of the path, and spread them out on other parts of the path. - The examples below show the normal distrubution of items along a path + The examples below show the normal distribution of items along a path compared to a distribution which places 50% of the items along the PathLine section of the path. \table @@ -1438,7 +1438,7 @@ void QDeclarativePathSvg::addToPath(QPainterPath &path, const QDeclarativePathDa /*! \qmlproperty real QtQuick2::PathPercent::value - The proporation of items that should be laid out up to this point. + The proportion of items that should be laid out up to this point. This value should always be higher than the last value specified by a PathPercent at a previous position in the Path. diff --git a/src/declarative/util/qdeclarativepropertychanges.cpp b/src/declarative/util/qdeclarativepropertychanges.cpp index 818c163..0ad6019 100644 --- a/src/declarative/util/qdeclarativepropertychanges.cpp +++ b/src/declarative/util/qdeclarativepropertychanges.cpp @@ -108,7 +108,7 @@ QT_BEGIN_NAMESPACE \section2 Resetting property values The \c undefined value can be used to reset the property value for a state. - In the following example, when \c theText changes to the \e widerText + In the following example, when \c myText changes to the \e widerText state, its \c width property is reset, giving the text its natural width and displaying the whole string on a single line. -- 1.7.2.5