Patch: TnyAccountStore::connection-finished documentation
- From: Murray Cumming <murrayc murrayc com>
- To: tinymail-devel-list <tinymail-devel-list gnome org>
- Subject: Patch: TnyAccountStore::connection-finished documentation
- Date: Tue, 22 May 2007 10:08:17 +0200
I plan to apply this little patch to clarify the documentation for the
new TnyAccountStore::connection-finished signal. If it's correct then it
shows that the use of the signals is a bit strange, but honesty is best.
--
Murray Cumming
murrayc murrayc com
www.murrayc.com
www.openismus.com
Index: ChangeLog
===================================================================
--- ChangeLog (revision 2032)
+++ ChangeLog (working copy)
@@ -1,3 +1,11 @@
+2007-05-22 Murray Cumming <murrayc murrayc com>
+
+ * libtinymail/tny-account-store.c: (tny_account_store_base_init):
+ * libtinymail/tny-device.c: (tny_device_base_init): connection-changed
+ signal: Document that applications should use the
+ TnyStoreAccount::connection-finished signal to detect all-accounts-online
+ status.
+
2007-05-22 Philip Van Hoof <pvanhoof gnome org>
* Shaped up the Unit tests
Index: libtinymail/tny-account-store.c
===================================================================
--- libtinymail/tny-account-store.c (revision 2032)
+++ libtinymail/tny-account-store.c (working copy)
@@ -448,7 +448,7 @@
* @self: the object on which the signal is emitted
* @user_data: user data set when the signal handler was connected.
*
- * Emitted when the store starts trying to connect the accounts
+ * Emitted when the store starts trying to connect the accounts.
*/
tny_account_store_signals[TNY_ACCOUNT_STORE_CONNECTING_STARTED] =
g_signal_new ("connecting_started",
@@ -465,7 +465,7 @@
* @self: the object on which the signal is emitted
* @user_data: user data set when the signal handler was connected.
*
- * Emitted when the store finished trying to connect the accounts
+ * Emitted when the store has finished trying to connect the accounts.
*/
tny_account_store_signals[TNY_ACCOUNT_STORE_CONNECTING_FINISHED] =
g_signal_new ("connecting_finished",
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.
*/
tny_device_signals[TNY_DEVICE_CONNECTION_CHANGED] =
g_signal_new ("connection_changed",
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]