comparison 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
comparison
equal deleted inserted replaced
20817:38d7c849d444 20818:c560286daede
427 * purple_connection_reason_is_fatal(PURPLE_REASON_AUTHENTICATION_FAILED) 427 * purple_connection_reason_is_fatal(PURPLE_REASON_AUTHENTICATION_FAILED)
428 * is @c TRUE. 428 * is @c TRUE.
429 * 429 *
430 * (This function is meant to replace checking PurpleConnection.wants_to_die.) 430 * (This function is meant to replace checking PurpleConnection.wants_to_die.)
431 * 431 *
432 * @return @c TRUE iff automatic reconnection is a bad idea. 432 * @return @c TRUE if the account should not be automatically reconnected, and
433 * @c FALSE otherwise.
433 */ 434 */
434 gboolean 435 gboolean
435 purple_connection_reason_is_fatal (PurpleDisconnectReason reason); 436 purple_connection_reason_is_fatal (PurpleDisconnectReason reason);
436 437
437 /*@}*/ 438 /*@}*/