dovecot-2.2: lib-storage: Comment updates to mailbox_list_iter_*()

[dovecot at dovecot.org]

details:   http://hg.dovecot.org/dovecot-2.2/rev/e6d8d7e56828
changeset: 18174:e6d8d7e56828
user:      Timo Sirainen <tss at iki.fi>
date:      Mon Jan 19 22:12:58 2015 +0200
description:
lib-storage: Comment updates to mailbox_list_iter_*()

diffstat:

 src/lib-storage/mailbox-list-iter.h |  6 ++++--
 1 files changed, 4 insertions(+), 2 deletions(-)

diffs (23 lines):

diff -r 322afa8ca547 -r e6d8d7e56828 src/lib-storage/mailbox-list-iter.h
--- a/src/lib-storage/mailbox-list-iter.h	Mon Jan 19 22:11:29 2015 +0200
+++ b/src/lib-storage/mailbox-list-iter.h	Mon Jan 19 22:12:58 2015 +0200
@@ -65,7 +65,8 @@
 				const char *const *patterns,
 				enum mailbox_list_iter_flags flags);
 /* List mailbox_list_iter_init_multiple(), but list mailboxes from all the
-   specified namespaces. */
+   specified namespaces. If it fails, the error message is set to the first
+   namespaces->list. */
 struct mailbox_list_iterate_context *
 mailbox_list_iter_init_namespaces(struct mail_namespace *namespaces,
 				  const char *const *patterns,
@@ -75,7 +76,8 @@
 const struct mailbox_info *
 mailbox_list_iter_next(struct mailbox_list_iterate_context *ctx);
 /* Deinitialize mailbox list request. Returns -1 if some error
-   occurred while listing. */
+   occurred while listing. The error string can be looked up with
+   mailbox_list_get_last_error(). */
 int mailbox_list_iter_deinit(struct mailbox_list_iterate_context **ctx);
 /* List one mailbox. Returns 1 if info returned, 0 if mailbox doesn't exist,
    -1 if error. */