* mu-store-xapian: add _foreach func, document all public functions

src/mu-store-xapian.h

@@ -31,19 +31,72 @@ G_BEGIN_DECLS
 struct _MuStoreXapian;
 typedef struct _MuStoreXapian MuStoreXapian;
 
+
+/** 
+ * create a new Xapian store, a place to store documents
+ * 
+ * @param path the path to the database
+ * 
+ * @return a new MuStoreXapian object, or NULL in case of error
+ */
 MuStoreXapian*    mu_store_xapian_new     (const char* path);
 
+/** 
+ * destroy the MuStoreXapian object and free resources
+ * 
+ * @param store a valid store, or NULL
+ */
 void              mu_store_xapian_destroy (MuStoreXapian *store);
+
+
+/** 
+ * store an email message in the XapianStore
+ * 
+ * @param store a valid store
+ * @param msg a valid message
+ * 
+ * @return TRUE if it succeeded, FALSE otherwise
+ */
 MuResult	  mu_store_xapian_store   (MuStoreXapian *store,
 					   MuMsgGMime *msg);
-MuResult          mu_store_xapian_cleanup (MuStoreXapian *store, 
-					   const char* msgpath);
 
+/** 
+ * store a timestamp for a directory
+ * 
+ * @param store a valid store
+ * @param msgpath path to a maildir
+ * @param stamp a timestamp
+ */
 void              mu_store_xapian_set_timestamp (MuStoreXapian *store,
-						   const char* msgpath, 
-						   time_t stamp);
+						 const char* msgpath, 
+						 time_t stamp);
+
+/** 
+ * get the timestamp for a directory
+ * 
+ * @param store a valid store
+ * @param msgpath path to a maildir
+ * 
+ * @return the timestamp, or 0 in case of error
+ */
 time_t            mu_store_xapian_get_timestamp (MuStoreXapian *store,
-						   const char* msgpath);
+						 const char* msgpath);
+
+/** 
+ * call a function for each document in the database
+ * 
+ * @param self a valid store
+ * @param func a callback function to to call for each document
+ * @param user_data a user pointer passed to the callback function
+ * 
+ * @return MU_OK if all went well, MU_STOP if the foreach was interrupted,
+ * MU_ERROR in case of error
+ */
+typedef MuResult (*MuStoreXapianForeachFunc) (const char* path,
+					      void *user_data);
+MuResult         mu_store_xapian_foreach (MuStoreXapian *self,
+					  MuStoreXapianForeachFunc func,
+					  void *user_data);
 
 G_END_DECLS