Mercurial > pidgin.yaz

diff libpurple/connection.h @ 21376:f5b223d0cb89

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
line wrap: on
line diff
--- a/libpurple/connection.h	Sun Oct 28 16:43:16 2007 +0000
+++ b/libpurple/connection.h	Sun Oct 28 18:03:14 2007 +0000
@@ -424,8 +424,10 @@
 /**
  * Closes a connection with an error and a human-readable description of the
  * error.  It also sets @c gc->wants_to_die to the value of
- * #purple_connection_error_is_fatal(@a reason).
+ * #purple_connection_error_is_fatal(@a reason), mainly for
+ * backwards-compatibility.
  *
+ * @param gc          the connection which is closing.
  * @param reason      why the connection is closing.
  * @param description a non-@c NULL localized description of the error.
  * @since 2.3.0