Fix SortPolicy sorting key generation

Change-Id: Ib06d84088d93e00ffdcaa6baa9d34e03358943cb
Reviewed-by: Svenn-Arne Dragly <svenn-arne.dragly@qt.io>
Reviewed-by: Andy Nichols <andy.nichols@qt.io>

1 files changed, 13 insertions, 3 deletions

diff --git a/src/render/framegraph/qsortpolicy.cpp b/src/render/framegraph/qsortpolicy.cpp
index b1e0f4956..e5a6e096c 100644
--- a/src/render/framegraph/qsortpolicy.cpp
+++ b/src/render/framegraph/qsortpolicy.cpp
@@ -88,10 +88,20 @@ QSortPolicyPrivate::QSortPolicyPrivate()
 /*!
     \enum QSortPolicy::SortType
 
-    This enum type describes sort types that can be employed
-    \value StateChangeCost sort the objects so as to minimize the cost of changing from the currently rendered state
-    \value BackToFront sort the objects from back to front inverted z order
+    This enum type describes the available sort types.
+
+    \value StateChangeCost sort the objects so as to minimize the cost of
+    changing from the currently rendered state
+
+    \value BackToFront sort the objects from back to front based on inverted z
+    order. More accurately, the sorting key is the z component of the
+    projection of the camera-to-object-center vector onto the camera's view
+    vector.
+
     \value Material sort the objects based on their material value
+
+    \value FrontToBack sort the objects from front to back. The opposite of
+    BackToFront.
 */
 
 /*!