diff libpurple/connection.h @ 20818:c560286daede

Clarify the documentation of the return value of purple_connection_reason_is_fatal, and explain why purple_connection_error checks wants_to_die.
author Will Thompson <will.thompson@collabora.co.uk>
date Wed, 10 Oct 2007 15:16:20 +0000
parents 66e7b104b4ea
children bc3c5daaf7aa
line wrap: on
line diff
--- a/libpurple/connection.h	Tue Oct 09 15:03:48 2007 +0000
+++ b/libpurple/connection.h	Wed Oct 10 15:16:20 2007 +0000
@@ -429,7 +429,8 @@
  *
  * (This function is meant to replace checking PurpleConnection.wants_to_die.)
  *
- * @return @c TRUE iff automatic reconnection is a bad idea.
+ * @return @c TRUE if the account should not be automatically reconnected, and
+ *         @c FALSE otherwise.
  */
 gboolean
 purple_connection_reason_is_fatal (PurpleDisconnectReason reason);