doc: Added an explanatory \note about the table being sorted.

Task-number: QTBUG-5046

1 files changed, 12 insertions, 2 deletions

diff --git a/src/gui/itemviews/qtableview.cpp b/src/gui/itemviews/qtableview.cpp
index d27e693caf..26f5a20d01 100644
--- a/src/gui/itemviews/qtableview.cpp
+++ b/src/gui/itemviews/qtableview.cpp
@@ -2359,12 +2359,22 @@ void QTableView::setColumnHidden(int column, bool hide)
     \property QTableView::sortingEnabled
     \brief whether sorting is enabled
 
-    If this property is true, sorting is enabled for the table; if the
-    property is false, sorting is not enabled. The default value is false.
+    If this property is true, sorting is enabled for the table.  If
+    this property is false, sorting is not enabled. The default value
+    is false.
+
+    \note. Setting the property to true with setSortingEnabled()
+    immediately triggers a call to sortByColumn() with the current
+    sort section and order.
 
     \sa sortByColumn()
 */
 
+/*!
+  If \a enabled true enables sorting for the table and immediately
+  trigger a call to sortByColumn() with the current sort section and
+  order
+ */
 void QTableView::setSortingEnabled(bool enable)
 {
     Q_D(QTableView);