From 80a0119012db15b2664716463338db706c6a8085 Mon Sep 17 00:00:00 2001
From: Paul Wicking <paul.wicking@qt.io>
Date: Mon, 11 Jan 2021 13:35:33 +0100
Subject: [PATCH] Doc: Add details to QFont::toString

Add details that explain the return value.

Fixes: QTBUG-81467
Change-Id: Ifad407a27259711fc9abe1bacc7ba9db105bdcc0
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
(cherry picked from commit 8c395a20eddc15ae923b7658f275fa87c8d33db9)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
---
 src/gui/text/qfont.cpp | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/src/gui/text/qfont.cpp b/src/gui/text/qfont.cpp
index 63b13df38ba..8603ae38648 100644
--- a/src/gui/text/qfont.cpp
+++ b/src/gui/text/qfont.cpp
@@ -2073,7 +2073,26 @@ QString QFont::key() const
 /*!
     Returns a description of the font. The description is a
     comma-separated list of the attributes, perfectly suited for use
-    in QSettings.
+    in QSettings, and consists of the following:
+
+    \list
+      \li Font family
+      \li Point size
+      \li Pixel size
+      \li Style hint
+      \li Font weight
+      \li Font style
+      \li Underline
+      \li Strike out
+      \li Fixed pitch
+      \li Always \e{0}
+      \li Capitalization
+      \li Letter spacing
+      \li Word spacing
+      \li Stretch
+      \li Style strategy
+      \li Font style (omitted when unavailable)
+    \endlist
 
     \sa fromString()
  */