summaryrefslogtreecommitdiffstats
path: root/src/testlib/qappletestlogger.cpp
diff options
context:
space:
mode:
authorEdward Welbourne <edward.welbourne@qt.io>2022-03-09 17:07:26 +0100
committerEdward Welbourne <edward.welbourne@qt.io>2022-03-22 17:43:13 +0100
commit0e5c39ee13be8c218c16f4d83066a44e2e662184 (patch)
tree5cb88b48f66d63dba289fc7b0183e90147b060e9 /src/testlib/qappletestlogger.cpp
parent401349af26521d303f422eaf7bbccfc638f6db91 (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ø <tor.arne.vestbo@qt.io>
Diffstat (limited to 'src/testlib/qappletestlogger.cpp')
-rw-r--r--src/testlib/qappletestlogger.cpp10
1 files changed, 9 insertions, 1 deletions
diff --git a/src/testlib/qappletestlogger.cpp b/src/testlib/qappletestlogger.cpp
index 8764e84aed..4de0045af5 100644
--- a/src/testlib/qappletestlogger.cpp
+++ b/src/testlib/qappletestlogger.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.
@@ -47,6 +47,14 @@ QT_BEGIN_NAMESPACE
using namespace QTestPrivate;
+/*! \internal
+ \class QAppleTestLogger
+ \inmodule QtTest
+
+ QAppleTestLogger reports test results through Apple's unified system logging.
+ Results can be viewed in the Console app.
+*/
+
bool QAppleTestLogger::debugLoggingEnabled()
{
// Debug-level messages are only captured in memory when debug logging is