summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndreas Hartmetz <andreas@ixgreen.de>2019-02-05 14:39:41 +0100
committerAndreas Hartmetz <ahartmetz@gmail.com>2019-02-06 10:35:03 +0000
commitddb5d390450de25e510c72b17ed8124b9186a736 (patch)
treeba5e29770e957ca2b283af2b03106b558ec954c8
parent150c6fb74bb7bc702d1d319a1e9acba6b644944b (diff)
QMetaObject::Connection overview documentation improvements
Try to better describe what it is and what it does. Also mention its strongest use case. Change-Id: Ib5c3e8a3c9b96169c139c5d7e8995a6a49d7d5e1 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Olivier Goffart (Woboq GmbH) <ogoffart@woboq.com>
-rw-r--r--src/corelib/kernel/qobject.cpp11
1 files changed, 7 insertions, 4 deletions
diff --git a/src/corelib/kernel/qobject.cpp b/src/corelib/kernel/qobject.cpp
index 42c39f18e3..b4e885e407 100644
--- a/src/corelib/kernel/qobject.cpp
+++ b/src/corelib/kernel/qobject.cpp
@@ -5070,11 +5070,14 @@ bool QObjectPrivate::disconnect(const QObject *sender, int signal_index, void **
/*! \class QMetaObject::Connection
\inmodule QtCore
- Represents a handle to a signal-slot connection.
- It can be used to disconnect that connection, or check if
- the connection was successful
+ Represents a handle to a signal-slot (or signal-functor) connection.
- \sa QObject::disconnect()
+ It can be used to check if the connection is valid and to disconnect it using
+ QObject::disconnect(). For a signal-functor connection without a context object,
+ it is the only way to selectively disconnect that connection.
+
+ As Connection is just a handle, the underlying signal-slot connection is unaffected
+ when Connection is destroyed or reassigned.
*/
/*!