im.pidgin.cpw.resiak.disconnectreason: b2b01910aff8fbe45a897de87c978767f9f0a373

[resiak at soc.pidgin.im]

-----------------------------------------------------------------
Revision: b2b01910aff8fbe45a897de87c978767f9f0a373
Ancestor: 82343b928e1fb6c158e98f4ef6425d627dd2dfdc
Author: resiak at soc.pidgin.im
Date: 2007-10-11T12:26:06
Branch: im.pidgin.cpw.resiak.disconnectreason

Modified files:
        libpurple/connection.h

ChangeLog: 

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).

-------------- next part --------------
============================================================
--- libpurple/connection.h	94941da803533e1cb7325ac919d0ebed0d869cf9
+++ libpurple/connection.h	6deeed77d021a83d101a643b2d08105f7d038170
@@ -187,10 +187,12 @@ typedef struct
 	 */
 	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