Mercurial > pidgin.yaz
comparison libpurple/connection.h @ 21376:f5b223d0cb89
Document the gc parameter of purple_connection_error_reason to shut doxygen up.
author | Will Thompson <will.thompson@collabora.co.uk> |
---|---|
date | Sun, 28 Oct 2007 18:03:14 +0000 |
parents | 71c1f2da4ff2 |
children | 872068d10eab |
comparison
equal
deleted
inserted
replaced
21375:50fa2c5a7029 | 21376:f5b223d0cb89 |
---|---|
422 void purple_connection_error(PurpleConnection *gc, const char *reason); | 422 void purple_connection_error(PurpleConnection *gc, const char *reason); |
423 | 423 |
424 /** | 424 /** |
425 * Closes a connection with an error and a human-readable description of the | 425 * Closes a connection with an error and a human-readable description of the |
426 * error. It also sets @c gc->wants_to_die to the value of | 426 * error. It also sets @c gc->wants_to_die to the value of |
427 * #purple_connection_error_is_fatal(@a reason). | 427 * #purple_connection_error_is_fatal(@a reason), mainly for |
428 * | 428 * backwards-compatibility. |
429 * | |
430 * @param gc the connection which is closing. | |
429 * @param reason why the connection is closing. | 431 * @param reason why the connection is closing. |
430 * @param description a non-@c NULL localized description of the error. | 432 * @param description a non-@c NULL localized description of the error. |
431 * @since 2.3.0 | 433 * @since 2.3.0 |
432 */ | 434 */ |
433 void | 435 void |