summaryrefslogtreecommitdiffstats
path: root/src/corelib/io
diff options
context:
space:
mode:
authorKai Koehne <kai.koehne@qt.io>2017-04-20 11:00:46 +0200
committerKai Koehne <kai.koehne@qt.io>2017-07-18 13:30:22 +0000
commit3f18dadeeb36e8add4f82f6e6b63373e1bac5e27 (patch)
tree5c30601dc0f8cb2b31d8322f700b559bedf721b6 /src/corelib/io
parent54c2bfc9dbc445be94ba5031d96f93f497246744 (diff)
Doc: QLoggingCategory::setEnabled() should only be called in filter
Change-Id: Ib159c45ca259af125e48e3dfe59d64abc5f81f81 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
Diffstat (limited to 'src/corelib/io')
-rw-r--r--src/corelib/io/qloggingcategory.cpp11
1 files changed, 5 insertions, 6 deletions
diff --git a/src/corelib/io/qloggingcategory.cpp b/src/corelib/io/qloggingcategory.cpp
index 3eaf10c53e..4256d4b6e1 100644
--- a/src/corelib/io/qloggingcategory.cpp
+++ b/src/corelib/io/qloggingcategory.cpp
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2016 The Qt Company Ltd.
+** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtCore module of the Qt Toolkit.
@@ -334,12 +334,11 @@ bool QLoggingCategory::isEnabled(QtMsgType msgtype) const
/*!
Changes the message type \a type for the category to \a enable.
- \note Changes only affect the current QLoggingCategory object, and won't
- change the settings of other objects for the same category name.
- Use either \l setFilterRules() or \l installFilter() to change the
- configuration globally.
+ This method is meant to be used only from inside a filter
+ installed by \l installFilter(). See \l {Configuring Categories} for
+ an overview on how to configure categories globally.
- \note \c QtFatalMsg cannot be changed. It will always return \c true.
+ \note \c QtFatalMsg cannot be changed. It will always remain \c true.
*/
void QLoggingCategory::setEnabled(QtMsgType type, bool enable)
{