Document what QtTest's various loggers do

Provide basic (internal) documentation of each logging class and link
the command-line documentation to pages relevant to the formats not
defined by Qt.

Change-Id: I3251dd1304203c6ab87dfe1f2dec0e9787ab69f8
Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io>

1 files changed, 21 insertions, 1 deletions

diff --git a/src/testlib/qxmltestlogger.cpp b/src/testlib/qxmltestlogger.cpp
index 873e29bc2b..da87276f36 100644
--- a/src/testlib/qxmltestlogger.cpp
+++ b/src/testlib/qxmltestlogger.cpp
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2021 The Qt Company Ltd.
+** Copyright (C) 2022 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the QtTest module of the Qt Toolkit.
@@ -101,6 +101,26 @@ namespace QTest {
 
 }
 
+/*! \internal
+    \class QXmlTestLogger
+    \inmodule QtTest
+
+    QXmlTestLogger implements two XML formats specific to Qt.
+
+    The two formats are distinguished by the XmlMode enum.
+*/
+/*! \internal
+    \enum QXmlTestLogger::XmlMode
+
+    This enumerated type selects the type of XML output to produce.
+
+    \value Complete A full self-contained XML document
+    \value Light XML content suitable for embedding in an XML document
+
+    The Complete form wraps the Light form in a <TestCase> element whose name
+    attribute identifies the test class whose private slots are to be run. It
+    also includes the usual <?xml ...> preamble.
+*/
 
 QXmlTestLogger::QXmlTestLogger(XmlMode mode, const char *filename)
     : QAbstractTestLogger(filename), xmlmode(mode)