From: Timo Sirainen <tss@iki.fi>
Date: Fri, 20 Feb 2009 20:27:03 +0000 (-0500)
Subject: mail-storage API: Added some function description comments.
X-Git-Tag: 1.2.beta2~80
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=7327394e30c1020b9a2a49c72a7e3d0f7803e680;p=thirdparty%2Fdovecot%2Fcore.git

mail-storage API: Added some function description comments.

--HG--
branch : HEAD
---

diff --git a/src/lib-storage/mail-namespace.h b/src/lib-storage/mail-namespace.h
index b4bc997dd3..1ccd59cb61 100644
--- a/src/lib-storage/mail-namespace.h
+++ b/src/lib-storage/mail-namespace.h
@@ -62,6 +62,8 @@ extern void (*hook_mail_namespaces_created)(struct mail_namespace *namespaces);
 
 int mail_namespaces_init(struct mail_user *user);
 struct mail_namespace *mail_namespaces_init_empty(struct mail_user *user);
+/* Deinitialize all namespaces. mail_user_deinit() calls this automatically
+   for user's namespaces. */
 void mail_namespaces_deinit(struct mail_namespace **namespaces);
 
 /* Destroy a single namespace and remove it from user's namespaces list. */
diff --git a/src/lib-storage/mail-search-build.h b/src/lib-storage/mail-search-build.h
index 575810ece3..03cdb8adef 100644
--- a/src/lib-storage/mail-search-build.h
+++ b/src/lib-storage/mail-search-build.h
@@ -6,14 +6,19 @@
 struct imap_arg;
 struct mailbox;
 
+/* Start building a new search query. Use mail_search_args_unref() to
+   free it. */
 struct mail_search_args *mail_search_build_init(void);
 
+/* Convert IMAP SEARCH command compatible parameters to mail_search_args. */
 int mail_search_build_from_imap_args(const struct imap_arg *imap_args,
 				     const char *charset,
 				     struct mail_search_args **args_r,
 				     const char **error_r);
 
+/* Add SEARCH_ALL to search args. */
 void mail_search_build_add_all(struct mail_search_args *args);
+/* Add a sequence set to search args. */
 void mail_search_build_add_seqset(struct mail_search_args *args,
 				  uint32_t seq1, uint32_t seq2);
 
diff --git a/src/lib-storage/mail-search.h b/src/lib-storage/mail-search.h
index f2a4f68d67..eef386a2ae 100644
--- a/src/lib-storage/mail-search.h
+++ b/src/lib-storage/mail-search.h
@@ -118,7 +118,8 @@ typedef void mail_search_foreach_callback_t(struct mail_search_arg *arg,
 void mail_search_args_init(struct mail_search_args *args,
 			   struct mailbox *box, bool change_uidsets,
 			   const ARRAY_TYPE(seq_range) *search_saved_uidset);
-/* Free keywords. The args can initialized afterwards again if needed. */
+/* Free keywords. The args can initialized afterwards again if needed.
+   The args can be reused for other queries after calling this. */
 void mail_search_args_deinit(struct mail_search_args *args);
 /* Convert sequence sets in args to UIDs. */
 void mail_search_args_seq2uid(struct mail_search_args *args);