Re: Patch: TnyAccountStore::connection-finished documentation

[Philip Van Hoof <spam pvanhoof be>]

On Tue, 2007-05-22 at 10:08 +0200, Murray Cumming wrote:
> Index: libtinymail/tny-device.c
> ===================================================================
> --- libtinymail/tny-device.c    (revision 2032)
> +++ libtinymail/tny-device.c    (working copy)
> @@ -191,6 +191,11 @@
>   * This signal will not be emitted in response to actual connection
> changes 
>   * while the status is forced with tny_device_force_online() or 
>   * tny_device_force_offline().
> + * 
> + * Applications should handle the
> TnyAccountStore::connecting-finished 
> + * signal instead of this signal, to detect when the device is online
> and 
> + * the accounts are ready to perform operations. But this signal may
> be used 
> + * to detect when the device has gone offline.
>   */


No, it should read something like this:

Applications can use the TnyAccountStore::connection-finished signal to
detect when trying to connect has finished. They can use this signal to
detecting when the device has gone online or offline.
 
Applications can also use the TnyAccount::connection_status_changed
signal to detect connectivity status changes on accounts.


-> There is no should-not use it about TnyDevice::connection-changed, as
they are definitely allowed to use the signal (for whatever reason).


-- 
Philip Van Hoof, software developer
home: me at pvanhoof dot be 
gnome: pvanhoof at gnome dot org 
http://www.pvanhoof.be/blog