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, 10 insertions, 1 deletions

diff --git a/src/testlib/qplaintestlogger.cpp b/src/testlib/qplaintestlogger.cpp
index d5296eae79..4e38a2edce 100644
--- a/src/testlib/qplaintestlogger.cpp
+++ b/src/testlib/qplaintestlogger.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.
@@ -213,6 +213,15 @@ namespace QTest {
     }
 }
 
+/*! \internal
+    \class QPlainTestLogger
+    \inmodule QtTest
+
+    QPlainTestLogger implements basic logging of test results.
+
+    The format is Qt-specific and aims to be be easy to read.
+*/
+
 void QPlainTestLogger::outputMessage(const char *str)
 {
 #if defined(Q_OS_WIN)