Document Flickable.pixelAligned.

Change-Id: I8ea85269c2666d18bf3c3815d2de0f90e9e0a3f4
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Gunnar Sletta <gunnar.sletta@digia.com>

diff --git a/src/quick/items/qquickflickable.cpp b/src/quick/items/qquickflickable.cpp
index 7913cbc..bfb0620 100644 (file)
--- a/src/quick/items/qquickflickable.cpp
+++ b/src/quick/items/qquickflickable.cpp
@@ -916,6 +916,18 @@ void QQuickFlickable::setFlickableDirection(FlickableDirection direction)
     }
 }
 
+/*!
+    \qmlproperty bool QtQuick2::Flickable::pixelAligned
+
+    This property sets the alignment of \l contentX and \l contentY to
+    pixels (\c true) or subpixels (\c false).
+
+    Enable pixelAligned to optimize for still content or moving content with
+    high constrast edges, such as one-pixel-wide lines, text or vector graphics.
+    Disable pixelAligned when optimizing for animation quality.
+
+    The default is \c false.
+*/
 bool QQuickFlickable::pixelAligned() const
 {
     Q_D(const QQuickFlickable);