QHeaderView - documentation update. Prefer hideSection over 0-resize.

There is a different behavior on 0 sections and hidden sections
e.g with scrollbars. Normally people want to use hideSection.

Change-Id: Id99de30ea46906bb4ef7720ed12d4ac9615c9743
Reviewed-by: Stephen Kelly <stephen.kelly@kdab.com>

diff --git a/src/widgets/itemviews/qheaderview.cpp b/src/widgets/itemviews/qheaderview.cpp
index 766d7ce..425eb4c 100644 (file)
--- a/src/widgets/itemviews/qheaderview.cpp
+++ b/src/widgets/itemviews/qheaderview.cpp
@@ -866,9 +866,11 @@ void QHeaderView::swapSections(int first, int second)
     \fn void QHeaderView::resizeSection(int logicalIndex, int size)
 
     Resizes the section specified by \a logicalIndex to \a size measured in
-    pixels.
+    pixels. The size parameter must be a value larger or equal to zero. A
+    size equal to zero is however not recommended. In that situation hideSection
+    should be used instead.
 
-    \sa sectionResized(), resizeMode(), sectionSize()
+    \sa sectionResized(), resizeMode(), sectionSize(), hideSection()
 */
 
 void QHeaderView::resizeSection(int logical, int size)