Mercurial > pidgin.yaz
changeset 20820:bc3c5daaf7aa
Update report_disconnect_reason documentation to match reality. Also include
a note about implementing both report_disconnect_reason and report_disconnect
(mainly that there's no point).
| author | Will Thompson <will.thompson@collabora.co.uk> |
|---|---|
| date | Thu, 11 Oct 2007 12:26:06 +0000 |
| parents | 6d8708b99de1 |
| children | beaa1d9b5c1b |
| files | libpurple/connection.h |
| diffstat | 1 files changed, 5 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/libpurple/connection.h Wed Oct 10 15:35:01 2007 +0000 +++ b/libpurple/connection.h Thu Oct 11 12:26:06 2007 +0000 @@ -187,10 +187,12 @@ */ void (*network_disconnected)(); - /** Called when a connection is disconnected, whether due to an - * error or to user request. Called before #disconnected. + /** Called when an error causes a connection to be disconnected. + * Called before #disconnected. This op is intended to replace + * #report_disconnect. If both are implemented, this will be called + * first; however, there's no real reason to implement both. * @param reason why the connection ended, if known, or - * PURPLE_REASON_OTHER_ERROR, if not. + * #PURPLE_REASON_OTHER_ERROR, if not. * @param text a localized message describing the disconnection * in more detail to the user. * @see #purple_connection_error_reason