diff options
author | Edward Welbourne <[email protected]> | 2022-03-09 17:07:26 +0100 |
---|---|---|
committer | Edward Welbourne <[email protected]> | 2022-03-22 17:43:13 +0100 |
commit | 0e5c39ee13be8c218c16f4d83066a44e2e662184 (patch) | |
tree | 5cb88b48f66d63dba289fc7b0183e90147b060e9 /src/testlib/qjunittestlogger.cpp | |
parent | 401349af26521d303f422eaf7bbccfc638f6db91 (diff) |
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ø <[email protected]>
Diffstat (limited to 'src/testlib/qjunittestlogger.cpp')
-rw-r--r-- | src/testlib/qjunittestlogger.cpp | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/src/testlib/qjunittestlogger.cpp b/src/testlib/qjunittestlogger.cpp index cea7fa8b14a..c185e652c9f 100644 --- a/src/testlib/qjunittestlogger.cpp +++ b/src/testlib/qjunittestlogger.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. @@ -57,6 +57,16 @@ #include <string.h> QT_BEGIN_NAMESPACE +/*! \internal + \class QJUnitTestLogger + \inmodule QtTest + + QJUnitTestLogger implements logging in a JUnit-compatible XML format. + + The \l{JUnit XML} format was originally developed for Java testing. + It is supported by \l{Squish Test Center}. +*/ +// QTBUG-95424 links to further useful documentation. QJUnitTestLogger::QJUnitTestLogger(const char *filename) : QAbstractTestLogger(filename) |