Describe an example usage of stretch in QSizePolicy documentation.

Martin Pejcoch suggested QSizePolicy's setVerticalStretch and
setHorizontalStretch functions be better documented. This change
gives sample usages.

Task-number: QTBUG-18373
Change-Id: I54da8605f5e9e5f405c145b78865402baf78eee7
Reviewed-by: Martin Pejcoch <martin.pejcoch@nokia.com>
Reviewed-by: Geir Vattekar <geir.vattekar@nokia.com>

diff --git a/src/widgets/kernel/qsizepolicy.qdoc b/src/widgets/kernel/qsizepolicy.qdoc
index 3c7d1e8..0e08732 100644 (file)
--- a/src/widgets/kernel/qsizepolicy.qdoc
+++ b/src/widgets/kernel/qsizepolicy.qdoc
@@ -324,6 +324,11 @@
     Sets the horizontal stretch factor of the size policy to the given \a
     stretchFactor. \a stretchFactor must be in the range [0,255].
 
+    When two widgets are adjacent to each other in a horizontal layout,
+    setting the horizontal stretch factor of the widget on the left to 2
+    and the factor of widget on the right to 1 will ensure that the widget
+    on the left will always be twice the size of the one on the right.
+
     \sa horizontalStretch(), setVerticalStretch(), setHorizontalPolicy()
 */
 
@@ -333,6 +338,12 @@
     Sets the vertical stretch factor of the size policy to the given
     \a stretchFactor. \a stretchFactor must be in the range [0,255].
 
+    When two widgets are adjacent to each other in a vertical layout,
+    setting the vertical stretch factor of the widget on the top to 2
+    and the factor of widget on the bottom to 1 will ensure that
+    the widget on the top will always be twice the size of the one
+    on the bottom.
+
     \sa verticalStretch(), setHorizontalStretch(), setVerticalPolicy()
 */