Patch: documentation tny_folder_store_refresh_async()



Hello,

  Attached some documentation for tny_folder_store_refresh_async()
introduced by Rob some time ago.

Cheers,

-- 
Martin
Index: ChangeLog
===================================================================
--- ChangeLog	(révision 3822)
+++ ChangeLog	(copie de travail)
@@ -1,5 +1,9 @@
 2008-11-21  Martin Bonnin  <martinbonnin gmail com>
  
+	Add some documentation tny_folder_store_refresh_async()
+
+2008-11-21  Martin Bonnin  <martinbonnin gmail com>
+ 
 	Add some documentation about the behaviour of tny_folder_refresh_async()
 
 2008-11-21  Martin Bonnin  <martinbonnin gmail com>
Index: libtinymail/tny-folder-store.c
===================================================================
--- libtinymail/tny-folder-store.c	(révision 3822)
+++ libtinymail/tny-folder-store.c	(copie de travail)
@@ -410,6 +410,21 @@
 }
 
 
+/**
+ * tny_folder_store_refresh_async:
+ * @self: a #TnyFolderStore
+ * @callback: (null-ok): a #TnyFolderStoreCallback or NULL
+ * @status_callback: (null-ok): a #TnyStatusCallback or NULL
+ * @user_data: (null-ok): user data that will be passed to the callbacks
+ *
+ * Refresh @self and callback when finished. 
+ *
+ * While the refresh takes place, it's possible that event observers of @self
+ * will get notified of new folders.
+ *
+ * since: 1.0
+ * audience: application-developer
+ **/
 void tny_folder_store_refresh_async (TnyFolderStore *self, TnyFolderStoreCallback callback, TnyStatusCallback status_callback, gpointer user_data)
 {
 #ifdef DBC /* require */


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]