From: Samuel Rødal <samuel.rodal@nokia.com>
Date: Thu, 30 Aug 2012 10:43:45 +0000 (+0200)
Subject: Improved the QBackingStore documentation.
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=8fe1d9fb136786986fa2f9e23e4212dba5647836;p=profile%2Fivi%2Fqtbase.git

Improved the QBackingStore documentation.

Added links to the example and added some explanation of when
QBackingStore might be useful.

Change-Id: Iee19c4fdfc5c27ac9b559c9df428d83d302f3928
Reviewed-by: Paul Olav Tvete <paul.tvete@nokia.com>
---

diff --git a/src/gui/painting/qbackingstore.cpp b/src/gui/painting/qbackingstore.cpp
index 88be97b..ff181ba 100644
--- a/src/gui/painting/qbackingstore.cpp
+++ b/src/gui/painting/qbackingstore.cpp
@@ -70,7 +70,20 @@ public:
     \since 5.0
     \inmodule QtGui
 
-    \brief The QBackingStore class provides the drawing area for top-level windows.
+    \brief The QBackingStore class provides a drawing area for QWindow.
+
+    QBackingStore enables the use of QPainter to paint on a QWindow with type
+    RasterSurface. The other way of rendering to a QWindow is through the use
+    of OpenGL with QOpenGLContext.
+
+    A QBackingStore contains a buffered representation of the window contents,
+    and thus supports partial updates by using QPainter to only update a sub
+    region of the window contents.
+
+    QBackingStore might be used by an application that wants to use QPainter
+    without OpenGL acceleration and without the extra overhead of using the
+    QWidget or QGraphicsView UI stacks. For an example of how to use
+    QBackingStore see the \l{gui/rasterwindow}{Raster Window} example.
 */
 
 /*!