diff doc/account-signals.dox @ 21379:30a532b14003

Document exactly how long the PurpleConnectionErrorInfo pointers given out by account-error-changed and purple_account_get_current_error() are valid.
author Will Thompson <will.thompson@collabora.co.uk>
date Tue, 30 Oct 2007 21:38:14 +0000
parents 872068d10eab
children 554cb1447d06
line wrap: on
line diff
--- a/doc/account-signals.dox	Sun Oct 28 23:18:09 2007 +0000
+++ b/doc/account-signals.dox	Tue Oct 30 21:38:14 2007 +0000
@@ -150,8 +150,12 @@
    Emitted when @a account's error changes.
   @param account   The account whose error has changed.
   @param old_error The account's previous error, or @c NULL if it had no
-                   error.
+                   error.  After this signal is emitted, @a old_error is
+                   not guaranteed to be a valid pointer.
   @param new_error The account's new error, or @c NULL if it has no error.
+                   If not @c NULL, @a new_error will remain a valid until
+                   pointer just after the next time this signal is emitted
+                   for this @a account.
   @see purple_account_get_current_error()
   @since 2.3.0
  @endsignaldef