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>
This commit is contained in:
Andreas Hartmetz 2019-02-05 14:39:41 +01:00 committed by Andreas Hartmetz
parent 150c6fb74b
commit ddb5d39045

View File

@ -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.
*/
/*!