From 5165b89e2b88e773ae3deba0df9166a75b9ef017 Mon Sep 17 00:00:00 2001
From: Andreas Hartmetz <andreas@ixgreen.de>
Date: Wed, 27 Apr 2022 16:09:18 +0200
Subject: [PATCH] Document the default value of QSFPM::sortOrder()

...and how to change the value, which is by calling sort().
Also, this is not a property either.

Pick-to: 5.15 6.2 6.3
Change-Id: I1b1be90dc43c29e85903a33d0f99569fd6c87abb
Reviewed-by: David Faure <david.faure@kdab.com>
---
 src/corelib/itemmodels/qsortfilterproxymodel.cpp | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/src/corelib/itemmodels/qsortfilterproxymodel.cpp b/src/corelib/itemmodels/qsortfilterproxymodel.cpp
index adfcd892da..98e13aa319 100644
--- a/src/corelib/itemmodels/qsortfilterproxymodel.cpp
+++ b/src/corelib/itemmodels/qsortfilterproxymodel.cpp
@@ -2608,9 +2608,12 @@ int QSortFilterProxyModel::sortColumn() const
 
 /*!
     \since 4.5
-    \brief the order currently used for sorting
+    \return the order currently used for sorting
 
-    This returns the most recently used sort order.
+    This returns the most recently used sort order. The default value is
+    Qt::AscendingOrder.
+
+    \sa sort()
 */
 Qt::SortOrder QSortFilterProxyModel::sortOrder() const
 {